Package-level declarations

Types

data class CognitiveServicesAccountApiPropertiesResponse(val aadClientId: String? = null, val aadTenantId: String? = null, val eventHubConnectionString: String? = null, val qnaAzureSearchEndpointId: String? = null, val qnaAzureSearchEndpointKey: String? = null, val qnaRuntimeEndpoint: String? = null, val statisticsEnabled: Boolean? = null, val storageAccountConnectionString: String? = null, val superUser: String? = null, val websiteName: String? = null)

The api properties for special APIs.

data class CognitiveServicesAccountPropertiesResponse(val apiProperties: CognitiveServicesAccountApiPropertiesResponse? = null, val capabilities: List<SkuCapabilityResponse>, val customSubDomainName: String? = null, val dateCreated: String, val encryption: EncryptionResponse? = null, val endpoint: String, val internalId: String, val isMigrated: Boolean, val networkAcls: NetworkRuleSetResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null, val provisioningState: String, val publicNetworkAccess: String? = null, val skuChangeInfo: CognitiveServicesAccountSkuChangeInfoResponse, val userOwnedStorage: List<UserOwnedStorageResponse>? = null)

Properties of Cognitive Services account.

data class CognitiveServicesAccountSkuChangeInfoResponse(val countOfDowngrades: Double, val countOfUpgradesAfterDowngrades: Double, val lastChangeDate: String)

Sku change info of account.

Link copied to clipboard
data class CommitmentPeriodResponse(val count: Int? = null, val endDate: String, val quota: CommitmentQuotaResponse, val startDate: String, val tier: String? = null)

Cognitive Services account commitment period.

Link copied to clipboard
data class CommitmentPlanPropertiesResponse(val autoRenew: Boolean? = null, val current: CommitmentPeriodResponse? = null, val hostingModel: String? = null, val last: CommitmentPeriodResponse, val next: CommitmentPeriodResponse? = null, val planType: String? = null)

Properties of Cognitive Services account commitment plan.

Link copied to clipboard
data class CommitmentQuotaResponse(val quantity: Double? = null, val unit: String? = null)

Cognitive Services account commitment quota.

Link copied to clipboard
data class DeploymentModelResponse(val format: String? = null, val name: String? = null, val version: String? = null)

Properties of Cognitive Services account deployment model.

Link copied to clipboard
data class DeploymentPropertiesResponse(val model: DeploymentModelResponse? = null, val provisioningState: String, val scaleSettings: DeploymentScaleSettingsResponse? = null)

Properties of Cognitive Services account deployment.

Link copied to clipboard
data class DeploymentScaleSettingsResponse(val capacity: Int? = null, val scaleType: String? = null)

Properties of Cognitive Services account deployment model.

Link copied to clipboard
data class EncryptionResponse(val keySource: String? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null)

Properties to configure Encryption

Link copied to clipboard
data class GetAccountResult(val etag: String, val id: String, val identity: IdentityResponse? = null, val kind: String? = null, val location: String? = null, val name: String, val properties: CognitiveServicesAccountPropertiesResponse, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String)

Cognitive Services Account is an Azure resource representing the provisioned account, its type, location and SKU.

Link copied to clipboard
data class GetCommitmentPlanResult(val etag: String, val id: String, val name: String, val properties: CommitmentPlanPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Cognitive Services account commitment plan.

Link copied to clipboard
data class GetDeploymentResult(val etag: String, val id: String, val name: String, val properties: DeploymentPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Cognitive Services account deployment.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val etag: String, val id: String, val location: String? = null, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val type: String)

The Private Endpoint Connection resource.

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

Managed service identity.

Link copied to clipboard
data class IpRuleResponse(val value: String)

A rule governing the accessibility from a specific ip address or ip range.

Link copied to clipboard
data class KeyVaultPropertiesResponse(val keyName: String? = null, val keyVaultUri: String? = null, val keyVersion: String? = null)

Properties to configure keyVault Properties

Link copied to clipboard
data class ListAccountKeysResult(val key1: String? = null, val key2: String? = null)

The access keys for the cognitive services account.

Link copied to clipboard
data class NetworkRuleSetResponse(val defaultAction: String? = null, val ipRules: List<IpRuleResponse>? = null, val virtualNetworkRules: List<VirtualNetworkRuleResponse>? = null)

A set of rules governing the network accessibility.

data class PrivateEndpointConnectionPropertiesResponse(val groupIds: List<String>? = null, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse)

Properties of the PrivateEndpointConnectProperties.

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val etag: String, val id: String, val location: String? = null, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse? = null, val type: String)

The Private Endpoint Connection resource.

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 SkuCapabilityResponse(val name: String? = null, val value: String? = null)

SkuCapability indicates the capability of a certain feature.

Link copied to clipboard
data class SkuResponse(val name: String, val tier: String)

The SKU of the cognitive services account.

Link copied to clipboard
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.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String? = null, val principalId: String? = null)

User-assigned managed identity.

Link copied to clipboard
data class UserOwnedStorageResponse(val resourceId: String? = null)

The user owned storage for Cognitive Services account.

Link copied to clipboard
data class VirtualNetworkRuleResponse(val id: String, val ignoreMissingVnetServiceEndpoint: Boolean? = null, val state: String? = null)

A rule governing the accessibility from a specific virtual network.