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

Package-level declarations

Types

data class AdditionalLocationResponse(val disableGateway: Boolean? = null, val gatewayRegionalUrl: String, val location: String, val natGatewayState: String? = null, val outboundPublicIPAddresses: List<String>, val platformVersion: String, val privateIPAddresses: List<String>, val publicIPAddresses: List<String>, val publicIpAddressId: String? = null, val sku: ApiManagementServiceSkuPropertiesResponse, val virtualNetworkConfiguration: VirtualNetworkConfigurationResponse? = null, val zones: List<String>? = null)

Description of an additional API Management resource location.

ApiContactInformationResponse

data class ApiContactInformationResponse(val email: String? = null, val name: String? = null, val url: String? = null)

API contact information

ApiLicenseInformationResponse

data class ApiLicenseInformationResponse(val name: String? = null, val url: String? = null)

API license information

ApiManagementGatewaySkuPropertiesResponse

data class ApiManagementGatewaySkuPropertiesResponse(val capacity: Int? = null, val name: String)

API Management gateway resource SKU properties.

ApiManagementServiceIdentityResponse

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.

ApiManagementServiceSkuPropertiesResponse

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

API Management service resource SKU properties.

ApiVersionConstraintResponse

data class ApiVersionConstraintResponse(val minApiVersion: String? = null)

Control Plane Apis version constraint for the API Management service.

ApiVersionSetContractDetailsResponse

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

ArmIdWrapperResponse

data class ArmIdWrapperResponse(val id: String)

A wrapper for an ARM resource id

AuthenticationSettingsContractResponse

data class AuthenticationSettingsContractResponse(val oAuth2: OAuth2AuthenticationSettingsContractResponse? = null, val oAuth2AuthenticationSettings: List<OAuth2AuthenticationSettingsContractResponse>? = null, val openid: OpenIdAuthenticationSettingsContractResponse? = null, val openidAuthenticationSettings: List<OpenIdAuthenticationSettingsContractResponse>? = null)

API Authentication Settings.

AuthorizationErrorResponse

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

Authorization error details.

AuthorizationProviderOAuth2GrantTypesResponse

data class AuthorizationProviderOAuth2GrantTypesResponse(val authorizationCode: Map<String, String>? = null, val clientCredentials: Map<String, String>? = null)

Authorization Provider oauth2 grant types settings

AuthorizationProviderOAuth2SettingsResponse

data class AuthorizationProviderOAuth2SettingsResponse(val grantTypes: AuthorizationProviderOAuth2GrantTypesResponse? = null, val redirectUrl: String? = null)

OAuth2 settings details

BackendAuthorizationHeaderCredentialsResponse

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

Authorization header information.

BackendBaseParametersResponsePool

data class BackendBaseParametersResponsePool(val services: List<BackendPoolItemResponse>? = null)

BackendCircuitBreakerResponse

data class BackendCircuitBreakerResponse(val rules: List<CircuitBreakerRuleResponse>? = null)

The configuration of the backend circuit breaker

BackendConfigurationResponse

data class BackendConfigurationResponse(val subnet: BackendSubnetConfigurationResponse? = null)

Information regarding how the gateway should integrate with backend systems.

BackendCredentialsContractResponse

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.

BackendPoolItemResponse

data class BackendPoolItemResponse(val id: String, val priority: Int? = null, val weight: Int? = null)

Backend pool service information

BackendPropertiesResponse

data class BackendPropertiesResponse(val serviceFabricCluster: BackendServiceFabricClusterPropertiesResponse? = null)

Properties specific to the Backend Type.

BackendProxyContractResponse

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.

BackendServiceFabricClusterPropertiesResponse

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.

BackendSubnetConfigurationResponse

data class BackendSubnetConfigurationResponse(val id: String? = null)

Information regarding how the subnet to which the gateway should be injected.

BackendTlsPropertiesResponse

data class BackendTlsPropertiesResponse(val validateCertificateChain: Boolean? = null, val validateCertificateName: Boolean? = null)

Properties controlling TLS Certificate Validation.

BodyDiagnosticSettingsResponse

data class BodyDiagnosticSettingsResponse(val bytes: Int? = null)

Body logging settings.

CertificateConfigurationResponse

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.

CertificateInformationResponse

data class CertificateInformationResponse(val expiry: String, val subject: String, val thumbprint: String)

SSL certificate information.

CircuitBreakerFailureConditionResponse

data class CircuitBreakerFailureConditionResponse(val count: Double? = null, val errorReasons: List<String>? = null, val interval: String? = null, val percentage: Double? = null, val statusCodeRanges: List<FailureStatusCodeRangeResponse>? = null)

The trip conditions of the circuit breaker

CircuitBreakerRuleResponse

data class CircuitBreakerRuleResponse(val acceptRetryAfter: Boolean? = null, val failureCondition: CircuitBreakerFailureConditionResponse? = null, val name: String? = null, val tripDuration: String? = null)

Rule configuration to trip the backend.

DataMaskingEntityResponse

data class DataMaskingEntityResponse(val mode: String? = null, val value: String? = null)

DataMaskingResponse

data class DataMaskingResponse(val headers: List<DataMaskingEntityResponse>? = null, val queryParams: List<DataMaskingEntityResponse>? = null)

EmailTemplateParametersContractPropertiesResponse

data class EmailTemplateParametersContractPropertiesResponse(val description: String? = null, val name: String? = null, val title: String? = null)

Email Template Parameter contract.

FailureStatusCodeRangeResponse

data class FailureStatusCodeRangeResponse(val max: Int? = null, val min: Int? = null)

The failure http status code range

FrontendConfigurationResponse

data class FrontendConfigurationResponse(val defaultHostname: String)

Information regarding how the gateway should be exposed.

GatewayConfigurationApiResponse

data class GatewayConfigurationApiResponse(val hostname: String)

Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.

GetApiDiagnosticResult

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.

GetApiGatewayConfigConnectionResult

data class GetApiGatewayConfigConnectionResult(val defaultHostname: String, val etag: String, val hostnames: List<String>? = null, val id: String, val name: String, val provisioningState: String, val sourceId: String? = null, val type: String)

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

GetApiGatewayResult

data class GetApiGatewayResult(val backend: BackendConfigurationResponse? = null, val configurationApi: GatewayConfigurationApiResponse? = null, val createdAtUtc: String, val etag: String, val frontend: FrontendConfigurationResponse? = null, val id: String, val location: String, val name: String, val provisioningState: String, val sku: ApiManagementGatewaySkuPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val targetProvisioningState: String, val type: String, val virtualNetworkType: String? = null)

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

GetApiIssueAttachmentResult

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.

GetApiIssueCommentResult

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.

GetApiIssueResult

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.

GetApiManagementServiceDomainOwnershipIdentifierResult

data class GetApiManagementServiceDomainOwnershipIdentifierResult(val domainOwnershipIdentifier: String)

Response of the GetDomainOwnershipIdentifier operation.

GetApiManagementServiceResult

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 natGatewayState: String? = null, val notificationSenderEmail: String? = null, val outboundPublicIPAddresses: List<String>, val platformVersion: String, val portalUrl: String, val privateEndpointConnections: List<RemotePrivateEndpointConnectionWrapperResponse>? = null, val privateIPAddresses: List<String>, val provisioningState: String, val publicIPAddresses: List<String>, val publicIpAddressId: String? = null, val publicNetworkAccess: String? = null, val publisherEmail: String, val publisherName: String, val restore: Boolean? = null, val scmUrl: String, val sku: ApiManagementServiceSkuPropertiesResponse, val systemData: SystemDataResponse, 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.

GetApiManagementServiceSsoTokenResult

data class GetApiManagementServiceSsoTokenResult(val redirectUri: String? = null)

The response of the GetSsoToken operation.

GetApiOperationPolicyResult

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

Policy Contract details.

GetApiOperationResult

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.

GetApiPolicyResult

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

Policy Contract details.

GetApiReleaseResult

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.

GetApiResult

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 contact: ApiContactInformationResponse? = null, val description: String? = null, val displayName: String? = null, val id: String, val isCurrent: Boolean? = null, val isOnline: Boolean, val license: ApiLicenseInformationResponse? = null, 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 termsOfServiceUrl: String? = null, val type: String)

API details.

GetApiSchemaResult

data class GetApiSchemaResult(val components: Any? = null, val contentType: String, val definitions: Any? = null, val id: String, val name: String, val type: String, val value: String? = null)

API Schema Contract details.

GetApiTagDescriptionResult

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.

GetApiVersionSetResult

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.

GetApiWikiResult

data class GetApiWikiResult(val documents: List<WikiDocumentationContractResponse>? = null, val id: String, val name: String, val type: String)

Wiki properties

GetAuthorizationAccessPolicyResult

data class GetAuthorizationAccessPolicyResult(val id: String, val name: String, val objectId: String? = null, val tenantId: String? = null, val type: String)

Authorization access policy contract.

GetAuthorizationLoginLinkPostResult

data class GetAuthorizationLoginLinkPostResult(val loginLink: String? = null)

Authorization login response contract.

GetAuthorizationProviderResult

data class GetAuthorizationProviderResult(val displayName: String? = null, val id: String, val identityProvider: String? = null, val name: String, val oauth2: AuthorizationProviderOAuth2SettingsResponse? = null, val type: String)

Authorization Provider contract.

GetAuthorizationResult

data class GetAuthorizationResult(val authorizationType: String? = null, val error: AuthorizationErrorResponse? = null, val id: String, val name: String, val oAuth2GrantType: String? = null, val parameters: Map<String, String>? = null, val status: String? = null, val type: String)

Authorization contract.

GetAuthorizationServerResult

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, val useInApiDocumentation: Boolean? = null, val useInTestConsole: Boolean? = null)

External OAuth authorization server settings.

GetBackendResult

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.

GetCacheResult

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.

GetCertificateResult

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.

GetContentItemResult

data class GetContentItemResult(val id: String, val name: String, val properties: Any, val type: String)

Content type contract details.

GetContentTypeResult

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.

GetDiagnosticResult

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.

GetDocumentationResult

data class GetDocumentationResult(val content: String? = null, val id: String, val name: String, val title: String? = null, val type: String)

Markdown documentation details.

GetEmailTemplateResult

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.

GetGatewayCertificateAuthorityResult

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

Gateway certificate authority details.

GetGatewayHostnameConfigurationResult

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.

GetGatewayResult

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

Gateway details.

GetGlobalSchemaResult

data class GetGlobalSchemaResult(val description: String? = null, val id: String, val name: String, val schemaType: String, val type: String, val value: Any? = null)

Global Schema Contract details.

GetGraphQLApiResolverPolicyResult

data class GetGraphQLApiResolverPolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

GetGraphQLApiResolverResult

data class GetGraphQLApiResolverResult(val description: String? = null, val displayName: String? = null, val id: String, val name: String, val path: String? = null, val type: String)

GraphQL API Resolver details.

GetGroupResult

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.

GetIdentityProviderResult

data class GetIdentityProviderResult(val allowedTenants: List<String>? = null, val authority: String? = null, val clientId: String, val clientLibrary: String? = null, 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.

GetLoggerResult

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.

GetNamedValueResult

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.

GetOpenIdConnectProviderResult

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, val useInApiDocumentation: Boolean? = null, val useInTestConsole: Boolean? = null)

OpenId Connect Provider details.

GetPolicyFragmentResult

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.

GetPolicyRestrictionResult

data class GetPolicyRestrictionResult(val id: String, val name: String, val requireBase: String? = null, val scope: String? = null, val type: String)

Policy restriction contract details.

GetPolicyResult

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

Policy Contract details.

GetPrivateEndpointConnectionByNameResult

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.

GetProductApiLinkResult

data class GetProductApiLinkResult(val apiId: String, val id: String, val name: String, val type: String)

Product-API link details.

GetProductGroupLinkResult

data class GetProductGroupLinkResult(val groupId: String, val id: String, val name: String, val type: String)

Product-group link details.

GetProductPolicyResult

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

Policy Contract details.

GetProductResult

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.

GetProductWikiResult

data class GetProductWikiResult(val documents: List<WikiDocumentationContractResponse>? = null, val id: String, val name: String, val type: String)

Wiki properties

GetSchemaResult

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.

GetSubscriptionResult

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.

GetTagApiLinkResult

data class GetTagApiLinkResult(val apiId: String, val id: String, val name: String, val type: String)

Tag-API link details.

GetTagByApiResult

data class GetTagByApiResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

GetTagByOperationResult

data class GetTagByOperationResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

GetTagByProductResult

data class GetTagByProductResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

GetTagOperationLinkResult

data class GetTagOperationLinkResult(val id: String, val name: String, val operationId: String, val type: String)

Tag-operation link details.

GetTagProductLinkResult

data class GetTagProductLinkResult(val id: String, val name: String, val productId: String, val type: String)

Tag-product link details.

GetTagResult

data class GetTagResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

GetUserResult

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.

GetUserSharedAccessTokenResult

data class GetUserSharedAccessTokenResult(val value: String? = null)

Get User Token response details.

GetWorkspaceApiDiagnosticResult

data class GetWorkspaceApiDiagnosticResult(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.

GetWorkspaceApiOperationPolicyResult

data class GetWorkspaceApiOperationPolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

GetWorkspaceApiOperationResult

data class GetWorkspaceApiOperationResult(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.

GetWorkspaceApiPolicyResult

data class GetWorkspaceApiPolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

GetWorkspaceApiReleaseResult

data class GetWorkspaceApiReleaseResult(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.

GetWorkspaceApiResult

data class GetWorkspaceApiResult(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 contact: ApiContactInformationResponse? = null, val description: String? = null, val displayName: String? = null, val id: String, val isCurrent: Boolean? = null, val isOnline: Boolean, val license: ApiLicenseInformationResponse? = null, 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 termsOfServiceUrl: String? = null, val type: String)

API details.

GetWorkspaceApiSchemaResult

data class GetWorkspaceApiSchemaResult(val components: Any? = null, val contentType: String, val definitions: Any? = null, val id: String, val name: String, val type: String, val value: String? = null)

API Schema Contract details.

GetWorkspaceApiVersionSetResult

data class GetWorkspaceApiVersionSetResult(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.

GetWorkspaceBackendResult

data class GetWorkspaceBackendResult(val circuitBreaker: BackendCircuitBreakerResponse? = null, val credentials: BackendCredentialsContractResponse? = null, val description: String? = null, val id: String, val name: String, val pool: BackendBaseParametersResponsePool? = null, 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.

GetWorkspaceCertificateResult

data class GetWorkspaceCertificateResult(val expirationDate: String, val id: String, val keyVault: KeyVaultContractPropertiesResponse? = null, val name: String, val subject: String, val thumbprint: String, val type: String)

Certificate details.

GetWorkspaceDiagnosticResult

data class GetWorkspaceDiagnosticResult(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.

GetWorkspaceGlobalSchemaResult

data class GetWorkspaceGlobalSchemaResult(val description: String? = null, val id: String, val name: String, val schemaType: String, val type: String, val value: Any? = null)

Global Schema Contract details.

GetWorkspaceGroupResult

data class GetWorkspaceGroupResult(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.

GetWorkspaceLoggerResult

data class GetWorkspaceLoggerResult(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.

GetWorkspaceNamedValueResult

data class GetWorkspaceNamedValueResult(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.

GetWorkspacePolicyFragmentResult

data class GetWorkspacePolicyFragmentResult(val description: String? = null, val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy fragment contract details.

GetWorkspacePolicyResult

data class GetWorkspacePolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

GetWorkspaceProductApiLinkResult

data class GetWorkspaceProductApiLinkResult(val apiId: String, val id: String, val name: String, val type: String)

Product-API link details.

GetWorkspaceProductGroupLinkResult

data class GetWorkspaceProductGroupLinkResult(val groupId: String, val id: String, val name: String, val type: String)

Product-group link details.

GetWorkspaceProductPolicyResult

data class GetWorkspaceProductPolicyResult(val format: String? = null, val id: String, val name: String, val type: String, val value: String)

Policy Contract details.

GetWorkspaceProductResult

data class GetWorkspaceProductResult(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.

GetWorkspaceResult

data class GetWorkspaceResult(val description: String? = null, val displayName: String, val id: String, val name: String, val type: String)

Workspace details.

GetWorkspaceSubscriptionResult

data class GetWorkspaceSubscriptionResult(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.

GetWorkspaceTagApiLinkResult

data class GetWorkspaceTagApiLinkResult(val apiId: String, val id: String, val name: String, val type: String)

Tag-API link details.

GetWorkspaceTagOperationLinkResult

data class GetWorkspaceTagOperationLinkResult(val id: String, val name: String, val operationId: String, val type: String)

Tag-operation link details.

GetWorkspaceTagProductLinkResult

data class GetWorkspaceTagProductLinkResult(val id: String, val name: String, val productId: String, val type: String)

Tag-product link details.

GetWorkspaceTagResult

data class GetWorkspaceTagResult(val displayName: String, val id: String, val name: String, val type: String)

Tag Contract details.

GroupContractPropertiesResponse

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

Group contract Properties.

HostnameConfigurationResponse

data class HostnameConfigurationResponse(val certificate: CertificateInformationResponse? = null, val certificatePassword: String? = null, val certificateSource: String? = null, val certificateStatus: 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.

HttpMessageDiagnosticResponse

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

Http message diagnostic settings.

KeyVaultContractPropertiesResponse

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

KeyVault contract details.

KeyVaultLastAccessStatusContractPropertiesResponse

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

Issue contract Update Properties.

ListAuthorizationServerSecretsResult

data class ListAuthorizationServerSecretsResult(val clientSecret: String? = null, val resourceOwnerPassword: String? = null, val resourceOwnerUsername: String? = null)

OAuth Server Secrets Contract.

ListDelegationSettingSecretsResult

data class ListDelegationSettingSecretsResult(val validationKey: String? = null)

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

ListGatewayDebugCredentialsResult

data class ListGatewayDebugCredentialsResult(val token: String? = null)

Gateway debug credentials.

ListGatewayKeysResult

data class ListGatewayKeysResult(val primary: String? = null, val secondary: String? = null)

Gateway authentication keys.

ListIdentityProviderSecretsResult

data class ListIdentityProviderSecretsResult(val clientSecret: String? = null)

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

ListNamedValueResult

data class ListNamedValueResult(val value: String? = null)

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

ListOpenIdConnectProviderSecretsResult

data class ListOpenIdConnectProviderSecretsResult(val clientSecret: String? = null)

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

ListPolicyFragmentReferencesResult

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

A collection of resources.

ListSubscriptionSecretsResult

data class ListSubscriptionSecretsResult(val primaryKey: String? = null, val secondaryKey: String? = null)

Subscription keys.

ListTenantAccessSecretsResult

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.

ListWorkspaceNamedValueResult

data class ListWorkspaceNamedValueResult(val value: String? = null)

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

ListWorkspacePolicyFragmentReferencesResult

data class ListWorkspacePolicyFragmentReferencesResult(val count: Double? = null, val nextLink: String? = null, val value: List<ResourceCollectionResponseValue>? = null)

A collection of resources.

ListWorkspaceSubscriptionSecretsResult

data class ListWorkspaceSubscriptionSecretsResult(val primaryKey: String? = null, val secondaryKey: String? = null)

Subscription keys.

OAuth2AuthenticationSettingsContractResponse

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

API OAuth2 Authentication settings details.

OpenIdAuthenticationSettingsContractResponse

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

API OAuth2 Authentication settings details.

ParameterContractResponse

data class ParameterContractResponse(val defaultValue: String? = null, val description: String? = null, val examples: Map<String, ParameterExampleContractResponse>? = null, val name: String, val required: Boolean? = null, val schemaId: String? = null, val type: String, val typeName: String? = null, val values: List<String>? = null)

Operation parameters details.

ParameterExampleContractResponse

data class ParameterExampleContractResponse(val description: String? = null, val externalValue: String? = null, val summary: String? = null, val value: Any? = null)

Parameter example.

PipelineDiagnosticSettingsResponse

data class PipelineDiagnosticSettingsResponse(val request: HttpMessageDiagnosticResponse? = null, val response: HttpMessageDiagnosticResponse? = null)

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

PrivateEndpointResponse

data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

PrivateLinkServiceConnectionStateResponse

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.

RemotePrivateEndpointConnectionWrapperResponse

data class RemotePrivateEndpointConnectionWrapperResponse(val groupIds: List<String>, val id: String? = null, val name: String? = null, val privateEndpoint: ArmIdWrapperResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String? = null)

Remote Private Endpoint Connection resource.

RepresentationContractResponse

data class RepresentationContractResponse(val contentType: String, val examples: Map<String, ParameterExampleContractResponse>? = null, val formParameters: List<ParameterContractResponse>? = null, val schemaId: String? = null, val typeName: String? = null)

Operation request/response representation details.

RequestContractResponse

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.

ResourceCollectionResponseValue

data class ResourceCollectionResponseValue(val id: String, val name: String, val type: String)

ResourceLocationDataContractResponse

data class ResourceLocationDataContractResponse(val city: String? = null, val countryOrRegion: String? = null, val district: String? = null, val name: String)

Resource location data properties.

ResponseContractResponse

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

Operation response details.

SamplingSettingsResponse

data class SamplingSettingsResponse(val percentage: Double? = null, val samplingType: String? = null)

Sampling settings for Diagnostic.

SubscriptionKeyParameterNamesContractResponse

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

Subscription key parameter names details.

SystemDataResponse

data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

TokenBodyParameterContractResponse

data class TokenBodyParameterContractResponse(val name: String, val value: String)

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

UserIdentityContractResponse

data class UserIdentityContractResponse(val id: String? = null, val provider: String? = null)

User identity details.

UserIdentityPropertiesResponse

data class UserIdentityPropertiesResponse(val clientId: String? = null, val principalId: String? = null)

VirtualNetworkConfigurationResponse

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.

WikiDocumentationContractResponse

data class WikiDocumentationContractResponse(val documentationId: String? = null)

Wiki documentation details.

X509CertificateNameResponse

data class X509CertificateNameResponse(val issuerCertificateThumbprint: String? = null, val name: String? = null)

Properties of server X509Names.