Microsoft.CognitiveServices accounts
The accounts resource type can be deployed to: Resource groups.
To learn about resource group deployments, see Bicep or ARM template.
For a list of changed properties in each API version, see change log.
Template format
To create a Microsoft.CognitiveServices/accounts resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.CognitiveServices/accounts@2022-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
allowedFqdnList: [
'string'
]
apiProperties: {
aadClientId: 'string'
aadTenantId: 'string'
eventHubConnectionString: 'string'
qnaAzureSearchEndpointId: 'string'
qnaAzureSearchEndpointKey: 'string'
qnaRuntimeEndpoint: 'string'
statisticsEnabled: bool
storageAccountConnectionString: 'string'
superUser: 'string'
websiteName: 'string'
}
customSubDomainName: 'string'
disableLocalAuth: bool
dynamicThrottlingEnabled: bool
encryption: {
keySource: 'string'
keyVaultProperties: {
identityClientId: 'string'
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
}
migrationToken: 'string'
networkAcls: {
defaultAction: 'string'
ipRules: [
{
value: 'string'
}
]
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVnetServiceEndpoint: bool
state: 'string'
}
]
}
publicNetworkAccess: 'string'
restore: bool
restrictOutboundNetworkAccess: bool
userOwnedStorage: [
{
identityClientId: 'string'
resourceId: 'string'
}
]
}
}
Property values
accounts
| Name | Description | Value |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.CognitiveServices/accounts' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2022-03-01' |
| name | The resource name | string (required) Character limit: 2-64 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. |
| location | The geo-location where the resource lives | string |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | The resource model definition representing SKU | Sku |
| kind | The Kind of the resource. | string |
| identity | Identity for the resource. | Identity |
| properties | Properties of Cognitive Services account. | AccountProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' '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} | object |
AccountProperties
| Name | Description | Value |
|---|---|---|
| allowedFqdnList | string[] | |
| apiProperties | The api properties for special APIs. | ApiProperties |
| customSubDomainName | Optional subdomain name used for token-based authentication. | string |
| disableLocalAuth | bool | |
| dynamicThrottlingEnabled | The flag to enable dynamic throttling. | bool |
| encryption | The encryption properties for this resource. | Encryption |
| migrationToken | Resource migration token. | string |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this account. | 'Disabled' 'Enabled' |
| restore | bool | |
| restrictOutboundNetworkAccess | bool | |
| userOwnedStorage | The storage accounts for this resource. | UserOwnedStorage[] |
ApiProperties
| Name | Description | Value |
|---|---|---|
| aadClientId | (Metrics Advisor Only) The Azure AD Client Id (Application Id). | string |
| aadTenantId | (Metrics Advisor Only) The Azure AD Tenant Id. | string |
| eventHubConnectionString | (Personalization Only) The flag to enable statistics of Bing Search. | string |
| 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 |
| superUser | (Metrics Advisor Only) The super user of Metrics Advisor. | string |
| websiteName | (Metrics Advisor Only) The website name of Metrics Advisor. | string |
Encryption
| Name | Description | Value |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | 'Microsoft.CognitiveServices' 'Microsoft.KeyVault' |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| identityClientId | string | |
| keyName | Name of the Key from KeyVault | string |
| keyVaultUri | Uri of KeyVault | string |
| keyVersion | Version of the Key from KeyVault | string |
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[] |
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) |
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 |
UserOwnedStorage
| Name | Description | Value |
|---|---|---|
| identityClientId | string | |
| resourceId | Full resource id of a Microsoft.Storage resource. | string |
Sku
| Name | Description | Value |
|---|---|---|
| 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 |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| 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 |
| 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. | 'Basic' 'Enterprise' 'Free' 'Premium' 'Standard' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Cognitive Services Computer Vision API |
A template for creating a new Cognitive Services Computer Vision API |
| Cognitive Services Translation API |
A template for creating a new Cognitive Services Translation API |
| Cognitive Service Universal Key |
This template allows you to create an Cognitive Service Universal. |