Microsoft.CognitiveServices accounts 2017-04-18
Bicep resource definition
The accounts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CognitiveServices/accounts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.CognitiveServices/accounts@2017-04-18' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
apiProperties: {
aadClientId: 'string'
aadTenantId: 'string'
eventHubConnectionString: 'string'
qnaAzureSearchEndpointId: 'string'
qnaAzureSearchEndpointKey: 'string'
qnaRuntimeEndpoint: 'string'
statisticsEnabled: bool
storageAccountConnectionString: 'string'
superUser: 'string'
websiteName: 'string'
}
customSubDomainName: 'string'
encryption: {
keySource: 'string'
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
}
networkAcls: {
defaultAction: 'string'
ipRules: [
{
value: 'string'
}
]
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVnetServiceEndpoint: bool
state: 'string'
}
]
}
privateEndpointConnections: [
{
location: 'string'
properties: {
groupIds: [
'string'
]
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
userOwnedStorage: [
{
resourceId: 'string'
}
]
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
CognitiveServicesAccountApiProperties
| Name | Description | Value |
|---|---|---|
| aadClientId | (Metrics Advisor Only) The Azure AD Client Id (Application Id). | string Constraints: Max length = |
| aadTenantId | (Metrics Advisor Only) The Azure AD Tenant Id. | string Constraints: Max length = |
| eventHubConnectionString | (Personalization Only) The flag to enable statistics of Bing Search. | string Constraints: Max length = Pattern = ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$ |
| qnaAzureSearchEndpointId | (QnAMaker Only) The Azure Search endpoint id of QnAMaker. | string |
| qnaAzureSearchEndpointKey | (QnAMaker Only) The Azure Search endpoint key of QnAMaker. | string |
| qnaRuntimeEndpoint | (QnAMaker Only) The runtime endpoint of QnAMaker. | string |
| statisticsEnabled | (Bing Search Only) The flag to enable statistics of Bing Search. | bool |
| storageAccountConnectionString | (Personalization Only) The storage account connection string. | string Constraints: Max length = Pattern = ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$ |
| superUser | (Metrics Advisor Only) The super user of Metrics Advisor. | string Constraints: Max length = |
| websiteName | (Metrics Advisor Only) The website name of Metrics Advisor. | string Constraints: Max length = |
CognitiveServicesAccountProperties
| Name | Description | Value |
|---|---|---|
| apiProperties | The api properties for special APIs. | CognitiveServicesAccountApiProperties |
| customSubDomainName | Optional subdomain name used for token-based authentication. | string |
| encryption | The encryption properties for this resource. | Encryption |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet |
| privateEndpointConnections | The private endpoint connection associated with the Cognitive Services account. | PrivateEndpointConnection[] |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this account. Value is optional but if passed in, must be 'Enabled' or 'Disabled' | 'Disabled' 'Enabled' |
| userOwnedStorage | The storage accounts for this resource. | UserOwnedStorage[] |
CognitiveServicesAccountTags
| Name | Description | Value |
|---|
Encryption
| Name | Description | Value |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | 'Microsoft.CognitiveServices' 'Microsoft.KeyVault' |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity. | 'None' 'SystemAssigned' 'UserAssigned' |
| 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} | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
IpRule
| Name | Description | Value |
|---|---|---|
| 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) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | Name of the Key from KeyVault | string |
| keyVaultUri | Uri of KeyVault | string |
| keyVersion | Version of the Key from KeyVault | string |
Microsoft.CognitiveServices/accounts
| Name | Description | Value |
|---|---|---|
| identity | The identity of Cognitive Services account. | Identity |
| kind | The Kind of the resource. | string |
| location | The location of the resource | string |
| name | The resource name | string Constraints: Min length = 2 Max length = 2 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | Properties of Cognitive Services account. | CognitiveServicesAccountProperties |
| sku | The SKU of Cognitive Services account. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
NetworkRuleSet
| Name | Description | Value |
|---|---|---|
| defaultAction | The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. | 'Allow' 'Deny' |
| ipRules | The list of IP address rules. | IpRule[] |
| virtualNetworkRules | The list of virtual network rules. | VirtualNetworkRule[] |
PrivateEndpoint
| Name | Description | Value |
|---|
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| location | The location of the private endpoint connection | string |
| properties | Resource properties. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| groupIds | The private link resource group ids. | string[] |
| privateEndpoint | The resource of private end point. | PrivateEndpoint |
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState (required) |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | A message indicating if changes on the service provider require any updates on the consumer. | string |
| description | The reason for approval/rejection of the connection. | string |
| status | Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Sku
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the sku name. Required for account creation, optional for update. | string (required) |
UserAssignedIdentity
| Name | Description | Value |
|---|---|---|
| clientId | Client App Id associated with this identity. | string |
| principalId | Azure Active Directory principal ID associated with this Identity. | string |
UserOwnedStorage
| Name | Description | Value |
|---|---|---|
| resourceId | Full resource id of a Microsoft.Storage resource. | string |
VirtualNetworkRule
| Name | Description | Value |
|---|---|---|
| id | Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. | string (required) |
| ignoreMissingVnetServiceEndpoint | Ignore missing vnet service endpoint or not. | bool |
| state | Gets the state of virtual network rule. | string |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Azure AI Studio basic setup | This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio basic setup | This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio basic setup | This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio Network Restricted | This set of templates demonstrates how to set up Azure AI Studio with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio Network Restricted | This set of templates demonstrates how to set up Azure AI Studio with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio with Microsoft Entra ID Authentication | This set of templates demonstrates how to set up Azure AI Studio with Microsoft Entra ID authentication for dependent resources, such as Azure AI Services and Azure Storage. |
| Deploy an Azure AI services multi-service resource | This template deploys an Azure AI services resource to bring AI within reach of every developer without requiring machine learning expertise. All it takes is an API call to embed the ability to see, hear, speak, search, understand, and accelerate decision-making into your apps. |
| Deploy an Azure AI Translator resource | This template deploys an Azure AI Translator resource to bring AI within reach of every developer without requiring machine learning expertise. |
| Deploy an Azure AI Vision resource | This template deploys an Azure AI Vision resource to bring AI within reach of every developer without requiring machine learning expertise. |
| Deploy Secure Azure AI Studio with a managed virtual network | This template creates a secure Azure AI Studio environment with robust network and identity security restrictions. |
ARM template resource definition
The accounts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CognitiveServices/accounts resource, add the following JSON to your template.
{
"type": "Microsoft.CognitiveServices/accounts",
"apiVersion": "2017-04-18",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"kind": "string",
"location": "string",
"properties": {
"apiProperties": {
"aadClientId": "string",
"aadTenantId": "string",
"eventHubConnectionString": "string",
"qnaAzureSearchEndpointId": "string",
"qnaAzureSearchEndpointKey": "string",
"qnaRuntimeEndpoint": "string",
"statisticsEnabled": "bool",
"storageAccountConnectionString": "string",
"superUser": "string",
"websiteName": "string"
},
"customSubDomainName": "string",
"encryption": {
"keySource": "string",
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string"
}
},
"networkAcls": {
"defaultAction": "string",
"ipRules": [
{
"value": "string"
}
],
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVnetServiceEndpoint": "bool",
"state": "string"
}
]
},
"privateEndpointConnections": [
{
"location": "string",
"properties": {
"groupIds": [ "string" ],
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"userOwnedStorage": [
{
"resourceId": "string"
}
]
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
CognitiveServicesAccountApiProperties
| Name | Description | Value |
|---|---|---|
| aadClientId | (Metrics Advisor Only) The Azure AD Client Id (Application Id). | string Constraints: Max length = |
| aadTenantId | (Metrics Advisor Only) The Azure AD Tenant Id. | string Constraints: Max length = |
| eventHubConnectionString | (Personalization Only) The flag to enable statistics of Bing Search. | string Constraints: Max length = Pattern = ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$ |
| qnaAzureSearchEndpointId | (QnAMaker Only) The Azure Search endpoint id of QnAMaker. | string |
| qnaAzureSearchEndpointKey | (QnAMaker Only) The Azure Search endpoint key of QnAMaker. | string |
| qnaRuntimeEndpoint | (QnAMaker Only) The runtime endpoint of QnAMaker. | string |
| statisticsEnabled | (Bing Search Only) The flag to enable statistics of Bing Search. | bool |
| storageAccountConnectionString | (Personalization Only) The storage account connection string. | string Constraints: Max length = Pattern = ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$ |
| superUser | (Metrics Advisor Only) The super user of Metrics Advisor. | string Constraints: Max length = |
| websiteName | (Metrics Advisor Only) The website name of Metrics Advisor. | string Constraints: Max length = |
CognitiveServicesAccountProperties
| Name | Description | Value |
|---|---|---|
| apiProperties | The api properties for special APIs. | CognitiveServicesAccountApiProperties |
| customSubDomainName | Optional subdomain name used for token-based authentication. | string |
| encryption | The encryption properties for this resource. | Encryption |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet |
| privateEndpointConnections | The private endpoint connection associated with the Cognitive Services account. | PrivateEndpointConnection[] |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this account. Value is optional but if passed in, must be 'Enabled' or 'Disabled' | 'Disabled' 'Enabled' |
| userOwnedStorage | The storage accounts for this resource. | UserOwnedStorage[] |
CognitiveServicesAccountTags
| Name | Description | Value |
|---|
Encryption
| Name | Description | Value |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | 'Microsoft.CognitiveServices' 'Microsoft.KeyVault' |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity. | 'None' 'SystemAssigned' 'UserAssigned' |
| 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} | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
IpRule
| Name | Description | Value |
|---|---|---|
| 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) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | Name of the Key from KeyVault | string |
| keyVaultUri | Uri of KeyVault | string |
| keyVersion | Version of the Key from KeyVault | string |
Microsoft.CognitiveServices/accounts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2017-04-18' |
| identity | The identity of Cognitive Services account. | Identity |
| kind | The Kind of the resource. | string |
| location | The location of the resource | string |
| name | The resource name | string Constraints: Min length = 2 Max length = 2 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | Properties of Cognitive Services account. | CognitiveServicesAccountProperties |
| sku | The SKU of Cognitive Services account. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.CognitiveServices/accounts' |
NetworkRuleSet
| Name | Description | Value |
|---|---|---|
| defaultAction | The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. | 'Allow' 'Deny' |
| ipRules | The list of IP address rules. | IpRule[] |
| virtualNetworkRules | The list of virtual network rules. | VirtualNetworkRule[] |
PrivateEndpoint
| Name | Description | Value |
|---|
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| location | The location of the private endpoint connection | string |
| properties | Resource properties. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| groupIds | The private link resource group ids. | string[] |
| privateEndpoint | The resource of private end point. | PrivateEndpoint |
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState (required) |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | A message indicating if changes on the service provider require any updates on the consumer. | string |
| description | The reason for approval/rejection of the connection. | string |
| status | Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Sku
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the sku name. Required for account creation, optional for update. | string (required) |
UserAssignedIdentity
| Name | Description | Value |
|---|---|---|
| clientId | Client App Id associated with this identity. | string |
| principalId | Azure Active Directory principal ID associated with this Identity. | string |
UserOwnedStorage
| Name | Description | Value |
|---|---|---|
| resourceId | Full resource id of a Microsoft.Storage resource. | string |
VirtualNetworkRule
| Name | Description | Value |
|---|---|---|
| id | Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. | string (required) |
| ignoreMissingVnetServiceEndpoint | Ignore missing vnet service endpoint or not. | bool |
| state | Gets the state of virtual network rule. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure AI Studio basic setup |
This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio basic setup |
This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio basic setup |
This set of templates demonstrates how to set up Azure AI Studio with the basic setup, meaning with public internet access enabled, Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio Network Restricted |
This set of templates demonstrates how to set up Azure AI Studio with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio Network Restricted |
This set of templates demonstrates how to set up Azure AI Studio with private link and egress disabled, using Microsoft-managed keys for encryption and Microsoft-managed identity configuration for the AI resource. |
| Azure AI Studio with Microsoft Entra ID Authentication |
This set of templates demonstrates how to set up Azure AI Studio with Microsoft Entra ID authentication for dependent resources, such as Azure AI Services and Azure Storage. |
| Deploy an Azure AI services multi-service resource |
This template deploys an Azure AI services resource to bring AI within reach of every developer without requiring machine learning expertise. All it takes is an API call to embed the ability to see, hear, speak, search, understand, and accelerate decision-making into your apps. |
| Deploy an Azure AI Translator resource |
This template deploys an Azure AI Translator resource to bring AI within reach of every developer without requiring machine learning expertise. |
| Deploy an Azure AI Vision resource |
This template deploys an Azure AI Vision resource to bring AI within reach of every developer without requiring machine learning expertise. |
| Deploy Secure Azure AI Studio with a managed virtual network |
This template creates a secure Azure AI Studio environment with robust network and identity security restrictions. |
Terraform (AzAPI provider) resource definition
The accounts resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CognitiveServices/accounts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.CognitiveServices/accounts@2017-04-18"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
kind = "string"
location = "string"
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
apiProperties = {
aadClientId = "string"
aadTenantId = "string"
eventHubConnectionString = "string"
qnaAzureSearchEndpointId = "string"
qnaAzureSearchEndpointKey = "string"
qnaRuntimeEndpoint = "string"
statisticsEnabled = bool
storageAccountConnectionString = "string"
superUser = "string"
websiteName = "string"
}
customSubDomainName = "string"
encryption = {
keySource = "string"
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
}
}
networkAcls = {
defaultAction = "string"
ipRules = [
{
value = "string"
}
]
virtualNetworkRules = [
{
id = "string"
ignoreMissingVnetServiceEndpoint = bool
state = "string"
}
]
}
privateEndpointConnections = [
{
location = "string"
properties = {
groupIds = [
"string"
]
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
userOwnedStorage = [
{
resourceId = "string"
}
]
}
})
}
Property values
CognitiveServicesAccountApiProperties
| Name | Description | Value |
|---|---|---|
| aadClientId | (Metrics Advisor Only) The Azure AD Client Id (Application Id). | string Constraints: Max length = |
| aadTenantId | (Metrics Advisor Only) The Azure AD Tenant Id. | string Constraints: Max length = |
| eventHubConnectionString | (Personalization Only) The flag to enable statistics of Bing Search. | string Constraints: Max length = Pattern = ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$ |
| qnaAzureSearchEndpointId | (QnAMaker Only) The Azure Search endpoint id of QnAMaker. | string |
| qnaAzureSearchEndpointKey | (QnAMaker Only) The Azure Search endpoint key of QnAMaker. | string |
| qnaRuntimeEndpoint | (QnAMaker Only) The runtime endpoint of QnAMaker. | string |
| statisticsEnabled | (Bing Search Only) The flag to enable statistics of Bing Search. | bool |
| storageAccountConnectionString | (Personalization Only) The storage account connection string. | string Constraints: Max length = Pattern = ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$ |
| superUser | (Metrics Advisor Only) The super user of Metrics Advisor. | string Constraints: Max length = |
| websiteName | (Metrics Advisor Only) The website name of Metrics Advisor. | string Constraints: Max length = |
CognitiveServicesAccountProperties
| Name | Description | Value |
|---|---|---|
| apiProperties | The api properties for special APIs. | CognitiveServicesAccountApiProperties |
| customSubDomainName | Optional subdomain name used for token-based authentication. | string |
| encryption | The encryption properties for this resource. | Encryption |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet |
| privateEndpointConnections | The private endpoint connection associated with the Cognitive Services account. | PrivateEndpointConnection[] |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this account. Value is optional but if passed in, must be 'Enabled' or 'Disabled' | 'Disabled' 'Enabled' |
| userOwnedStorage | The storage accounts for this resource. | UserOwnedStorage[] |
CognitiveServicesAccountTags
| Name | Description | Value |
|---|
Encryption
| Name | Description | Value |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | 'Microsoft.CognitiveServices' 'Microsoft.KeyVault' |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity. | 'None' 'SystemAssigned' 'UserAssigned' |
| 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} | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
IpRule
| Name | Description | Value |
|---|---|---|
| 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) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | Name of the Key from KeyVault | string |
| keyVaultUri | Uri of KeyVault | string |
| keyVersion | Version of the Key from KeyVault | string |
Microsoft.CognitiveServices/accounts
| Name | Description | Value |
|---|---|---|
| identity | The identity of Cognitive Services account. | Identity |
| kind | The Kind of the resource. | string |
| location | The location of the resource | string |
| name | The resource name | string Constraints: Min length = 2 Max length = 2 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | Properties of Cognitive Services account. | CognitiveServicesAccountProperties |
| sku | The SKU of Cognitive Services account. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.CognitiveServices/accounts@2017-04-18" |
NetworkRuleSet
| Name | Description | Value |
|---|---|---|
| defaultAction | The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. | 'Allow' 'Deny' |
| ipRules | The list of IP address rules. | IpRule[] |
| virtualNetworkRules | The list of virtual network rules. | VirtualNetworkRule[] |
PrivateEndpoint
| Name | Description | Value |
|---|
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| location | The location of the private endpoint connection | string |
| properties | Resource properties. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| groupIds | The private link resource group ids. | string[] |
| privateEndpoint | The resource of private end point. | PrivateEndpoint |
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState (required) |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | A message indicating if changes on the service provider require any updates on the consumer. | string |
| description | The reason for approval/rejection of the connection. | string |
| status | Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Sku
| Name | Description | Value |
|---|---|---|
| name | Gets or sets the sku name. Required for account creation, optional for update. | string (required) |
UserAssignedIdentity
| Name | Description | Value |
|---|---|---|
| clientId | Client App Id associated with this identity. | string |
| principalId | Azure Active Directory principal ID associated with this Identity. | string |
UserOwnedStorage
| Name | Description | Value |
|---|---|---|
| resourceId | Full resource id of a Microsoft.Storage resource. | string |
VirtualNetworkRule
| Name | Description | Value |
|---|---|---|
| id | Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. | string (required) |
| ignoreMissingVnetServiceEndpoint | Ignore missing vnet service endpoint or not. | bool |
| state | Gets the state of virtual network rule. | string |