Package-level declarations

Types

Link copied to clipboard
class Api : KotlinCustomResource

Manages an API within an API Management Service.

Link copied to clipboard
data class ApiArgs(val apiManagementName: Output<String>? = null, val apiType: Output<String>? = null, val contact: Output<ApiContactArgs>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val import: Output<ApiImportArgs>? = null, val license: Output<ApiLicenseArgs>? = null, val name: Output<String>? = null, val oauth2Authorization: Output<ApiOauth2AuthorizationArgs>? = null, val openidAuthentication: Output<ApiOpenidAuthenticationArgs>? = null, val path: Output<String>? = null, val protocols: Output<List<String>>? = null, val resourceGroupName: Output<String>? = null, val revision: Output<String>? = null, val revisionDescription: Output<String>? = null, val serviceUrl: Output<String>? = null, val sourceApiId: Output<String>? = null, val subscriptionKeyParameterNames: Output<ApiSubscriptionKeyParameterNamesArgs>? = null, val subscriptionRequired: Output<Boolean>? = null, val termsOfServiceUrl: Output<String>? = null, val version: Output<String>? = null, val versionDescription: Output<String>? = null, val versionSetId: Output<String>? = null) : ConvertibleToJava<ApiArgs>

Manages an API within an API Management Service.

Link copied to clipboard

Builder for ApiArgs.

Link copied to clipboard
class ApiDiagnostic : KotlinCustomResource

Manages a API Management Service API Diagnostics Logs.

Link copied to clipboard
data class ApiDiagnosticArgs(val alwaysLogErrors: Output<Boolean>? = null, val apiManagementLoggerId: Output<String>? = null, val apiManagementName: Output<String>? = null, val apiName: Output<String>? = null, val backendRequest: Output<ApiDiagnosticBackendRequestArgs>? = null, val backendResponse: Output<ApiDiagnosticBackendResponseArgs>? = null, val frontendRequest: Output<ApiDiagnosticFrontendRequestArgs>? = null, val frontendResponse: Output<ApiDiagnosticFrontendResponseArgs>? = null, val httpCorrelationProtocol: Output<String>? = null, val identifier: Output<String>? = null, val logClientIp: Output<Boolean>? = null, val operationNameFormat: Output<String>? = null, val resourceGroupName: Output<String>? = null, val samplingPercentage: Output<Double>? = null, val verbosity: Output<String>? = null) : ConvertibleToJava<ApiDiagnosticArgs>

Manages a API Management Service API Diagnostics Logs.

Link copied to clipboard
Link copied to clipboard
object ApiDiagnosticMapper : ResourceMapper<ApiDiagnostic>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
object ApiMapper : ResourceMapper<Api>
Link copied to clipboard
class ApiOperation : KotlinCustomResource

Manages an API Operation within an API Management Service.

Link copied to clipboard
data class ApiOperationArgs(val apiManagementName: Output<String>? = null, val apiName: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val method: Output<String>? = null, val operationId: Output<String>? = null, val request: Output<ApiOperationRequestArgs>? = null, val resourceGroupName: Output<String>? = null, val responses: Output<List<ApiOperationResponseArgs>>? = null, val templateParameters: Output<List<ApiOperationTemplateParameterArgs>>? = null, val urlTemplate: Output<String>? = null) : ConvertibleToJava<ApiOperationArgs>

Manages an API Operation within an API Management Service.

Link copied to clipboard
Link copied to clipboard
object ApiOperationMapper : ResourceMapper<ApiOperation>
Link copied to clipboard
class ApiOperationPolicy : KotlinCustomResource

Manages an API Management API Operation Policy

Link copied to clipboard
data class ApiOperationPolicyArgs(val apiManagementName: Output<String>? = null, val apiName: Output<String>? = null, val operationId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val xmlContent: Output<String>? = null, val xmlLink: Output<String>? = null) : ConvertibleToJava<ApiOperationPolicyArgs>

Manages an API Management API Operation Policy

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ApiOperationTag : KotlinCustomResource

Manages a API Management API Operation Tag.

Link copied to clipboard
data class ApiOperationTagArgs(val apiOperationId: Output<String>? = null, val displayName: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<ApiOperationTagArgs>

Manages a API Management API Operation Tag.

Link copied to clipboard
object ApiOperationTagMapper : ResourceMapper<ApiOperationTag>
Link copied to clipboard
class ApiPolicy : KotlinCustomResource

Manages an API Management API Policy

Link copied to clipboard
data class ApiPolicyArgs(val apiManagementName: Output<String>? = null, val apiName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val xmlContent: Output<String>? = null, val xmlLink: Output<String>? = null) : ConvertibleToJava<ApiPolicyArgs>

Manages an API Management API Policy

Link copied to clipboard
Link copied to clipboard
object ApiPolicyMapper : ResourceMapper<ApiPolicy>
Link copied to clipboard
Link copied to clipboard
class ApiRelease : KotlinCustomResource

Manages a API Management API Release.

Link copied to clipboard
data class ApiReleaseArgs(val apiId: Output<String>? = null, val name: Output<String>? = null, val notes: Output<String>? = null) : ConvertibleToJava<ApiReleaseArgs>

Manages a API Management API Release.

Link copied to clipboard
Link copied to clipboard
object ApiReleaseMapper : ResourceMapper<ApiRelease>
Link copied to clipboard
Link copied to clipboard

Builder for Api.

Link copied to clipboard
class ApiSchema : KotlinCustomResource

Manages an API Schema within an API Management Service.

Link copied to clipboard
data class ApiSchemaArgs(val apiManagementName: Output<String>? = null, val apiName: Output<String>? = null, val components: Output<String>? = null, val contentType: Output<String>? = null, val definitions: Output<String>? = null, val resourceGroupName: Output<String>? = null, val schemaId: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<ApiSchemaArgs>

Manages an API Schema within an API Management Service.

Link copied to clipboard
Link copied to clipboard
object ApiSchemaMapper : ResourceMapper<ApiSchema>
Link copied to clipboard
Link copied to clipboard
class ApiTag : KotlinCustomResource

Manages the Assignment of an API Management API Tag to an API.

Link copied to clipboard
data class ApiTagArgs(val apiId: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<ApiTagArgs>

Manages the Assignment of an API Management API Tag to an API.

Link copied to clipboard

Builder for ApiTagArgs.

Link copied to clipboard
class ApiTagDescription : KotlinCustomResource

Manages an API Tag Description within an API Management Service.

Link copied to clipboard
data class ApiTagDescriptionArgs(val apiTagId: Output<String>? = null, val description: Output<String>? = null, val externalDocumentationDescription: Output<String>? = null, val externalDocumentationUrl: Output<String>? = null) : ConvertibleToJava<ApiTagDescriptionArgs>

Manages an API Tag Description within an API Management Service.

Link copied to clipboard
object ApiTagDescriptionMapper : ResourceMapper<ApiTagDescription>
Link copied to clipboard
object ApiTagMapper : ResourceMapper<ApiTag>
Link copied to clipboard

Builder for ApiTag.

Link copied to clipboard
class ApiVersionSet : KotlinCustomResource

Manages an API Version Set within an API Management Service.

Link copied to clipboard
data class ApiVersionSetArgs(val apiManagementName: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val versionHeaderName: Output<String>? = null, val versionQueryName: Output<String>? = null, val versioningScheme: Output<String>? = null) : ConvertibleToJava<ApiVersionSetArgs>

Manages an API Version Set within an API Management Service.

Link copied to clipboard
Link copied to clipboard
object ApiVersionSetMapper : ResourceMapper<ApiVersionSet>
Link copied to clipboard
Link copied to clipboard
class AuthorizationServer : KotlinCustomResource

Manages an Authorization Server within an API Management Service.

Link copied to clipboard
data class AuthorizationServerArgs(val apiManagementName: Output<String>? = null, val authorizationEndpoint: Output<String>? = null, val authorizationMethods: Output<List<String>>? = null, val bearerTokenSendingMethods: Output<List<String>>? = null, val clientAuthenticationMethods: Output<List<String>>? = null, val clientId: Output<String>? = null, val clientRegistrationEndpoint: Output<String>? = null, val clientSecret: Output<String>? = null, val defaultScope: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val grantTypes: Output<List<String>>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val resourceOwnerPassword: Output<String>? = null, val resourceOwnerUsername: Output<String>? = null, val supportState: Output<Boolean>? = null, val tokenBodyParameters: Output<List<AuthorizationServerTokenBodyParameterArgs>>? = null, val tokenEndpoint: Output<String>? = null) : ConvertibleToJava<AuthorizationServerArgs>

Manages an Authorization Server within an API Management Service.

Link copied to clipboard
Link copied to clipboard
class Backend : KotlinCustomResource

Manages a backend within an API Management Service.

Link copied to clipboard
data class BackendArgs(val apiManagementName: Output<String>? = null, val credentials: Output<BackendCredentialsArgs>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val protocol: Output<String>? = null, val proxy: Output<BackendProxyArgs>? = null, val resourceGroupName: Output<String>? = null, val resourceId: Output<String>? = null, val serviceFabricCluster: Output<BackendServiceFabricClusterArgs>? = null, val title: Output<String>? = null, val tls: Output<BackendTlsArgs>? = null, val url: Output<String>? = null) : ConvertibleToJava<BackendArgs>

Manages a backend within an API Management Service.

Link copied to clipboard
Link copied to clipboard
object BackendMapper : ResourceMapper<Backend>
Link copied to clipboard
Link copied to clipboard
class Certificate : KotlinCustomResource

Manages an Certificate within an API Management Service.

Link copied to clipboard
data class CertificateArgs(val apiManagementName: Output<String>? = null, val data: Output<String>? = null, val keyVaultIdentityClientId: Output<String>? = null, val keyVaultSecretId: Output<String>? = null, val name: Output<String>? = null, val password: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<CertificateArgs>

Manages an Certificate within an API Management Service.

Link copied to clipboard
Link copied to clipboard
object CertificateMapper : ResourceMapper<Certificate>
Link copied to clipboard
Link copied to clipboard
class CustomDomain : KotlinCustomResource

Manages a API Management Custom Domain.

Link copied to clipboard
data class CustomDomainArgs(val apiManagementId: Output<String>? = null, val developerPortals: Output<List<CustomDomainDeveloperPortalArgs>>? = null, val gateways: Output<List<CustomDomainGatewayArgs>>? = null, val managements: Output<List<CustomDomainManagementArgs>>? = null, val portals: Output<List<CustomDomainPortalArgs>>? = null, val scms: Output<List<CustomDomainScmArgs>>? = null) : ConvertibleToJava<CustomDomainArgs>

Manages a API Management Custom Domain.

Link copied to clipboard
Link copied to clipboard
object CustomDomainMapper : ResourceMapper<CustomDomain>
Link copied to clipboard
Link copied to clipboard
class Diagnostic : KotlinCustomResource

Manages an API Management Service Diagnostic.

Link copied to clipboard
data class DiagnosticArgs(val alwaysLogErrors: Output<Boolean>? = null, val apiManagementLoggerId: Output<String>? = null, val apiManagementName: Output<String>? = null, val backendRequest: Output<DiagnosticBackendRequestArgs>? = null, val backendResponse: Output<DiagnosticBackendResponseArgs>? = null, val frontendRequest: Output<DiagnosticFrontendRequestArgs>? = null, val frontendResponse: Output<DiagnosticFrontendResponseArgs>? = null, val httpCorrelationProtocol: Output<String>? = null, val identifier: Output<String>? = null, val logClientIp: Output<Boolean>? = null, val operationNameFormat: Output<String>? = null, val resourceGroupName: Output<String>? = null, val samplingPercentage: Output<Double>? = null, val verbosity: Output<String>? = null) : ConvertibleToJava<DiagnosticArgs>

Manages an API Management Service Diagnostic.

Link copied to clipboard
Link copied to clipboard
object DiagnosticMapper : ResourceMapper<Diagnostic>
Link copied to clipboard
Link copied to clipboard
class EmailTemplate : KotlinCustomResource

Manages a API Management Email Template.

Link copied to clipboard
data class EmailTemplateArgs(val apiManagementName: Output<String>? = null, val body: Output<String>? = null, val resourceGroupName: Output<String>? = null, val subject: Output<String>? = null, val templateName: Output<String>? = null) : ConvertibleToJava<EmailTemplateArgs>

Manages a API Management Email Template.

Link copied to clipboard
Link copied to clipboard
object EmailTemplateMapper : ResourceMapper<EmailTemplate>
Link copied to clipboard
Link copied to clipboard
class Gateway : KotlinCustomResource

Manages an API Management Gateway.

Link copied to clipboard
class GatewayApi : KotlinCustomResource

Manages a API Management Gateway API.

Link copied to clipboard
data class GatewayApiArgs(val apiId: Output<String>? = null, val gatewayId: Output<String>? = null) : ConvertibleToJava<GatewayApiArgs>

Manages a API Management Gateway API.

Link copied to clipboard
Link copied to clipboard
object GatewayApiMapper : ResourceMapper<GatewayApi>
Link copied to clipboard
Link copied to clipboard
data class GatewayArgs(val apiManagementId: Output<String>? = null, val description: Output<String>? = null, val locationData: Output<GatewayLocationDataArgs>? = null, val name: Output<String>? = null) : ConvertibleToJava<GatewayArgs>

Manages an API Management Gateway.

Link copied to clipboard
Link copied to clipboard
class GatewayCertificateAuthority : KotlinCustomResource

Manages an API Management Gateway Certificate Authority.

Link copied to clipboard
data class GatewayCertificateAuthorityArgs(val apiManagementId: Output<String>? = null, val certificateName: Output<String>? = null, val gatewayName: Output<String>? = null, val isTrusted: Output<Boolean>? = null) : ConvertibleToJava<GatewayCertificateAuthorityArgs>

Manages an API Management Gateway Certificate Authority.

Link copied to clipboard
class GatewayHostNameConfiguration : KotlinCustomResource

Manages an API Management Gateway Host Name Configuration.

Link copied to clipboard
data class GatewayHostNameConfigurationArgs(val apiManagementId: Output<String>? = null, val certificateId: Output<String>? = null, val gatewayName: Output<String>? = null, val hostName: Output<String>? = null, val http2Enabled: Output<Boolean>? = null, val name: Output<String>? = null, val requestClientCertificateEnabled: Output<Boolean>? = null, val tls10Enabled: Output<Boolean>? = null, val tls11Enabled: Output<Boolean>? = null) : ConvertibleToJava<GatewayHostNameConfigurationArgs>

Manages an API Management Gateway Host Name Configuration.

Link copied to clipboard
object GatewayMapper : ResourceMapper<Gateway>
Link copied to clipboard
Link copied to clipboard
class GlobalSchema : KotlinCustomResource

Manages a Global Schema within an API Management Service.

Link copied to clipboard
data class GlobalSchemaArgs(val apiManagementName: Output<String>? = null, val description: Output<String>? = null, val resourceGroupName: Output<String>? = null, val schemaId: Output<String>? = null, val type: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<GlobalSchemaArgs>

Manages a Global Schema within an API Management Service.

Link copied to clipboard
Link copied to clipboard
object GlobalSchemaMapper : ResourceMapper<GlobalSchema>
Link copied to clipboard
Link copied to clipboard
class Group : KotlinCustomResource

Manages an API Management Group.

Link copied to clipboard
data class GroupArgs(val apiManagementName: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val externalId: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<GroupArgs>

Manages an API Management Group.

Link copied to clipboard

Builder for GroupArgs.

Link copied to clipboard
object GroupMapper : ResourceMapper<Group>
Link copied to clipboard

Builder for Group.

Link copied to clipboard
class GroupUser : KotlinCustomResource

Manages an API Management User Assignment to a Group.

Link copied to clipboard
data class GroupUserArgs(val apiManagementName: Output<String>? = null, val groupName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val userId: Output<String>? = null) : ConvertibleToJava<GroupUserArgs>

Manages an API Management User Assignment to a Group.

Link copied to clipboard
Link copied to clipboard
object GroupUserMapper : ResourceMapper<GroupUser>
Link copied to clipboard
Link copied to clipboard
class IdentityProviderAad : KotlinCustomResource

Manages an API Management AAD Identity Provider.

Link copied to clipboard
data class IdentityProviderAadArgs(val allowedTenants: Output<List<String>>? = null, val apiManagementName: Output<String>? = null, val clientId: Output<String>? = null, val clientLibrary: Output<String>? = null, val clientSecret: Output<String>? = null, val resourceGroupName: Output<String>? = null, val signinTenant: Output<String>? = null) : ConvertibleToJava<IdentityProviderAadArgs>

Manages an API Management AAD Identity Provider.

Link copied to clipboard
class IdentityProviderAadb2c : KotlinCustomResource

Manages an API Management Azure AD B2C Identity Provider.

Link copied to clipboard
data class IdentityProviderAadb2cArgs(val allowedTenant: Output<String>? = null, val apiManagementName: Output<String>? = null, val authority: Output<String>? = null, val clientId: Output<String>? = null, val clientLibrary: Output<String>? = null, val clientSecret: Output<String>? = null, val passwordResetPolicy: Output<String>? = null, val profileEditingPolicy: Output<String>? = null, val resourceGroupName: Output<String>? = null, val signinPolicy: Output<String>? = null, val signinTenant: Output<String>? = null, val signupPolicy: Output<String>? = null) : ConvertibleToJava<IdentityProviderAadb2cArgs>

Manages an API Management Azure AD B2C Identity Provider.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class IdentityProviderFacebook : KotlinCustomResource

Manages an API Management Facebook Identity Provider.

Link copied to clipboard
data class IdentityProviderFacebookArgs(val apiManagementName: Output<String>? = null, val appId: Output<String>? = null, val appSecret: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<IdentityProviderFacebookArgs>

Manages an API Management Facebook Identity Provider.

Link copied to clipboard
class IdentityProviderGoogle : KotlinCustomResource

Manages an API Management Google Identity Provider.

Link copied to clipboard
data class IdentityProviderGoogleArgs(val apiManagementName: Output<String>? = null, val clientId: Output<String>? = null, val clientSecret: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<IdentityProviderGoogleArgs>

Manages an API Management Google Identity Provider.

Link copied to clipboard
Link copied to clipboard
class IdentityProviderMicrosoft : KotlinCustomResource

Manages an API Management Microsoft Identity Provider.

Link copied to clipboard
data class IdentityProviderMicrosoftArgs(val apiManagementName: Output<String>? = null, val clientId: Output<String>? = null, val clientSecret: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<IdentityProviderMicrosoftArgs>

Manages an API Management Microsoft Identity Provider.

Link copied to clipboard
class IdentityProviderTwitter : KotlinCustomResource

Manages an API Management Twitter Identity Provider.

Link copied to clipboard
data class IdentityProviderTwitterArgs(val apiKey: Output<String>? = null, val apiManagementName: Output<String>? = null, val apiSecretKey: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<IdentityProviderTwitterArgs>

Manages an API Management Twitter Identity Provider.

Link copied to clipboard
Link copied to clipboard
class Logger : KotlinCustomResource

Manages a Logger within an API Management Service.

Link copied to clipboard
data class LoggerArgs(val apiManagementName: Output<String>? = null, val applicationInsights: Output<LoggerApplicationInsightsArgs>? = null, val buffered: Output<Boolean>? = null, val description: Output<String>? = null, val eventhub: Output<LoggerEventhubArgs>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val resourceId: Output<String>? = null) : ConvertibleToJava<LoggerArgs>

Manages a Logger within an API Management Service.

Link copied to clipboard

Builder for LoggerArgs.

Link copied to clipboard
object LoggerMapper : ResourceMapper<Logger>
Link copied to clipboard

Builder for Logger.

Link copied to clipboard
class NamedValue : KotlinCustomResource

Manages an API Management Named Value.

Link copied to clipboard
data class NamedValueArgs(val apiManagementName: Output<String>? = null, val displayName: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null, val secret: Output<Boolean>? = null, val tags: Output<List<String>>? = null, val value: Output<String>? = null, val valueFromKeyVault: Output<NamedValueValueFromKeyVaultArgs>? = null) : ConvertibleToJava<NamedValueArgs>

Manages an API Management Named Value.

Link copied to clipboard
Link copied to clipboard
object NamedValueMapper : ResourceMapper<NamedValue>
Link copied to clipboard
Link copied to clipboard
class NotificationRecipientEmail : KotlinCustomResource

Manages a API Management Notification Recipient Email.

Link copied to clipboard
data class NotificationRecipientEmailArgs(val apiManagementId: Output<String>? = null, val email: Output<String>? = null, val notificationType: Output<String>? = null) : ConvertibleToJava<NotificationRecipientEmailArgs>

Manages a API Management Notification Recipient Email.

Link copied to clipboard
class NotificationRecipientUser : KotlinCustomResource

Manages a API Management Notification Recipient User.

Link copied to clipboard
data class NotificationRecipientUserArgs(val apiManagementId: Output<String>? = null, val notificationType: Output<String>? = null, val userId: Output<String>? = null) : ConvertibleToJava<NotificationRecipientUserArgs>

Manages a API Management Notification Recipient User.

Link copied to clipboard
class OpenIdConnectProvider : KotlinCustomResource

Manages an OpenID Connect Provider within a API Management Service.

Link copied to clipboard
data class OpenIdConnectProviderArgs(val apiManagementName: Output<String>? = null, val clientId: Output<String>? = null, val clientSecret: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val metadataEndpoint: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<OpenIdConnectProviderArgs>

Manages an OpenID Connect Provider within a API Management Service.

Link copied to clipboard
Link copied to clipboard
class Policy : KotlinCustomResource

Manages a API Management service Policy.

Link copied to clipboard
data class PolicyArgs(val apiManagementId: Output<String>? = null, val xmlContent: Output<String>? = null, val xmlLink: Output<String>? = null) : ConvertibleToJava<PolicyArgs>

Manages a API Management service Policy.

Link copied to clipboard

Builder for PolicyArgs.

Link copied to clipboard
class PolicyFragment : KotlinCustomResource

Manages an Api Management Policy Fragment.

Link copied to clipboard
data class PolicyFragmentArgs(val apiManagementId: Output<String>? = null, val description: Output<String>? = null, val format: Output<String>? = null, val name: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<PolicyFragmentArgs>

Manages an Api Management Policy Fragment.

Link copied to clipboard
Link copied to clipboard
object PolicyFragmentMapper : ResourceMapper<PolicyFragment>
Link copied to clipboard
object PolicyMapper : ResourceMapper<Policy>
Link copied to clipboard

Builder for Policy.

Link copied to clipboard
class Product : KotlinCustomResource

Manages an API Management Product.

Link copied to clipboard
class ProductApi : KotlinCustomResource

Manages an API Management API Assignment to a Product.

Link copied to clipboard
data class ProductApiArgs(val apiManagementName: Output<String>? = null, val apiName: Output<String>? = null, val productId: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<ProductApiArgs>

Manages an API Management API Assignment to a Product.

Link copied to clipboard
Link copied to clipboard
object ProductApiMapper : ResourceMapper<ProductApi>
Link copied to clipboard
Link copied to clipboard
data class ProductArgs(val apiManagementName: Output<String>? = null, val approvalRequired: Output<Boolean>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val productId: Output<String>? = null, val published: Output<Boolean>? = null, val resourceGroupName: Output<String>? = null, val subscriptionRequired: Output<Boolean>? = null, val subscriptionsLimit: Output<Int>? = null, val terms: Output<String>? = null) : ConvertibleToJava<ProductArgs>

Manages an API Management Product.

Link copied to clipboard
Link copied to clipboard
class ProductGroup : KotlinCustomResource

Manages an API Management Product Assignment to a Group.

Link copied to clipboard
data class ProductGroupArgs(val apiManagementName: Output<String>? = null, val groupName: Output<String>? = null, val productId: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<ProductGroupArgs>

Manages an API Management Product Assignment to a Group.

Link copied to clipboard
Link copied to clipboard
object ProductGroupMapper : ResourceMapper<ProductGroup>
Link copied to clipboard
Link copied to clipboard
object ProductMapper : ResourceMapper<Product>
Link copied to clipboard
class ProductPolicy : KotlinCustomResource

Manages an API Management Product Policy

Link copied to clipboard
data class ProductPolicyArgs(val apiManagementName: Output<String>? = null, val productId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val xmlContent: Output<String>? = null, val xmlLink: Output<String>? = null) : ConvertibleToJava<ProductPolicyArgs>

Manages an API Management Product Policy

Link copied to clipboard
Link copied to clipboard
object ProductPolicyMapper : ResourceMapper<ProductPolicy>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ProductTag : KotlinCustomResource

Manages an API Management Product tag

Link copied to clipboard
data class ProductTagArgs(val apiManagementName: Output<String>? = null, val apiManagementProductId: Output<String>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<ProductTagArgs>

Manages an API Management Product tag

Link copied to clipboard
Link copied to clipboard
object ProductTagMapper : ResourceMapper<ProductTag>
Link copied to clipboard
Link copied to clipboard
class RedisCache : KotlinCustomResource

Manages a API Management Redis Cache.

Link copied to clipboard
data class RedisCacheArgs(val apiManagementId: Output<String>? = null, val cacheLocation: Output<String>? = null, val connectionString: Output<String>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val redisCacheId: Output<String>? = null) : ConvertibleToJava<RedisCacheArgs>

Manages a API Management Redis Cache.

Link copied to clipboard
Link copied to clipboard
object RedisCacheMapper : ResourceMapper<RedisCache>
Link copied to clipboard
Link copied to clipboard
class Service : KotlinCustomResource
Link copied to clipboard
data class ServiceArgs(val additionalLocations: Output<List<ServiceAdditionalLocationArgs>>? = null, val certificates: Output<List<ServiceCertificateArgs>>? = null, val clientCertificateEnabled: Output<Boolean>? = null, val delegation: Output<ServiceDelegationArgs>? = null, val gatewayDisabled: Output<Boolean>? = null, val hostnameConfiguration: Output<ServiceHostnameConfigurationArgs>? = null, val identity: Output<ServiceIdentityArgs>? = null, val location: Output<String>? = null, val minApiVersion: Output<String>? = null, val name: Output<String>? = null, val notificationSenderEmail: Output<String>? = null, val protocols: Output<ServiceProtocolsArgs>? = null, val publicIpAddressId: Output<String>? = null, val publicNetworkAccessEnabled: Output<Boolean>? = null, val publisherEmail: Output<String>? = null, val publisherName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val security: Output<ServiceSecurityArgs>? = null, val signIn: Output<ServiceSignInArgs>? = null, val signUp: Output<ServiceSignUpArgs>? = null, val skuName: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val tenantAccess: Output<ServiceTenantAccessArgs>? = null, val virtualNetworkConfiguration: Output<ServiceVirtualNetworkConfigurationArgs>? = null, val virtualNetworkType: Output<String>? = null, val zones: Output<List<String>>? = null) : ConvertibleToJava<ServiceArgs>
Link copied to clipboard
Link copied to clipboard
object ServiceMapper : ResourceMapper<Service>
Link copied to clipboard
Link copied to clipboard
class Subscription : KotlinCustomResource

Manages a Subscription within a API Management Service.

Link copied to clipboard
data class SubscriptionArgs(val allowTracing: Output<Boolean>? = null, val apiId: Output<String>? = null, val apiManagementName: Output<String>? = null, val displayName: Output<String>? = null, val primaryKey: Output<String>? = null, val productId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val secondaryKey: Output<String>? = null, val state: Output<String>? = null, val subscriptionId: Output<String>? = null, val userId: Output<String>? = null) : ConvertibleToJava<SubscriptionArgs>

Manages a Subscription within a API Management Service.

Link copied to clipboard
Link copied to clipboard
object SubscriptionMapper : ResourceMapper<Subscription>
Link copied to clipboard
Link copied to clipboard
class Tag : KotlinCustomResource

Manages a API Management Tag.

Link copied to clipboard
data class TagArgs(val apiManagementId: Output<String>? = null, val displayName: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<TagArgs>

Manages a API Management Tag.

Link copied to clipboard

Builder for TagArgs.

Link copied to clipboard
object TagMapper : ResourceMapper<Tag>
Link copied to clipboard

Builder for Tag.

Link copied to clipboard
class User : KotlinCustomResource

Manages an API Management User.

Link copied to clipboard
data class UserArgs(val apiManagementName: Output<String>? = null, val confirmation: Output<String>? = null, val email: Output<String>? = null, val firstName: Output<String>? = null, val lastName: Output<String>? = null, val note: Output<String>? = null, val password: Output<String>? = null, val resourceGroupName: Output<String>? = null, val state: Output<String>? = null, val userId: Output<String>? = null) : ConvertibleToJava<UserArgs>

Manages an API Management User.

Link copied to clipboard

Builder for UserArgs.

Link copied to clipboard
object UserMapper : ResourceMapper<User>
Link copied to clipboard

Builder for User.

Functions

Link copied to clipboard
fun api(name: String): Api
suspend fun api(name: String, block: suspend ApiResourceBuilder.() -> Unit): Api
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun apiPolicy(name: String, block: suspend ApiPolicyResourceBuilder.() -> Unit): ApiPolicy
Link copied to clipboard
suspend fun apiRelease(name: String, block: suspend ApiReleaseResourceBuilder.() -> Unit): ApiRelease
Link copied to clipboard
suspend fun apiSchema(name: String, block: suspend ApiSchemaResourceBuilder.() -> Unit): ApiSchema
Link copied to clipboard
fun apiTag(name: String): ApiTag
suspend fun apiTag(name: String, block: suspend ApiTagResourceBuilder.() -> Unit): ApiTag
Link copied to clipboard
Link copied to clipboard
fun backend(name: String): Backend
suspend fun backend(name: String, block: suspend BackendResourceBuilder.() -> Unit): Backend
Link copied to clipboard
suspend fun certificate(name: String, block: suspend CertificateResourceBuilder.() -> Unit): Certificate
Link copied to clipboard
Link copied to clipboard
suspend fun diagnostic(name: String, block: suspend DiagnosticResourceBuilder.() -> Unit): Diagnostic
Link copied to clipboard
Link copied to clipboard
fun gateway(name: String): Gateway
suspend fun gateway(name: String, block: suspend GatewayResourceBuilder.() -> Unit): Gateway
Link copied to clipboard
suspend fun gatewayApi(name: String, block: suspend GatewayApiResourceBuilder.() -> Unit): GatewayApi
Link copied to clipboard
Link copied to clipboard
fun group(name: String): Group
suspend fun group(name: String, block: suspend GroupResourceBuilder.() -> Unit): Group
Link copied to clipboard
suspend fun groupUser(name: String, block: suspend GroupUserResourceBuilder.() -> Unit): GroupUser
Link copied to clipboard
fun logger(name: String): Logger
suspend fun logger(name: String, block: suspend LoggerResourceBuilder.() -> Unit): Logger
Link copied to clipboard
suspend fun namedValue(name: String, block: suspend NamedValueResourceBuilder.() -> Unit): NamedValue
Link copied to clipboard
fun policy(name: String): Policy
suspend fun policy(name: String, block: suspend PolicyResourceBuilder.() -> Unit): Policy
Link copied to clipboard
Link copied to clipboard
fun product(name: String): Product
suspend fun product(name: String, block: suspend ProductResourceBuilder.() -> Unit): Product
Link copied to clipboard
suspend fun productApi(name: String, block: suspend ProductApiResourceBuilder.() -> Unit): ProductApi
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun productTag(name: String, block: suspend ProductTagResourceBuilder.() -> Unit): ProductTag
Link copied to clipboard
suspend fun redisCache(name: String, block: suspend RedisCacheResourceBuilder.() -> Unit): RedisCache
Link copied to clipboard
fun service(name: String): Service
suspend fun service(name: String, block: suspend ServiceResourceBuilder.() -> Unit): Service
Link copied to clipboard
Link copied to clipboard
fun tag(name: String): Tag
suspend fun tag(name: String, block: suspend TagResourceBuilder.() -> Unit): Tag
Link copied to clipboard
fun user(name: String): User
suspend fun user(name: String, block: suspend UserResourceBuilder.() -> Unit): User