pulumi-azure-native-kotlin/com.pulumi.azurenative.apimanagement.kotlin.outputs

Package-level declarations

Types

Link copied to clipboard
data class AdditionalLocationResponse(val disableGateway: Boolean? = null, val gatewayRegionalUrl: String, val location: String, val privateIPAddresses: List<String>, val publicIPAddresses: List<String>, val sku: ApiManagementServiceSkuPropertiesResponse, val virtualNetworkConfiguration: VirtualNetworkConfigurationResponse? = null, val zones: List<String>? = null)

Description of an additional API Management resource location.

Link copied to clipboard
data class ApiManagementServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserIdentityPropertiesResponse>? = null)

Identity properties of the Api Management service resource.

data class ApiManagementServiceSkuPropertiesResponse(val capacity: Int, val name: String)

API Management service resource SKU properties.

Link copied to clipboard
data class ApiVersionConstraintResponse(val minApiVersion: String? = null)

Control Plane Apis version constraint for the API Management service.

Link copied to clipboard
data class ApiVersionSetContractDetailsResponse(val description: String? = null, val id: String? = null, val name: String? = null, val versionHeaderName: String? = null, val versionQueryName: String? = null, val versioningScheme: String? = null)

An API Version Set contains the common configuration for a set of API Versions relating

Link copied to clipboard
data class AuthenticationSettingsContractResponse(val oAuth2: OAuth2AuthenticationSettingsContractResponse? = null, val openid: OpenIdAuthenticationSettingsContractResponse? = null)

API Authentication Settings.

data class BackendAuthorizationHeaderCredentialsResponse(val parameter: String, val scheme: String)

Authorization header information.

Link copied to clipboard
data class BackendCredentialsContractResponse(val authorization: BackendAuthorizationHeaderCredentialsResponse? = null, val certificate: List<String>? = null, val certificateIds: List<String>? = null, val header: Map<String, List<String>>? = null, val query: Map<String, List<String>>? = null)

Details of the Credentials used to connect to Backend.

Link copied to clipboard
data class BackendPropertiesResponse(val serviceFabricCluster: BackendServiceFabricClusterPropertiesResponse? = null)

Properties specific to the Backend Type.

Link copied to clipboard
data class BackendProxyContractResponse(val password: String? = null, val url: String, val username: String? = null)

Details of the Backend WebProxy Server to use in the Request to Backend.

data class BackendServiceFabricClusterPropertiesResponse(val clientCertificateId: String? = null, val clientCertificatethumbprint: String? = null, val managementEndpoints: List<String>, val maxPartitionResolutionRetries: Int? = null, val serverCertificateThumbprints: List<String>? = null, val serverX509Names: List<X509CertificateNameResponse>? = null)

Properties of the Service Fabric Type Backend.

Link copied to clipboard
data class BackendTlsPropertiesResponse(val validateCertificateChain: Boolean? = null, val validateCertificateName: Boolean? = null)

Properties controlling TLS Certificate Validation.

Link copied to clipboard
data class BodyDiagnosticSettingsResponse(val bytes: Int? = null)

Body logging settings.

Link copied to clipboard
data class CertificateConfigurationResponse(val certificate: CertificateInformationResponse? = null, val certificatePassword: String? = null, val encodedCertificate: String? = null, val storeName: String)

Certificate configuration which consist of non-trusted intermediates and root certificates.

Link copied to clipboard
data class CertificateInformationResponse(val expiry: String, val subject: String, val thumbprint: String)

SSL certificate information.

Link copied to clipboard
data class DataMaskingEntityResponse(val mode: String? = null, val value: String? = null)
Link copied to clipboard
data class DataMaskingResponse(val headers: List<DataMaskingEntityResponse>? = null, val queryParams: List<DataMaskingEntityResponse>? = null)
data class EmailTemplateParametersContractPropertiesResponse(val description: String? = null, val name: String? = null, val title: String? = null)

Email Template Parameter contract.

Link copied to clipboard
data class GetApiDiagnosticResult(val alwaysLog: String? = null, val backend: PipelineDiagnosticSettingsResponse? = null, val frontend: PipelineDiagnosticSettingsResponse? = null, val httpCorrelationProtocol: String? = null, val id: String, val logClientIp: Boolean? = null, val loggerId: String, val metrics: Boolean? = null, val name: String, val operationNameFormat: String? = null, val sampling: SamplingSettingsResponse? = null, val type: String, val verbosity: String? = null)

Diagnostic details.

Link copied to clipboard
data class GetApiIssueAttachmentResult(val content: String, val contentFormat: String, val id: String, val name: String, val title: String, val type: String)

Issue Attachment Contract details.

Link copied to clipboard
data class GetApiIssueCommentResult(val createdDate: String? = null, val id: String, val name: String, val text: String, val type: String, val userId: String)

Issue Comment Contract details.

Link copied to clipboard
data class GetApiIssueResult(val apiId: String? = null, val createdDate: String? = null, val description: String, val id: String, val name: String, val state: String? = null, val title: String, val type: String, val userId: String)

Issue Contract details.

data class GetApiManagementServiceDomainOwnershipIdentifierResult(val domainOwnershipIdentifier: String)

Response of the GetDomainOwnershipIdentifier operation.

Link copied to clipboard
data class GetApiManagementServiceResult(val additionalLocations: List<AdditionalLocationResponse>? = null, val apiVersionConstraint: ApiVersionConstraintResponse? = null, val certificates: List<CertificateConfigurationResponse>? = null, val createdAtUtc: String, val customProperties: Map<String, String>? = null, val developerPortalUrl: String, val disableGateway: Boolean? = null, val enableClientCertificate: Boolean? = null, val etag: String, val gatewayRegionalUrl: String, val gatewayUrl: String, val hostnameConfigurations: List<HostnameConfigurationResponse>? = null, val id: String, val identity: ApiManagementServiceIdentityResponse? = null, val location: String, val managementApiUrl: String, val name: String, val notificationSenderEmail: String? = null, val portalUrl: String, val privateIPAddresses: List<String>, val provisioningState: String, val publicIPAddresses: List<String>, val publisherEmail: String, val publisherName: String, val restore: Boolean? = null, val scmUrl: String, val sku: ApiManagementServiceSkuPropertiesResponse, val tags: Map<String, String>? = null, val targetProvisioningState: String, val type: String, val virtualNetworkConfiguration: VirtualNetworkConfigurationResponse? = null, val virtualNetworkType: String? = null, val zones: List<String>? = null)

A single API Management service resource in List or Get response.

Link copied to clipboard
data class GetApiManagementServiceSsoTokenResult(val redirectUri: String? = null)

The response of the GetSsoToken operation.

Link copied to clipboard
data class GetApiOperationPolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

Link copied to clipboard
data class GetApiOperationResult(val description: String? = null, val displayName: String, val id: String, val method: String, val name: String, val policies: String? = null, val request: RequestContractResponse? = null, val responses: List<ResponseContractResponse>? = null, val templateParameters: List<ParameterContractResponse>? = null, val type: String, val urlTemplate: String)

Api Operation details.

Link copied to clipboard
data class GetApiPolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

Link copied to clipboard
data class GetApiReleaseResult(val apiId: String? = null, val createdDateTime: String, val id: String, val name: String, val notes: String? = null, val type: String, val updatedDateTime: String)

ApiRelease details.

Link copied to clipboard
data class GetApiResult(val apiRevision: String? = null, val apiRevisionDescription: String? = null, val apiType: String? = null, val apiVersion: String? = null, val apiVersionDescription: String? = null, val apiVersionSet: ApiVersionSetContractDetailsResponse? = null, val apiVersionSetId: String? = null, val authenticationSettings: AuthenticationSettingsContractResponse? = null, val description: String? = null, val displayName: String? = null, val id: String, val isCurrent: Boolean? = null, val isOnline: Boolean, val name: String, val path: String, val protocols: List<String>? = null, val serviceUrl: String? = null, val sourceApiId: String? = null, val subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContractResponse? = null, val subscriptionRequired: Boolean? = null, val type: String)

Api details.

Link copied to clipboard
data class GetApiSchemaResult(val contentType: String, val definitions: Any? = null, val id: String, val name: String, val type: String, val value: String? = null)

Schema Contract details.

Link copied to clipboard
data class GetApiTagDescriptionResult(val description: String? = null, val displayName: String? = null, val externalDocsDescription: String? = null, val externalDocsUrl: String? = null, val id: String, val name: String, val tagId: String? = null, val type: String)

Contract details.

Link copied to clipboard
data class GetApiVersionSetResult(val description: String? = null, val displayName: String, val id: String, val name: String, val type: String, val versionHeaderName: String? = null, val versionQueryName: String? = null, val versioningScheme: String)

Api Version Set Contract details.

Link copied to clipboard
data class GetAuthorizationServerResult(val authorizationEndpoint: String, val authorizationMethods: List<String>? = null, val bearerTokenSendingMethods: List<String>? = null, val clientAuthenticationMethod: List<String>? = null, val clientId: String, val clientRegistrationEndpoint: String, val clientSecret: String? = null, val defaultScope: String? = null, val description: String? = null, val displayName: String, val grantTypes: List<String>, val id: String, val name: String, val resourceOwnerPassword: String? = null, val resourceOwnerUsername: String? = null, val supportState: Boolean? = null, val tokenBodyParameters: List<TokenBodyParameterContractResponse>? = null, val tokenEndpoint: String? = null, val type: String)

External OAuth authorization server settings.

Link copied to clipboard
data class GetBackendResult(val credentials: BackendCredentialsContractResponse? = null, val description: String? = null, val id: String, val name: String, val properties: BackendPropertiesResponse, val protocol: String, val proxy: BackendProxyContractResponse? = null, val resourceId: String? = null, val title: String? = null, val tls: BackendTlsPropertiesResponse? = null, val type: String, val url: String)

Backend details.

Link copied to clipboard
data class GetCacheResult(val connectionString: String, val description: String? = null, val id: String, val name: String, val resourceId: String? = null, val type: String, val useFromLocation: String)

Cache details.

Link copied to clipboard
data class GetCertificateResult(val expirationDate: String, val id: String, val keyVault: KeyVaultContractPropertiesResponse? = null, val name: String, val subject: String, val thumbprint: String, val type: String)

Certificate details.

Link copied to clipboard
data class GetContentItemResult(val id: String, val name: String, val properties: Any, val type: String)

Content type contract details.

Link copied to clipboard
data class GetContentTypeResult(val description: String? = null, val id: String, val name: String, val schema: Any? = null, val type: String, val version: String? = null)

Content type contract details.

Link copied to clipboard
data class GetDiagnosticResult(val alwaysLog: String? = null, val backend: PipelineDiagnosticSettingsResponse? = null, val frontend: PipelineDiagnosticSettingsResponse? = null, val httpCorrelationProtocol: String? = null, val id: String, val logClientIp: Boolean? = null, val loggerId: String, val metrics: Boolean? = null, val name: String, val operationNameFormat: String? = null, val sampling: SamplingSettingsResponse? = null, val type: String, val verbosity: String? = null)

Diagnostic details.

Link copied to clipboard
data class GetEmailTemplateResult(val body: String, val description: String? = null, val id: String, val isDefault: Boolean, val name: String, val parameters: List<EmailTemplateParametersContractPropertiesResponse>? = null, val subject: String, val title: String? = null, val type: String)

Email Template details.

Link copied to clipboard
data class GetGatewayCertificateAuthorityResult(val id: String, val isTrusted: Boolean? = null, val name: String, val type: String)

Gateway certificate authority details.

Link copied to clipboard
data class GetGatewayHostnameConfigurationResult(val certificateId: String? = null, val hostname: String? = null, val http2Enabled: Boolean? = null, val id: String, val name: String, val negotiateClientCertificate: Boolean? = null, val tls10Enabled: Boolean? = null, val tls11Enabled: Boolean? = null, val type: String)

Gateway hostname configuration details.

Link copied to clipboard
data class GetGatewayResult(val description: String? = null, val id: String, val locationData: ResourceLocationDataContractResponse? = null, val name: String, val type: String)

Gateway details.

Link copied to clipboard
data class GetGroupResult(val builtIn: Boolean, val description: String? = null, val displayName: String, val externalId: String? = null, val id: String, val name: String, val type: String)

Contract details.

Link copied to clipboard
data class GetIdentityProviderResult(val allowedTenants: List<String>? = null, val authority: String? = null, val clientId: String, val clientSecret: String? = null, val id: String, val name: String, val passwordResetPolicyName: String? = null, val profileEditingPolicyName: String? = null, val signinPolicyName: String? = null, val signinTenant: String? = null, val signupPolicyName: String? = null, val type: String)

Identity Provider details.

Link copied to clipboard
data class GetLoggerResult(val credentials: Map<String, String>? = null, val description: String? = null, val id: String, val isBuffered: Boolean? = null, val loggerType: String, val name: String, val resourceId: String? = null, val type: String)

Logger details.

Link copied to clipboard
data class GetNamedValueResult(val displayName: String, val id: String, val keyVault: KeyVaultContractPropertiesResponse? = null, val name: String, val secret: Boolean? = null, val tags: List<String>? = null, val type: String, val value: String? = null)

NamedValue details.

Link copied to clipboard
data class GetOpenIdConnectProviderResult(val clientId: String, val clientSecret: String? = null, val description: String? = null, val displayName: String, val id: String, val metadataEndpoint: String, val name: String, val type: String)

OpenId Connect Provider details.

Link copied to clipboard
data class GetPolicyFragmentResult(val description: String? = null, val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy fragment contract details.

Link copied to clipboard
data class GetPolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

Link copied to clipboard
data class GetPrivateEndpointConnectionByNameResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class GetProductPolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

Link copied to clipboard
data class GetProductResult(val approvalRequired: Boolean? = null, val description: String? = null, val displayName: String, val id: String, val name: String, val state: String? = null, val subscriptionRequired: Boolean? = null, val subscriptionsLimit: Int? = null, val terms: String? = null, val type: String)

Product details.

Link copied to clipboard
data class GetPropertyResult(val displayName: String, val id: String, val name: String, val secret: Boolean? = null, val tags: List<String>? = null, val type: String, val value: String)

Property details.

Link copied to clipboard
data class GetSchemaResult(val description: String? = null, val id: String, val name: String, val schemaType: String, val type: String, val value: String? = null)

Schema Contract details.

Link copied to clipboard
data class GetSubscriptionResult(val allowTracing: Boolean? = null, val createdDate: String, val displayName: String? = null, val endDate: String? = null, val expirationDate: String? = null, val id: String, val name: String, val notificationDate: String? = null, val ownerId: String? = null, val primaryKey: String? = null, val scope: String, val secondaryKey: String? = null, val startDate: String? = null, val state: String, val stateComment: String? = null, val type: String)

Subscription details.

Link copied to clipboard
data class GetTagByApiResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

Link copied to clipboard
data class GetTagByOperationResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

Link copied to clipboard
data class GetTagByProductResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

Link copied to clipboard
data class GetTagResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

Link copied to clipboard
data class GetUserResult(val email: String? = null, val firstName: String? = null, val groups: List<GroupContractPropertiesResponse>, val id: String, val identities: List<UserIdentityContractResponse>? = null, val lastName: String? = null, val name: String, val note: String? = null, val registrationDate: String? = null, val state: String? = null, val type: String)

User details.

Link copied to clipboard
data class GetUserSharedAccessTokenResult(val value: String? = null)

Get User Token response details.

Link copied to clipboard
data class GroupContractPropertiesResponse(val builtIn: Boolean, val description: String? = null, val displayName: String, val externalId: String? = null, val type: String? = null)

Group contract Properties.

Link copied to clipboard
data class HostnameConfigurationResponse(val certificate: CertificateInformationResponse? = null, val certificatePassword: String? = null, val defaultSslBinding: Boolean? = null, val encodedCertificate: String? = null, val hostName: String, val identityClientId: String? = null, val keyVaultId: String? = null, val negotiateClientCertificate: Boolean? = null, val type: String)

Custom hostname configuration.

Link copied to clipboard
data class HttpMessageDiagnosticResponse(val body: BodyDiagnosticSettingsResponse? = null, val dataMasking: DataMaskingResponse? = null, val headers: List<String>? = null)

Http message diagnostic settings.

Link copied to clipboard
data class KeyVaultContractPropertiesResponse(val identityClientId: String? = null, val lastStatus: KeyVaultLastAccessStatusContractPropertiesResponse? = null, val secretIdentifier: String? = null)

KeyVault contract details.

data class KeyVaultLastAccessStatusContractPropertiesResponse(val code: String? = null, val message: String? = null, val timeStampUtc: String? = null)

Issue contract Update Properties.

Link copied to clipboard
data class ListAuthorizationServerSecretsResult(val clientSecret: String? = null, val resourceOwnerPassword: String? = null, val resourceOwnerUsername: String? = null)

OAuth Server Secrets Contract.

Link copied to clipboard
data class ListDelegationSettingSecretsResult(val validationKey: String? = null)

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

Link copied to clipboard
data class ListGatewayKeysResult(val primary: String? = null, val secondary: String? = null)

Gateway authentication keys.

Link copied to clipboard
data class ListIdentityProviderSecretsResult(val clientSecret: String? = null)

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

Link copied to clipboard
data class ListNamedValueResult(val value: String? = null)

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

Link copied to clipboard
data class ListOpenIdConnectProviderSecretsResult(val clientSecret: String? = null)

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

Link copied to clipboard
data class ListPolicyFragmentReferencesResult(val count: Double? = null, val nextLink: String? = null, val value: List<ResourceCollectionResponseValue>? = null)

A collection of resources.

Link copied to clipboard
data class ListSubscriptionSecretsResult(val primaryKey: String? = null, val secondaryKey: String? = null)

Subscription keys.

Link copied to clipboard
data class ListTenantAccessGitSecretsResult(val enabled: Boolean? = null, val id: String? = null, val primaryKey: String? = null, val secondaryKey: String? = null)

Tenant access information contract of the API Management service.

Link copied to clipboard
data class ListTenantAccessSecretsResult(val enabled: Boolean? = null, val id: String? = null, val primaryKey: String? = null, val principalId: String? = null, val secondaryKey: String? = null)

Tenant access information contract of the API Management service.

data class OAuth2AuthenticationSettingsContractResponse(val authorizationServerId: String? = null, val scope: String? = null)

API OAuth2 Authentication settings details.

data class OpenIdAuthenticationSettingsContractResponse(val bearerTokenSendingMethods: List<String>? = null, val openidProviderId: String? = null)

API OAuth2 Authentication settings details.

Link copied to clipboard
data class ParameterContractResponse(val defaultValue: String? = null, val description: String? = null, val name: String, val required: Boolean? = null, val type: String, val values: List<String>? = null)

Operation parameters details.

Link copied to clipboard
data class PipelineDiagnosticSettingsResponse(val request: HttpMessageDiagnosticResponse? = null, val response: HttpMessageDiagnosticResponse? = null)

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

A collection of information about the state of the connection between service consumer and provider.

Link copied to clipboard
data class RepresentationContractResponse(val contentType: String, val formParameters: List<ParameterContractResponse>? = null, val sample: String? = null, val schemaId: String? = null, val typeName: String? = null)

Operation request/response representation details.

Link copied to clipboard
data class RequestContractResponse(val description: String? = null, val headers: List<ParameterContractResponse>? = null, val queryParameters: List<ParameterContractResponse>? = null, val representations: List<RepresentationContractResponse>? = null)

Operation request details.

Link copied to clipboard
data class ResourceCollectionResponseValue(val id: String, val name: String, val type: String)
Link copied to clipboard
data class ResourceLocationDataContractResponse(val city: String? = null, val countryOrRegion: String? = null, val district: String? = null, val name: String)

Resource location data properties.

Link copied to clipboard
data class ResponseContractResponse(val description: String? = null, val headers: List<ParameterContractResponse>? = null, val representations: List<RepresentationContractResponse>? = null, val statusCode: Int)

Operation response details.

Link copied to clipboard
data class SamplingSettingsResponse(val percentage: Double? = null, val samplingType: String? = null)

Sampling settings for Diagnostic.

data class SubscriptionKeyParameterNamesContractResponse(val header: String? = null, val query: String? = null)

Subscription key parameter names details.

Link copied to clipboard
data class TokenBodyParameterContractResponse(val name: String, val value: String)

OAuth acquire token request body parameter (www-url-form-encoded).

Link copied to clipboard
data class UserIdentityContractResponse(val id: String? = null, val provider: String? = null)

User identity details.

Link copied to clipboard
data class UserIdentityPropertiesResponse(val clientId: String? = null, val principalId: String? = null)
Link copied to clipboard
data class VirtualNetworkConfigurationResponse(val subnetResourceId: String? = null, val subnetname: String, val vnetid: String)

Configuration of a virtual network to which API Management service is deployed.

Link copied to clipboard
data class X509CertificateNameResponse(val issuerCertificateThumbprint: String? = null, val name: String? = null)

Properties of server X509Names.