cognitiveservices.azure.com/v1api20250601
Account
Generator information: - Generated from: /cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/cognitiveservices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
Used by: AccountList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Account_Spec Optional |
|
| status | Account_STATUS Optional |
Account_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| identity | Identity for the resource. | Identity Optional |
| kind | The Kind of the resource. | string Optional |
| location | The geo-location where the resource lives | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | AccountOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties | Properties of Cognitive Services account. | AccountProperties Optional |
| sku | The resource model definition representing SKU | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
Account_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| etag | Resource Etag. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Identity for the resource. | Identity_STATUS Optional |
| kind | The Kind of the resource. | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| properties | Properties of Cognitive Services account. | AccountProperties_STATUS Optional |
| sku | The resource model definition representing SKU | Sku_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
AccountList
Generator information: - Generated from: /cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/cognitiveservices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Account[] Optional |
APIVersion
| Value | Description |
|---|---|
| “2025-06-01” |
Deployment
Generator information: - Generated from: /cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/cognitiveservices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
Used by: DeploymentList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Deployment_Spec Optional |
|
| status | Deployment_STATUS Optional |
Deployment_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DeploymentOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cognitiveservices.azure.com/Account resource | genruntime.KnownResourceReference Required |
| properties | Properties of Cognitive Services account deployment. | DeploymentProperties Optional |
| sku | The resource model definition representing SKU | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
Deployment_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| etag | Resource Etag. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| name | The name of the resource | string Optional |
| properties | Properties of Cognitive Services account deployment. | DeploymentProperties_STATUS Optional |
| sku | The resource model definition representing SKU | Sku_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
DeploymentList
Generator information: - Generated from: /cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/cognitiveservices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Deployment[] Optional |
Account_Spec
Used by: Account.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| identity | Identity for the resource. | Identity Optional |
| kind | The Kind of the resource. | string Optional |
| location | The geo-location where the resource lives | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | AccountOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties | Properties of Cognitive Services account. | AccountProperties Optional |
| sku | The resource model definition representing SKU | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
Account_STATUS
Cognitive Services account is an Azure resource representing the provisioned account, it’s type, location and SKU.
Used by: Account.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| etag | Resource Etag. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Identity for the resource. | Identity_STATUS Optional |
| kind | The Kind of the resource. | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| properties | Properties of Cognitive Services account. | AccountProperties_STATUS Optional |
| sku | The resource model definition representing SKU | Sku_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
Deployment_Spec
Used by: Deployment.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DeploymentOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cognitiveservices.azure.com/Account resource | genruntime.KnownResourceReference Required |
| properties | Properties of Cognitive Services account deployment. | DeploymentProperties Optional |
| sku | The resource model definition representing SKU | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
Deployment_STATUS
Used by: Deployment.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| etag | Resource Etag. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| name | The name of the resource | string Optional |
| properties | Properties of Cognitive Services account deployment. | DeploymentProperties_STATUS Optional |
| sku | The resource model definition representing SKU | Sku_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
AccountOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Account_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | AccountOperatorSecrets Optional |
AccountProperties
Properties of Cognitive Services account.
Used by: Account_Spec.
| Property | Description | Type |
|---|---|---|
| allowedFqdnList | string[] Optional |
|
| allowProjectManagement | Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. | bool Optional |
| amlWorkspace | The user owned AML account properties. | UserOwnedAmlWorkspace Optional |
| apiProperties | The api properties for special APIs. | ApiProperties Optional |
| associatedProjects | Specifies the projects, by project name, that are associated with this resource. | string[] Optional |
| customSubDomainName | Optional subdomain name used for token-based authentication. | string Optional |
| defaultProject | Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. | string Optional |
| disableLocalAuth | bool Optional |
|
| dynamicThrottlingEnabled | The flag to enable dynamic throttling. | bool Optional |
| encryption | The encryption properties for this resource. | Encryption Optional |
| locations | The multiregion settings of Cognitive Services account. | MultiRegionSettings Optional |
| migrationToken | Resource migration token. | genruntime.SecretReference Optional |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet Optional |
| networkInjections | Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user’s private network, eliminating public internet exposure while maintaining control over network configurations and resources. | NetworkInjections Optional |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this account. | AccountProperties_PublicNetworkAccess Optional |
| raiMonitorConfig | Cognitive Services Rai Monitor Config. | RaiMonitorConfig Optional |
| restore | bool Optional |
|
| restrictOutboundNetworkAccess | bool Optional |
|
| userOwnedStorage | The storage accounts for this resource. | UserOwnedStorage[] Optional |
AccountProperties_STATUS
Properties of Cognitive Services account.
Used by: Account_STATUS.
| Property | Description | Type |
|---|---|---|
| abusePenalty | The abuse penalty. | AbusePenalty_STATUS Optional |
| allowedFqdnList | string[] Optional |
|
| allowProjectManagement | Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. | bool Optional |
| amlWorkspace | The user owned AML account properties. | UserOwnedAmlWorkspace_STATUS Optional |
| apiProperties | The api properties for special APIs. | ApiProperties_STATUS Optional |
| associatedProjects | Specifies the projects, by project name, that are associated with this resource. | string[] Optional |
| callRateLimit | The call rate limit Cognitive Services account. | CallRateLimit_STATUS Optional |
| capabilities | Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only. | SkuCapability_STATUS[] Optional |
| commitmentPlanAssociations | The commitment plan associations of Cognitive Services account. | CommitmentPlanAssociation_STATUS[] Optional |
| customSubDomainName | Optional subdomain name used for token-based authentication. | string Optional |
| dateCreated | Gets the date of cognitive services account creation. | string Optional |
| defaultProject | Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. | string Optional |
| deletionDate | The deletion date, only available for deleted account. | string Optional |
| disableLocalAuth | bool Optional |
|
| dynamicThrottlingEnabled | The flag to enable dynamic throttling. | bool Optional |
| encryption | The encryption properties for this resource. | Encryption_STATUS Optional |
| endpoint | Endpoint of the created account. | string Optional |
| endpoints | map[string]string Optional |
|
| internalId | The internal identifier (deprecated, do not use this property). | string Optional |
| isMigrated | If the resource is migrated from an existing key. | bool Optional |
| locations | The multiregion settings of Cognitive Services account. | MultiRegionSettings_STATUS Optional |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet_STATUS Optional |
| networkInjections | Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user’s private network, eliminating public internet exposure while maintaining control over network configurations and resources. | NetworkInjections_STATUS Optional |
| privateEndpointConnections | The private endpoint connection associated with the Cognitive Services account. | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Gets the status of the cognitive services account at the time the operation was called. | AccountProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this account. | AccountProperties_PublicNetworkAccess_STATUS Optional |
| quotaLimit | QuotaLimit_STATUS Optional |
|
| raiMonitorConfig | Cognitive Services Rai Monitor Config. | RaiMonitorConfig_STATUS Optional |
| restore | bool Optional |
|
| restrictOutboundNetworkAccess | bool Optional |
|
| scheduledPurgeDate | The scheduled purge date, only available for deleted account. | string Optional |
| skuChangeInfo | Sku change info of account. | SkuChangeInfo_STATUS Optional |
| userOwnedStorage | The storage accounts for this resource. | UserOwnedStorage_STATUS[] Optional |
DeploymentOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Deployment_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
DeploymentProperties
Properties of Cognitive Services account deployment.
Used by: Deployment_Spec.
| Property | Description | Type |
|---|---|---|
| capacitySettings | Internal use only. | DeploymentCapacitySettings Optional |
| model | Properties of Cognitive Services account deployment model. | DeploymentModel Optional |
| parentDeploymentName | The name of parent deployment. | string Optional |
| raiPolicyName | The name of RAI policy. | string Optional |
| scaleSettings | Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) | DeploymentScaleSettings Optional |
| spilloverDeploymentName | Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. | string Optional |
| versionUpgradeOption | Deployment model version upgrade option. | DeploymentProperties_VersionUpgradeOption Optional |
DeploymentProperties_STATUS
Properties of Cognitive Services account deployment.
Used by: Deployment_STATUS.
| Property | Description | Type |
|---|---|---|
| callRateLimit | The call rate limit Cognitive Services account. | CallRateLimit_STATUS Optional |
| capabilities | The capabilities. | map[string]string Optional |
| capacitySettings | Internal use only. | DeploymentCapacitySettings_STATUS Optional |
| currentCapacity | The current capacity. | int Optional |
| dynamicThrottlingEnabled | If the dynamic throttling is enabled. | bool Optional |
| model | Properties of Cognitive Services account deployment model. | DeploymentModel_STATUS Optional |
| parentDeploymentName | The name of parent deployment. | string Optional |
| provisioningState | Gets the status of the resource at the time the operation was called. | DeploymentProperties_ProvisioningState_STATUS Optional |
| raiPolicyName | The name of RAI policy. | string Optional |
| rateLimits | ThrottlingRule_STATUS[] Optional |
|
| scaleSettings | Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) | DeploymentScaleSettings_STATUS Optional |
| spilloverDeploymentName | Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. | string Optional |
| versionUpgradeOption | Deployment model version upgrade option. | DeploymentProperties_VersionUpgradeOption_STATUS Optional |
Identity
Identity for the resource.
Used by: Account_Spec.
| Property | Description | Type |
|---|---|---|
| type | The identity type. | Identity_Type Optional |
| userAssignedIdentities | The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} | UserAssignedIdentityDetails[] Optional |
Identity_STATUS
Identity for the resource.
Used by: Account_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal ID of resource identity. | string Optional |
| tenantId | The tenant ID of resource. | string Optional |
| type | The identity type. | Identity_Type_STATUS Optional |
| userAssignedIdentities | The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} | map[string]UserAssignedIdentity_STATUS Optional |
Sku
The resource model definition representing SKU
Used by: Account_Spec, and Deployment_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int Optional |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string Optional |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string Required |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string Optional |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | Sku_Tier Optional |
Sku_STATUS
The resource model definition representing SKU
Used by: Account_STATUS, and Deployment_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int Optional |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string Optional |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string Optional |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string Optional |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | Sku_Tier_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Account_STATUS, and Deployment_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
AbusePenalty_STATUS
The abuse penalty.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| action | The action of AbusePenalty. | AbusePenalty_Action_STATUS Optional |
| expiration | The datetime of expiration of the AbusePenalty. | string Optional |
| rateLimitPercentage | The percentage of rate limit. | float64 Optional |
AccountOperatorSecrets
Used by: AccountOperatorSpec.
| Property | Description | Type |
|---|---|---|
| key1 | indicates where the Key1 secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| key2 | indicates where the Key2 secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
AccountProperties_ProvisioningState_STATUS
Used by: AccountProperties_STATUS.
| Value | Description |
|---|---|
| “Accepted” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Moving” | |
| “ResolvingDNS” | |
| “Succeeded” |
AccountProperties_PublicNetworkAccess
Used by: AccountProperties.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
AccountProperties_PublicNetworkAccess_STATUS
Used by: AccountProperties_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ApiProperties
The api properties for special APIs.
Used by: AccountProperties.
| Property | Description | Type |
|---|---|---|
| aadClientId | (Metrics Advisor Only) The Azure AD Client Id (Application Id). | string Optional |
| aadClientIdFromConfig | (Metrics Advisor Only) The Azure AD Client Id (Application Id). | genruntime.ConfigMapReference Optional |
| aadTenantId | (Metrics Advisor Only) The Azure AD Tenant Id. | string Optional |
| aadTenantIdFromConfig | (Metrics Advisor Only) The Azure AD Tenant Id. | genruntime.ConfigMapReference Optional |
| additionalProperties | map[string]v1.JSON Optional |
|
| eventHubConnectionString | (Personalization Only) The flag to enable statistics of Bing Search. | genruntime.SecretReference Optional |
| qnaAzureSearchEndpointId | (QnAMaker Only) The Azure Search endpoint id of QnAMaker. | string Optional |
| qnaAzureSearchEndpointIdFromConfig | (QnAMaker Only) The Azure Search endpoint id of QnAMaker. | genruntime.ConfigMapReference Optional |
| qnaAzureSearchEndpointKey | (QnAMaker Only) The Azure Search endpoint key of QnAMaker. | genruntime.SecretReference Optional |
| qnaRuntimeEndpoint | (QnAMaker Only) The runtime endpoint of QnAMaker. | string Optional |
| qnaRuntimeEndpointFromConfig | (QnAMaker Only) The runtime endpoint of QnAMaker. | genruntime.ConfigMapReference Optional |
| statisticsEnabled | (Bing Search Only) The flag to enable statistics of Bing Search. | bool Optional |
| storageAccountConnectionString | (Personalization Only) The storage account connection string. | genruntime.SecretReference Optional |
| superUser | (Metrics Advisor Only) The super user of Metrics Advisor. | string Optional |
| superUserFromConfig | (Metrics Advisor Only) The super user of Metrics Advisor. | genruntime.ConfigMapReference Optional |
| websiteName | (Metrics Advisor Only) The website name of Metrics Advisor. | string Optional |
| websiteNameFromConfig | (Metrics Advisor Only) The website name of Metrics Advisor. | genruntime.ConfigMapReference Optional |
ApiProperties_STATUS
The api properties for special APIs.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| aadClientId | (Metrics Advisor Only) The Azure AD Client Id (Application Id). | string Optional |
| aadTenantId | (Metrics Advisor Only) The Azure AD Tenant Id. | string Optional |
| additionalProperties | map[string]v1.JSON Optional |
|
| qnaAzureSearchEndpointId | (QnAMaker Only) The Azure Search endpoint id of QnAMaker. | string Optional |
| qnaRuntimeEndpoint | (QnAMaker Only) The runtime endpoint of QnAMaker. | string Optional |
| statisticsEnabled | (Bing Search Only) The flag to enable statistics of Bing Search. | bool Optional |
| superUser | (Metrics Advisor Only) The super user of Metrics Advisor. | string Optional |
| websiteName | (Metrics Advisor Only) The website name of Metrics Advisor. | string Optional |
CallRateLimit_STATUS
The call rate limit Cognitive Services account.
Used by: AccountProperties_STATUS, DeploymentModel_STATUS, and DeploymentProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| count | The count value of Call Rate Limit. | float64 Optional |
| renewalPeriod | The renewal period in seconds of Call Rate Limit. | float64 Optional |
| rules | ThrottlingRule_STATUS[] Optional |
CommitmentPlanAssociation_STATUS
The commitment plan association.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| commitmentPlanId | The Azure resource id of the commitment plan. | string Optional |
| commitmentPlanLocation | The location of of the commitment plan. | string Optional |
DeploymentCapacitySettings
Internal use only.
Used by: DeploymentProperties.
| Property | Description | Type |
|---|---|---|
| designatedCapacity | The designated capacity. | int Optional |
| priority | The priority of this capacity setting. | int Optional |
DeploymentCapacitySettings_STATUS
Internal use only.
Used by: DeploymentProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| designatedCapacity | The designated capacity. | int Optional |
| priority | The priority of this capacity setting. | int Optional |
DeploymentModel
Properties of Cognitive Services account deployment model.
Used by: DeploymentProperties.
| Property | Description | Type |
|---|---|---|
| format | Deployment model format. | string Optional |
| formatFromConfig | Deployment model format. | genruntime.ConfigMapReference Optional |
| name | Deployment model name. | string Optional |
| nameFromConfig | Deployment model name. | genruntime.ConfigMapReference Optional |
| publisher | Deployment model publisher. | string Optional |
| publisherFromConfig | Deployment model publisher. | genruntime.ConfigMapReference Optional |
| sourceAccountReference | Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. | genruntime.ResourceReference Optional |
| sourceReference | Optional. Deployment model source ARM resource ID. | genruntime.ResourceReference Optional |
| version | Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. | string Optional |
| versionFromConfig | Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. | genruntime.ConfigMapReference Optional |
DeploymentModel_STATUS
Properties of Cognitive Services account deployment model.
Used by: DeploymentProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| callRateLimit | The call rate limit Cognitive Services account. | CallRateLimit_STATUS Optional |
| format | Deployment model format. | string Optional |
| name | Deployment model name. | string Optional |
| publisher | Deployment model publisher. | string Optional |
| source | Optional. Deployment model source ARM resource ID. | string Optional |
| sourceAccount | Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. | string Optional |
| version | Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. | string Optional |
DeploymentProperties_ProvisioningState_STATUS
Used by: DeploymentProperties_STATUS.
| Value | Description |
|---|---|
| “Accepted” | |
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Disabled” | |
| “Failed” | |
| “Moving” | |
| “Succeeded” |
DeploymentProperties_VersionUpgradeOption
Used by: DeploymentProperties.
| Value | Description |
|---|---|
| “NoAutoUpgrade” | |
| “OnceCurrentVersionExpired” | |
| “OnceNewDefaultVersionAvailable” |
DeploymentProperties_VersionUpgradeOption_STATUS
Used by: DeploymentProperties_STATUS.
| Value | Description |
|---|---|
| “NoAutoUpgrade” | |
| “OnceCurrentVersionExpired” | |
| “OnceNewDefaultVersionAvailable” |
DeploymentScaleSettings
Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)
Used by: DeploymentProperties.
| Property | Description | Type |
|---|---|---|
| capacity | Deployment capacity. | int Optional |
| scaleType | Deployment scale type. | DeploymentScaleSettings_ScaleType Optional |
DeploymentScaleSettings_STATUS
Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)
Used by: DeploymentProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| activeCapacity | Deployment active capacity. This value might be different from capacity if customer recently updated capacity. |
int Optional |
| capacity | Deployment capacity. | int Optional |
| scaleType | Deployment scale type. | DeploymentScaleSettings_ScaleType_STATUS Optional |
Encryption
Properties to configure Encryption
Used by: AccountProperties.
| Property | Description | Type |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | Encryption_KeySource Optional |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties Optional |
Encryption_STATUS
Properties to configure Encryption
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | Encryption_KeySource_STATUS Optional |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties_STATUS Optional |
Identity_Type
Used by: Identity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
Identity_Type_STATUS
Used by: Identity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
MultiRegionSettings
The multiregion settings Cognitive Services account.
Used by: AccountProperties.
| Property | Description | Type |
|---|---|---|
| regions | RegionSetting[] Optional |
|
| routingMethod | Multiregion routing methods. | MultiRegionSettings_RoutingMethod Optional |
MultiRegionSettings_STATUS
The multiregion settings Cognitive Services account.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| regions | RegionSetting_STATUS[] Optional |
|
| routingMethod | Multiregion routing methods. | MultiRegionSettings_RoutingMethod_STATUS Optional |
NetworkInjections
Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user’s private network, eliminating public internet exposure while maintaining control over network configurations and resources.
Used by: AccountProperties.
| Property | Description | Type |
|---|---|---|
| scenario | Specifies what features in AI Foundry network injection applies to. Currently only supports agent for agent scenarios. none means no network injection. |
NetworkInjections_Scenario Optional |
| subnetArmReference | Specify the subnet for which your Agent Client is injected into. | genruntime.ResourceReference Optional |
| useMicrosoftManagedNetwork | Boolean to enable Microsoft Managed Network for subnet delegation | bool Optional |
NetworkInjections_STATUS
Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user’s private network, eliminating public internet exposure while maintaining control over network configurations and resources.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| scenario | Specifies what features in AI Foundry network injection applies to. Currently only supports agent for agent scenarios. none means no network injection. |
NetworkInjections_Scenario_STATUS Optional |
| subnetArmId | Specify the subnet for which your Agent Client is injected into. | string Optional |
| useMicrosoftManagedNetwork | Boolean to enable Microsoft Managed Network for subnet delegation | bool Optional |
NetworkRuleSet
A set of rules governing the network accessibility.
Used by: AccountProperties.
| Property | Description | Type |
|---|---|---|
| bypass | Setting for trusted services. | NetworkRuleSet_Bypass Optional |
| defaultAction | The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. | NetworkRuleSet_DefaultAction Optional |
| ipRules | The list of IP address rules. | IpRule[] Optional |
| virtualNetworkRules | The list of virtual network rules. | VirtualNetworkRule[] Optional |
NetworkRuleSet_STATUS
A set of rules governing the network accessibility.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| bypass | Setting for trusted services. | NetworkRuleSet_Bypass_STATUS Optional |
| defaultAction | The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. | NetworkRuleSet_DefaultAction_STATUS Optional |
| ipRules | The list of IP address rules. | IpRule_STATUS[] Optional |
| virtualNetworkRules | The list of virtual network rules. | VirtualNetworkRule_STATUS[] Optional |
PrivateEndpointConnection_STATUS
The Private Endpoint Connection resource.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
QuotaLimit_STATUS
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| count | float64 Optional |
|
| renewalPeriod | float64 Optional |
|
| rules | ThrottlingRule_STATUS[] Optional |
RaiMonitorConfig
Cognitive Services Rai Monitor Config.
Used by: AccountProperties.
| Property | Description | Type |
|---|---|---|
| adxStorageResourceReference | The storage resource Id. | genruntime.ResourceReference Optional |
| identityClientId | The identity client Id to access the storage. | string Optional |
RaiMonitorConfig_STATUS
Cognitive Services Rai Monitor Config.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| adxStorageResourceId | The storage resource Id. | string Optional |
| identityClientId | The identity client Id to access the storage. | string Optional |
Sku_Tier
Used by: Sku.
| Value | Description |
|---|---|
| “Basic” | |
| “Enterprise” | |
| “Free” | |
| “Premium” | |
| “Standard” |
Sku_Tier_STATUS
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Enterprise” | |
| “Free” | |
| “Premium” | |
| “Standard” |
SkuCapability_STATUS
SkuCapability indicates the capability of a certain feature.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| name | The name of the SkuCapability. | string Optional |
| value | The value of the SkuCapability. | string Optional |
SkuChangeInfo_STATUS
Sku change info of account.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| countOfDowngrades | Gets the count of downgrades. | float64 Optional |
| countOfUpgradesAfterDowngrades | Gets the count of upgrades after downgrades. | float64 Optional |
| lastChangeDate | Gets the last change date. | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
ThrottlingRule_STATUS
Used by: CallRateLimit_STATUS, DeploymentProperties_STATUS, and QuotaLimit_STATUS.
| Property | Description | Type |
|---|---|---|
| count | float64 Optional |
|
| dynamicThrottlingEnabled | bool Optional |
|
| key | string Optional |
|
| matchPatterns | RequestMatchPattern_STATUS[] Optional |
|
| minCount | float64 Optional |
|
| renewalPeriod | float64 Optional |
UserAssignedIdentity_STATUS
User-assigned managed identity.
Used by: Identity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | Client App Id associated with this identity. | string Optional |
| principalId | Azure Active Directory principal ID associated with this Identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: Identity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
UserOwnedAmlWorkspace
The user owned AML account for Cognitive Services account.
Used by: AccountProperties.
| Property | Description | Type |
|---|---|---|
| identityClientId | Identity Client id of a AML account resource. | string Optional |
| resourceReference | Full resource id of a AML account resource. | genruntime.ResourceReference Optional |
UserOwnedAmlWorkspace_STATUS
The user owned AML account for Cognitive Services account.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| identityClientId | Identity Client id of a AML account resource. | string Optional |
| resourceId | Full resource id of a AML account resource. | string Optional |
UserOwnedStorage
The user owned storage for Cognitive Services account.
Used by: AccountProperties.
| Property | Description | Type |
|---|---|---|
| identityClientId | string Optional |
|
| resourceReference | Full resource id of a Microsoft.Storage resource. | genruntime.ResourceReference Optional |
UserOwnedStorage_STATUS
The user owned storage for Cognitive Services account.
Used by: AccountProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| identityClientId | string Optional |
|
| resourceId | Full resource id of a Microsoft.Storage resource. | string Optional |
AbusePenalty_Action_STATUS
Used by: AbusePenalty_STATUS.
| Value | Description |
|---|---|
| “Block” | |
| “Throttle” |
DeploymentScaleSettings_ScaleType
Used by: DeploymentScaleSettings.
| Value | Description |
|---|---|
| “Manual” | |
| “Standard” |
DeploymentScaleSettings_ScaleType_STATUS
Used by: DeploymentScaleSettings_STATUS.
| Value | Description |
|---|---|
| “Manual” | |
| “Standard” |
Encryption_KeySource
Used by: Encryption.
| Value | Description |
|---|---|
| “Microsoft.CognitiveServices” | |
| “Microsoft.KeyVault” |
Encryption_KeySource_STATUS
Used by: Encryption_STATUS.
| Value | Description |
|---|---|
| “Microsoft.CognitiveServices” | |
| “Microsoft.KeyVault” |
IpRule
A rule governing the accessibility from a specific ip address or ip range.
Used by: NetworkRuleSet.
| Property | Description | Type |
|---|---|---|
| value | An IPv4 address range in CIDR notation, such as 124.56.78.91 (simple IP address) or ‘124.56.78.0/24’ (all addresses that start with 124.56.78). |
string Required |
IpRule_STATUS
A rule governing the accessibility from a specific ip address or ip range.
Used by: NetworkRuleSet_STATUS.
| Property | Description | Type |
|---|---|---|
| value | An IPv4 address range in CIDR notation, such as 124.56.78.91 (simple IP address) or ‘124.56.78.0/24’ (all addresses that start with 124.56.78). |
string Optional |
KeyVaultProperties
Properties to configure keyVault Properties
Used by: Encryption.
| Property | Description | Type |
|---|---|---|
| identityClientId | string Optional |
|
| keyName | Name of the Key from KeyVault | string Optional |
| keyVaultUri | Uri of KeyVault | string Optional |
| keyVersion | Version of the Key from KeyVault | string Optional |
KeyVaultProperties_STATUS
Properties to configure keyVault Properties
Used by: Encryption_STATUS.
| Property | Description | Type |
|---|---|---|
| identityClientId | string Optional |
|
| keyName | Name of the Key from KeyVault | string Optional |
| keyVaultUri | Uri of KeyVault | string Optional |
| keyVersion | Version of the Key from KeyVault | string Optional |
MultiRegionSettings_RoutingMethod
Used by: MultiRegionSettings.
| Value | Description |
|---|---|
| “Performance” | |
| “Priority” | |
| “Weighted” |
MultiRegionSettings_RoutingMethod_STATUS
Used by: MultiRegionSettings_STATUS.
| Value | Description |
|---|---|
| “Performance” | |
| “Priority” | |
| “Weighted” |
NetworkInjections_Scenario
Used by: NetworkInjections.
| Value | Description |
|---|---|
| “agent” | |
| “none” |
NetworkInjections_Scenario_STATUS
Used by: NetworkInjections_STATUS.
| Value | Description |
|---|---|
| “agent” | |
| “none” |
NetworkRuleSet_Bypass
Used by: NetworkRuleSet.
| Value | Description |
|---|---|
| “AzureServices” | |
| “None” |
NetworkRuleSet_Bypass_STATUS
Used by: NetworkRuleSet_STATUS.
| Value | Description |
|---|---|
| “AzureServices” | |
| “None” |
NetworkRuleSet_DefaultAction
Used by: NetworkRuleSet.
| Value | Description |
|---|---|
| “Allow” | |
| “Deny” |
NetworkRuleSet_DefaultAction_STATUS
Used by: NetworkRuleSet_STATUS.
| Value | Description |
|---|---|
| “Allow” | |
| “Deny” |
RegionSetting
The call rate limit Cognitive Services account.
Used by: MultiRegionSettings.
| Property | Description | Type |
|---|---|---|
| customsubdomain | Maps the region to the regional custom subdomain. | string Optional |
| name | Name of the region. | string Optional |
| value | A value for priority or weighted routing methods. | float64 Optional |
RegionSetting_STATUS
The call rate limit Cognitive Services account.
Used by: MultiRegionSettings_STATUS.
| Property | Description | Type |
|---|---|---|
| customsubdomain | Maps the region to the regional custom subdomain. | string Optional |
| name | Name of the region. | string Optional |
| value | A value for priority or weighted routing methods. | float64 Optional |
RequestMatchPattern_STATUS
Used by: ThrottlingRule_STATUS.
| Property | Description | Type |
|---|---|---|
| method | string Optional |
|
| path | string Optional |
VirtualNetworkRule
A rule governing the accessibility from a specific virtual network.
Used by: NetworkRuleSet.
| Property | Description | Type |
|---|---|---|
| ignoreMissingVnetServiceEndpoint | Ignore missing vnet service endpoint or not. | bool Optional |
| reference | Full resource id of a vnet subnet, such as ‘/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1’. | genruntime.ResourceReference Required |
| state | Gets the state of virtual network rule. | string Optional |
VirtualNetworkRule_STATUS
A rule governing the accessibility from a specific virtual network.
Used by: NetworkRuleSet_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Full resource id of a vnet subnet, such as ‘/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1’. | string Optional |
| ignoreMissingVnetServiceEndpoint | Ignore missing vnet service endpoint or not. | bool Optional |
| state | Gets the state of virtual network rule. | string Optional |