Microsoft.CognitiveServices accounts 2017-04-18

Article
12/28/2022
14 minutes to read

Bicep resource definition

The accounts resource type can be deployed to:

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' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  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

accounts

Name	Description	Value
name	The resource name	string (required) Character limit: 2-64 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric.
location	The location of the resource	string
tags	Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.	Dictionary of tag names and values. See Tags in templates
sku	The SKU of Cognitive Services account.	Sku
kind	The Kind of the resource.	string
identity	The identity of Cognitive Services account.	Identity
properties	Properties of Cognitive Services account.	CognitiveServicesAccountProperties

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}	object

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[]

CognitiveServicesAccountApiProperties

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
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

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)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

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'

UserOwnedStorage

Name	Description	Value
resourceId	Full resource id of a Microsoft.Storage resource.	string

Sku

Name	Description	Value
name	Gets or sets the sku name. Required for account creation, optional for update.	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy a Cognitive Services Computer Vision API	A template for creating a new Cognitive Services Computer Vision API
Deploy a Cognitive Services Translate API	This template deploys a Cognitive Services Translate API. Microsoft Translator API is a neural machine translation service that developers can easily integrate into their applications websites, tools, or any solution requiring multi-language support such as website localization, e-commerce, customer support, messaging applications, internal communication, and more.
Deploy a Cognitive Service Universal key	This template deploys all the Cognitive Services APIs Cognitive Services 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.

ARM template resource definition

The accounts resource type can be deployed to:

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",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "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

accounts

Name	Description	Value
type	The resource type	'Microsoft.CognitiveServices/accounts'
apiVersion	The resource api version	'2017-04-18'
name	The resource name	string (required) Character limit: 2-64 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric.
location	The location of the resource	string
tags	Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.	Dictionary of tag names and values. See Tags in templates
sku	The SKU of Cognitive Services account.	Sku
kind	The Kind of the resource.	string
identity	The identity of Cognitive Services account.	Identity
properties	Properties of Cognitive Services account.	CognitiveServicesAccountProperties

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}	object

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[]

CognitiveServicesAccountApiProperties

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
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

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)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

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'

UserOwnedStorage

Name	Description	Value
resourceId	Full resource id of a Microsoft.Storage resource.	string

Sku

Name	Description	Value
name	Gets or sets the sku name. Required for account creation, optional for update.	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy a Cognitive Services Computer Vision API	A template for creating a new Cognitive Services Computer Vision API
Deploy a Cognitive Services Translate API	This template deploys a Cognitive Services Translate API. Microsoft Translator API is a neural machine translation service that developers can easily integrate into their applications websites, tools, or any solution requiring multi-language support such as website localization, e-commerce, customer support, messaging applications, internal communication, and more.
Deploy a Cognitive Service Universal key	This template deploys all the Cognitive Services APIs Cognitive Services 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.

Terraform (AzAPI provider) resource definition

The accounts resource type can be deployed to:

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"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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"
        }
      ]
    }
    sku = {
      name = "string"
    }
    kind = "string"
  })
}

Property values

accounts

Name	Description	Value
type	The resource type	"Microsoft.CognitiveServices/accounts@2017-04-18"
name	The resource name	string (required) Character limit: 2-64 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric.
location	The location of the resource	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.	Dictionary of tag names and values.
sku	The SKU of Cognitive Services account.	Sku
kind	The Kind of the resource.	string
identity	The identity of Cognitive Services account.	Identity
properties	Properties of Cognitive Services account.	CognitiveServicesAccountProperties

Identity

Name	Description	Value
type	Type of managed service identity.	"SystemAssigned" "UserAssigned"
identity_ids	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}	Array of user identity IDs.

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[]

CognitiveServicesAccountApiProperties

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
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

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)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

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"

UserOwnedStorage

Name	Description	Value
resourceId	Full resource id of a Microsoft.Storage resource.	string

Sku

Name	Description	Value
name	Gets or sets the sku name. Required for account creation, optional for update.	string (required)

Microsoft.CognitiveServices accounts 2017-04-18

Bicep resource definition

Resource format

Property values

accounts

Identity

CognitiveServicesAccountProperties

CognitiveServicesAccountApiProperties

Encryption

KeyVaultProperties

NetworkRuleSet

IpRule

VirtualNetworkRule

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

UserOwnedStorage

Sku

Quickstart templates

ARM template resource definition

Resource format

Property values

accounts

Identity

CognitiveServicesAccountProperties

CognitiveServicesAccountApiProperties

Encryption

KeyVaultProperties

NetworkRuleSet

IpRule

VirtualNetworkRule

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

UserOwnedStorage

Sku

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

accounts

Identity

CognitiveServicesAccountProperties

CognitiveServicesAccountApiProperties

Encryption

KeyVaultProperties

NetworkRuleSet

IpRule

VirtualNetworkRule

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

UserOwnedStorage

Sku

Additional resources

Additional resources