Microsoft.CognitiveServices accounts 2016-02-01-preview

Article
04/13/2023

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@2016-02-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  properties: any()
}

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	Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.	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. See Tags in templates
sku	The SKU of the cognitive services account.	Sku (required)
kind	Required. Indicates the type of cognitive service account.	'Academic' 'Bing.Autosuggest' 'Bing.Search' 'Bing.Speech' 'Bing.SpellCheck' 'ComputerVision' 'ContentModerator' 'Emotion' 'Face' 'LUIS' 'Recommendations' 'SpeakerRecognition' 'Speech' 'SpeechTranslation' 'TextAnalytics' 'TextTranslation' 'WebLM' (required)
properties	Must exist in the request. Must not be null.	For Bicep, you can use the any() function.(required)

Sku

Name	Description	Value
name	Gets or sets the sku name. Required for account creation, optional for update.	'F0' 'P0' 'P1' 'P2' 'S0' 'S1' 'S2' 'S3' 'S4' 'S5' 'S6' (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 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": "2016-02-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "properties": {}
}

Property values

accounts

Name	Description	Value
type	The resource type	'Microsoft.CognitiveServices/accounts'
apiVersion	The resource api version	'2016-02-01-preview'
name	The resource name	string (required) Character limit: 2-64 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric.
location	Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.	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. See Tags in templates
sku	The SKU of the cognitive services account.	Sku (required)
kind	Required. Indicates the type of cognitive service account.	'Academic' 'Bing.Autosuggest' 'Bing.Search' 'Bing.Speech' 'Bing.SpellCheck' 'ComputerVision' 'ContentModerator' 'Emotion' 'Face' 'LUIS' 'Recommendations' 'SpeakerRecognition' 'Speech' 'SpeechTranslation' 'TextAnalytics' 'TextTranslation' 'WebLM' (required)
properties	Must exist in the request. Must not be null.

Sku

Name	Description	Value
name	Gets or sets the sku name. Required for account creation, optional for update.	'F0' 'P0' 'P1' 'P2' 'S0' 'S1' 'S2' 'S3' 'S4' 'S5' 'S6' (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 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@2016-02-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    sku = {
      name = "string"
    }
    kind = "string"
  })
}

Property values

accounts

Name	Description	Value
type	The resource type	"Microsoft.CognitiveServices/accounts@2016-02-01-preview"
name	The resource name	string (required) Character limit: 2-64 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric.
location	Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.	string (required)
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 the cognitive services account.	Sku (required)
kind	Required. Indicates the type of cognitive service account.	"Academic" "Bing.Autosuggest" "Bing.Search" "Bing.Speech" "Bing.SpellCheck" "ComputerVision" "ContentModerator" "Emotion" "Face" "LUIS" "Recommendations" "SpeakerRecognition" "Speech" "SpeechTranslation" "TextAnalytics" "TextTranslation" "WebLM" (required)
properties	Must exist in the request. Must not be null.

Sku

Name	Description	Value
name	Gets or sets the sku name. Required for account creation, optional for update.	"F0" "P0" "P1" "P2" "S0" "S1" "S2" "S3" "S4" "S5" "S6" (required)

Microsoft.CognitiveServices accounts 2016-02-01-preview

Bicep resource definition

Resource format

Property values

accounts

Sku

Quickstart templates

ARM template resource definition

Resource format

Property values

accounts

Sku

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

accounts

Sku

Additional resources

Additional resources