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

Package-level declarations

Types

data class AbusePenaltyResponse(val action: String? = null, val expiration: String? = null, val rateLimitPercentage: Double? = null)

The abuse penalty.

AccountPropertiesResponse

data class AccountPropertiesResponse(val abusePenalty: AbusePenaltyResponse, val allowedFqdnList: List<String>? = null, val apiProperties: ApiPropertiesResponse? = null, val callRateLimit: CallRateLimitResponse, val capabilities: List<SkuCapabilityResponse>, val commitmentPlanAssociations: List<CommitmentPlanAssociationResponse>, val customSubDomainName: String? = null, val dateCreated: String, val deletionDate: String, val disableLocalAuth: Boolean? = null, val dynamicThrottlingEnabled: Boolean? = null, val encryption: EncryptionResponse? = null, val endpoint: String, val endpoints: Map<String, String>, val internalId: String, val isMigrated: Boolean, val locations: MultiRegionSettingsResponse? = null, val migrationToken: String? = null, val networkAcls: NetworkRuleSetResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val quotaLimit: QuotaLimitResponse, val restrictOutboundNetworkAccess: Boolean? = null, val scheduledPurgeDate: String, val skuChangeInfo: SkuChangeInfoResponse, val userOwnedStorage: List<UserOwnedStorageResponse>? = null)

Properties of Cognitive Services account.

ApiPropertiesResponse

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

CallRateLimitResponse

data class CallRateLimitResponse(val count: Double? = null, val renewalPeriod: Double? = null, val rules: List<ThrottlingRuleResponse>? = null)

The call rate limit Cognitive Services account.

CommitmentPeriodResponse

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.

CommitmentPlanAssociationResponse

data class CommitmentPlanAssociationResponse(val commitmentPlanId: String? = null, val commitmentPlanLocation: String? = null)

The commitment plan association.

CommitmentPlanPropertiesResponse

data class CommitmentPlanPropertiesResponse(val autoRenew: Boolean? = null, val commitmentPlanGuid: String? = null, val current: CommitmentPeriodResponse? = null, val hostingModel: String? = null, val last: CommitmentPeriodResponse, val next: CommitmentPeriodResponse? = null, val planType: String? = null, val provisioningIssues: List<String>, val provisioningState: String)

Properties of Cognitive Services account commitment plan.

CommitmentQuotaResponse

data class CommitmentQuotaResponse(val quantity: Double? = null, val unit: String? = null)

Cognitive Services account commitment quota.

DeploymentModelResponse

data class DeploymentModelResponse(val callRateLimit: CallRateLimitResponse, val format: String? = null, val name: String? = null, val source: String? = null, val version: String? = null)

Properties of Cognitive Services account deployment model.

DeploymentPropertiesResponse

data class DeploymentPropertiesResponse(val callRateLimit: CallRateLimitResponse, val capabilities: Map<String, String>, val model: DeploymentModelResponse? = null, val provisioningState: String, val raiPolicyName: String? = null, val rateLimits: List<ThrottlingRuleResponse>, val scaleSettings: DeploymentScaleSettingsResponse? = null, val versionUpgradeOption: String? = null)

Properties of Cognitive Services account deployment.

DeploymentScaleSettingsResponse

data class DeploymentScaleSettingsResponse(val activeCapacity: Int, val capacity: Int? = null, val scaleType: String? = null)

Properties of Cognitive Services account deployment model.

EncryptionResponse

data class EncryptionResponse(val keySource: String? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null)

Properties to configure Encryption

EncryptionScopePropertiesResponse

data class EncryptionScopePropertiesResponse(val keySource: String? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null, val provisioningState: String, val state: String? = null)

Properties to EncryptionScope

GetAccountResult

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: AccountPropertiesResponse, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.

GetCommitmentPlanAssociationResult

data class GetCommitmentPlanAssociationResult(val accountId: String? = null, val etag: String, val id: String, val name: String, val systemData: SystemDataResponse, val type: String)

The commitment plan association.

GetCommitmentPlanResult

data class GetCommitmentPlanResult(val etag: String, val id: String, val kind: String? = null, val location: String? = null, val name: String, val properties: CommitmentPlanPropertiesResponse, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Cognitive Services account commitment plan.

GetDeploymentResult

data class GetDeploymentResult(val etag: String, val id: String, val name: String, val properties: DeploymentPropertiesResponse, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val type: String)

Cognitive Services account deployment.

GetEncryptionScopeResult

data class GetEncryptionScopeResult(val etag: String, val id: String, val name: String, val properties: EncryptionScopePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Cognitive Services EncryptionScope

GetPrivateEndpointConnectionResult

data class GetPrivateEndpointConnectionResult(val etag: String, val id: String, val location: String? = null, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val systemData: SystemDataResponse, val type: String)

The Private Endpoint Connection resource.

GetRaiBlocklistItemResult

data class GetRaiBlocklistItemResult(val etag: String, val id: String, val name: String, val properties: RaiBlocklistItemPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Cognitive Services RaiBlocklist Item.

GetRaiBlocklistResult

data class GetRaiBlocklistResult(val etag: String, val id: String, val name: String, val properties: RaiBlocklistPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Cognitive Services RaiBlocklist.

GetRaiPolicyResult

data class GetRaiPolicyResult(val etag: String, val id: String, val name: String, val properties: RaiPolicyPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Cognitive Services RaiPolicy.

GetSharedCommitmentPlanResult

data class GetSharedCommitmentPlanResult(val etag: String, val id: String, val kind: String? = null, val location: String? = null, val name: String, val properties: CommitmentPlanPropertiesResponse, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Cognitive Services account commitment plan.

IdentityResponse

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

Identity for the resource.

IpRuleResponse

data class IpRuleResponse(val value: String)

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

KeyVaultPropertiesResponse

data class KeyVaultPropertiesResponse(val identityClientId: String? = null, val keyName: String? = null, val keyVaultUri: String? = null, val keyVersion: String? = null)

Properties to configure keyVault Properties

ListAccountKeysResult

data class ListAccountKeysResult(val key1: String? = null, val key2: String? = null)

The access keys for the cognitive services account.

MultiRegionSettingsResponse

data class MultiRegionSettingsResponse(val regions: List<RegionSettingResponse>? = null, val routingMethod: String? = null)

The multiregion settings Cognitive Services account.

NetworkRuleSetResponse

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.

PrivateEndpointConnectionPropertiesResponse

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

Properties of the PrivateEndpointConnectProperties.

PrivateEndpointConnectionResponse

data class PrivateEndpointConnectionResponse(val etag: String, val id: String, val location: String? = null, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse? = null, val systemData: SystemDataResponse, val type: String)

The Private Endpoint Connection resource.

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.

QuotaLimitResponse

data class QuotaLimitResponse(val count: Double? = null, val renewalPeriod: Double? = null, val rules: List<ThrottlingRuleResponse>? = null)

RaiBlocklistConfigResponse

data class RaiBlocklistConfigResponse(val blocking: Boolean? = null, val blocklistName: String? = null)

Azure OpenAI blocklist config.

RaiBlocklistItemPropertiesResponse

data class RaiBlocklistItemPropertiesResponse(val isRegex: Boolean? = null, val pattern: String? = null)

RAI Custom Blocklist Item properties.

RaiBlocklistPropertiesResponse

data class RaiBlocklistPropertiesResponse(val description: String? = null)

RAI Custom Blocklist properties.

RaiPolicyContentFilterResponse

data class RaiPolicyContentFilterResponse(val allowedContentLevel: String? = null, val blocking: Boolean? = null, val enabled: Boolean? = null, val name: String? = null, val source: String? = null)

Azure OpenAI Content Filter.

RaiPolicyPropertiesResponse

data class RaiPolicyPropertiesResponse(val basePolicyName: String? = null, val completionBlocklists: List<RaiBlocklistConfigResponse>? = null, val contentFilters: List<RaiPolicyContentFilterResponse>? = null, val mode: String? = null, val policyType: String, val promptBlocklists: List<RaiBlocklistConfigResponse>? = null)

Azure OpenAI Content Filters properties.

RegionSettingResponse

data class RegionSettingResponse(val customsubdomain: String? = null, val name: String? = null, val value: Double? = null)

The call rate limit Cognitive Services account.

RequestMatchPatternResponse

data class RequestMatchPatternResponse(val method: String? = null, val path: String? = null)

SkuCapabilityResponse

data class SkuCapabilityResponse(val name: String? = null, val value: String? = null)

SkuCapability indicates the capability of a certain feature.

SkuChangeInfoResponse

data class SkuChangeInfoResponse(val countOfDowngrades: Double? = null, val countOfUpgradesAfterDowngrades: Double? = null, val lastChangeDate: String? = null)

Sku change info of account.

SkuResponse

data class SkuResponse(val capacity: Int? = null, val family: String? = null, val name: String, val size: String? = null, val tier: String? = null)

The resource model definition representing SKU

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.

ThrottlingRuleResponse

data class ThrottlingRuleResponse(val count: Double? = null, val dynamicThrottlingEnabled: Boolean? = null, val key: String? = null, val matchPatterns: List<RequestMatchPatternResponse>? = null, val minCount: Double? = null, val renewalPeriod: Double? = null)

UserAssignedIdentityResponse

data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User-assigned managed identity.

UserOwnedStorageResponse

data class UserOwnedStorageResponse(val identityClientId: String? = null, val resourceId: String? = null)

The user owned storage for Cognitive Services account.

VirtualNetworkRuleResponse

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

A rule governing the accessibility from a specific virtual network.