Microsoft.CognitiveServices accounts 2023-05-01

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@2023-05-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'
      }
    }
    locations: {
      regions: [
        {
          customsubdomain: 'string'
          name: 'string'
          value: int
        }
      ]
      routingMethod: '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

Identity

AccountProperties

ApiProperties

Encryption

KeyVaultProperties

MultiRegionSettings

RegionSetting

NetworkRuleSet

IpRule

VirtualNetworkRule

UserOwnedStorage

Sku

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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 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 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.
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 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.

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": "2023-05-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"
      }
    },
    "locations": {
      "regions": [
        {
          "customsubdomain": "string",
          "name": "string",
          "value": "int"
        }
      ],
      "routingMethod": "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

Identity

AccountProperties

ApiProperties

Encryption

KeyVaultProperties

MultiRegionSettings

RegionSetting

NetworkRuleSet

IpRule

VirtualNetworkRule

UserOwnedStorage

Sku

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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 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 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.
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 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.

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@2023-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    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"
        }
      }
      locations = {
        regions = [
          {
            customsubdomain = "string"
            name = "string"
            value = int
          }
        ]
        routingMethod = "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"
        }
      ]
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    kind = "string"
  })
}

Property values

accounts

Identity

AccountProperties

ApiProperties

Encryption

KeyVaultProperties

MultiRegionSettings

RegionSetting

NetworkRuleSet

IpRule

VirtualNetworkRule

UserOwnedStorage

Sku