你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.CognitiveServices 帐户

Bicep 资源定义

可以使用针对以下操作部署帐户资源类型:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.CognitiveServices/accounts 资源,请将以下 Bicep 添加到模板。

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'
      }
    ]
  }
}

属性值

accounts

名称 描述
name 资源名称 字符串 (必需)

字符限制:2-64

有效字符:
字母数字和连字符。

以字母数字开头和结尾。
location 资源所在的地理位置 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 表示 SKU 的资源模型定义 Sku
kind 资源的类型。 字符串
identity 资源的标识。 标识
properties 认知服务帐户的属性。 AccountProperties

标识

名称 描述 Value
type 标识类型。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} object

AccountProperties

名称 描述
allowedFqdnList string[]
apiProperties 特殊 API 的 API 属性。 ApiProperties
customSubDomainName 用于基于令牌的身份验证的可选子域名称。 字符串
disableLocalAuth bool
dynamicThrottlingEnabled 用于启用动态限制的标志。 bool
加密 此资源的加密属性。 加密
locations 认知服务帐户的多区域设置。 MultiRegionSettings
migrationToken 资源迁移令牌。 字符串
networkAcls 管理来自特定网络位置的辅助功能的规则集合。 NetworkRuleSet
publicNetworkAccess 是否允许此帐户访问公共终结点。 “Disabled”
“已启用”
还原 bool
restrictOutboundNetworkAccess bool
userOwnedStorage 此资源的存储帐户。 UserOwnedStorage[]

ApiProperties

名称 描述
aadClientId (指标顾问仅) Azure AD 客户端 ID (应用程序 ID) 。 字符串
aadTenantId (指标顾问仅) Azure AD 租户 ID。 字符串
eventHubConnectionString (个性化仅) 启用必应搜索统计信息的标志。 字符串
qnaAzureSearchEndpointId (QnAMaker 仅) QnAMaker 的 Azure 搜索终结点 ID。 字符串
qnaAzureSearchEndpointKey (QnAMaker 仅) QnAMaker 的 Azure 搜索终结点密钥。 字符串
qnaRuntimeEndpoint (QnAMaker 仅) QnAMaker 的运行时终结点。 字符串
statisticsEnabled (必应搜索 仅) 启用必应搜索统计信息的标志。 bool
storageAccountConnectionString (个性化仅) 存储帐户连接字符串。 字符串
superUser (指标顾问 仅) 指标顾问的超级用户。 字符串
websiteName 仅 (指标顾问) 指标顾问的网站名称。 字符串

Encryption

名称 描述
keySource 枚举 KeySource for Encryption 的可能值 “Microsoft.CognitiveServices”
“Microsoft.KeyVault”
keyVaultProperties KeyVault 的属性 KeyVaultProperties

KeyVaultProperties

名称 描述
identityClientId 字符串
keyName KeyVault 中的密钥的名称 字符串
keyVaultUri KeyVault 的 URI 字符串
keyVersion KeyVault 中的密钥版本 字符串

MultiRegionSettings

名称 描述
regions RegionSetting[]
routingMethod 多区域路由方法。 “性能”
“Priority”
“加权”

RegionSetting

名称 描述
customsubdomain 将区域映射到区域自定义子域。 字符串
name 区域的名称。 string
value 优先级或加权路由方法的值。 int

NetworkRuleSet

名称 描述
defaultAction ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 仅在评估 bypass 属性后,才使用此选项。 “允许”
“拒绝”
ipRules IP 地址规则的列表。 IpRule[]
virtualNetworkRules 虚拟网络规则列表。 VirtualNetworkRule[]

IpRule

名称 描述
value CIDR 表示法中的 IPv4 地址范围,例如“124.56.78.91” (简单 IP 地址) 或“124.56.78.0/24” (以 124.56.78) 开头的所有地址。 字符串 (必需)

VirtualNetworkRule

名称 描述 Value
id vnet 子网的完整资源 ID,例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。 字符串 (必需)
ignoreMissingVnetServiceEndpoint 忽略是否缺少 vnet 服务终结点。 bool
state 获取虚拟网络规则的状态。 字符串

UserOwnedStorage

名称 描述
identityClientId 字符串
ResourceId Microsoft.Storage 资源的完整资源 ID。 字符串

SKU

名称 描述
容量 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩减,则可能会省略这一点。 int
family 如果服务具有不同代系的硬件(对于同一 SKU),则可以在此处进行捕获。 字符串
name SKU 的名称。 例如 - P3。 它通常是字母+数字代码 字符串 (必需)
大小 SKU 大小。 当名称字段是层和其他某个值的组合时,这将是独立代码。 字符串
如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序必须实现此字段。 “Basic”
“Enterprise”
“免费”
“Premium”
“Standard”

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
部署认知服务计算机视觉 API

部署到 Azure
用于创建新的认知服务计算机视觉 API 的模板
部署认知服务翻译 API

部署到 Azure
此模板部署认知服务翻译 API。 Microsoft Translator API 是一种神经机器翻译服务,开发人员可以轻松地将其集成到其应用程序网站、工具或任何需要多语言支持的解决方案中,例如网站本地化、电子商务、客户支持、消息传递应用程序、内部通信等。
部署认知服务通用密钥

部署到 Azure
此模板部署所有认知服务 API认知服务让每个开发人员触手可及 AI,而无需机器学习专业知识。 只需进行 API 调用,即可在应用中嵌入查看、听到、说话、搜索、理解和加速决策的能力。

ARM 模板资源定义

可以使用针对以下操作部署帐户资源类型:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.CognitiveServices/accounts 资源,请将以下 JSON 添加到模板。

{
  "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"
      }
    ]
  }
}

属性值

accounts

名称 描述 Value
type 资源类型 “Microsoft.CognitiveServices/accounts”
apiVersion 资源 API 版本 '2023-05-01'
name 资源名称 字符串 (必需)

字符限制:2-64

有效字符:
字母数字和连字符。

以字母数字开头和结尾。
location 资源所在的地理位置 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 表示 SKU 的资源模型定义 Sku
kind 资源的种类。 字符串
identity 资源的标识。 标识
properties 认知服务帐户的属性。 AccountProperties

标识

名称 描述 Value
type 标识类型。 “None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} object

AccountProperties

名称 描述
allowedFqdnList string[]
apiProperties 特殊 API 的 API 属性。 ApiProperties
customSubDomainName 用于基于令牌的身份验证的可选子域名。 字符串
disableLocalAuth bool
dynamicThrottlingEnabled 用于启用动态限制的标志。 bool
加密 此资源的加密属性。 加密
locations 认知服务帐户的多区域设置。 MultiRegionSettings
migrationToken 资源迁移令牌。 字符串
networkAcls 管理来自特定网络位置的可访问性的规则集合。 NetworkRuleSet
publicNetworkAccess 是否允许此帐户访问公共终结点。 'Disabled'
'Enabled'
还原 bool
restrictOutboundNetworkAccess bool
userOwnedStorage 此资源的存储帐户。 UserOwnedStorage[]

ApiProperties

名称 描述
aadClientId (指标顾问仅) Azure AD 客户端 ID (应用程序 ID) 。 字符串
aadTenantId (指标顾问仅) Azure AD 租户 ID。 字符串
eventHubConnectionString (个性化仅) 用于启用必应搜索统计信息的标志。 字符串
qnaAzureSearchEndpointId (QnAMaker 仅) QnAMaker 的 Azure 搜索终结点 ID。 字符串
qnaAzureSearchEndpointKey (QnAMaker 仅) QnAMaker 的 Azure 搜索终结点密钥。 字符串
qnaRuntimeEndpoint (QnAMaker 仅) QnAMaker 的运行时终结点。 字符串
statisticsEnabled (必应搜索 仅) 启用必应搜索统计信息的标志。 bool
storageAccountConnectionString 仅) 存储帐户连接字符串 (个性化设置。 字符串
superUser (指标顾问 仅) 指标顾问的超级用户。 字符串
websiteName 仅 (指标顾问) 指标顾问的网站名称。 字符串

Encryption

名称 描述
keySource 枚举 KeySource for Encryption 的可能值 “Microsoft.CognitiveServices”
“Microsoft.KeyVault”
keyVaultProperties KeyVault 的属性 KeyVaultProperties

KeyVaultProperties

名称 描述
identityClientId 字符串
keyName KeyVault 中的密钥的名称 字符串
keyVaultUri KeyVault 的 URI 字符串
keyVersion KeyVault 中的密钥版本 字符串

MultiRegionSettings

名称 描述
regions RegionSetting[]
routingMethod 多区域路由方法。 “性能”
“Priority”
“加权”

RegionSetting

名称 描述
customsubdomain 将区域映射到区域自定义子域。 字符串
name 区域的名称。 string
value 优先级或加权路由方法的值。 int

NetworkRuleSet

名称 描述
defaultAction ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 仅在评估 bypass 属性后,才使用此选项。 “允许”
“拒绝”
ipRules IP 地址规则的列表。 IpRule[]
virtualNetworkRules 虚拟网络规则列表。 VirtualNetworkRule[]

IpRule

名称 描述
value CIDR 表示法中的 IPv4 地址范围,例如“124.56.78.91” (简单 IP 地址) 或“124.56.78.0/24” (以 124.56.78) 开头的所有地址。 字符串 (必需)

VirtualNetworkRule

名称 描述 Value
id vnet 子网的完整资源 ID,例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。 字符串 (必需)
ignoreMissingVnetServiceEndpoint 忽略是否缺少 vnet 服务终结点。 bool
state 获取虚拟网络规则的状态。 字符串

UserOwnedStorage

名称 描述
identityClientId 字符串
ResourceId Microsoft.Storage 资源的完整资源 ID。 字符串

SKU

名称 描述
容量 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果无法对资源进行横向扩展/缩减,则可能会省略此项。 int
family 如果服务针对同一 SKU 具有不同代系的硬件,则可以在此处捕获。 字符串
name SKU 的名称。 例如 - P3。 它通常是字母+数字代码 字符串 (必需)
大小 SKU 大小。 当名称字段是层和一些其他值的组合时,这将是独立代码。 字符串
如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。 'Basic'
“企业”
“免费”
“Premium”
'Standard'

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
部署认知服务计算机视觉 API

部署到 Azure
用于创建新的认知服务计算机视觉 API 的模板
部署认知服务翻译 API

部署到 Azure
此模板部署认知服务翻译 API。 Microsoft Translator API 是一种神经机器翻译服务,开发人员可以轻松地将其集成到其应用程序网站、工具或任何需要多语言支持的解决方案中,例如网站本地化、电子商务、客户支持、消息传递应用程序、内部通信等。
部署认知服务通用密钥

部署到 Azure
此模板部署所有认知服务 API认知服务使 AI 触手可及,而无需机器学习专业知识。 只需通过 API 调用,即可在应用中嵌入查看、听到、说话、搜索、理解和加速决策的能力。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署帐户资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.CognitiveServices/accounts 资源,请将以下 Terraform 添加到模板。

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"
  })
}

属性值

accounts

名称 描述 Value
type 资源类型 “Microsoft.CognitiveServices/accounts@2023-05-01”
name 资源名称 字符串 (必需)

字符限制:2-64

有效字符:
字母数字和连字符。

以字母数字开头和结尾。
location 资源所在的地理位置 字符串
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
sku 表示 SKU 的资源模型定义 Sku
kind 资源的种类。 字符串
identity 资源的标识。 标识
properties 认知服务帐户的属性。 AccountProperties

标识

名称 描述 Value
type 标识类型。 “SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
identity_ids 与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} 用户标识 ID 的数组。

AccountProperties

名称 描述
allowedFqdnList string[]
apiProperties 特殊 API 的 API 属性。 ApiProperties
customSubDomainName 用于基于令牌的身份验证的可选子域名称。 字符串
disableLocalAuth bool
dynamicThrottlingEnabled 用于启用动态限制的标志。 bool
加密 此资源的加密属性。 加密
locations 认知服务帐户的多区域设置。 MultiRegionSettings
migrationToken 资源迁移令牌。 字符串
networkAcls 管理来自特定网络位置的辅助功能的规则集合。 NetworkRuleSet
publicNetworkAccess 是否允许此帐户访问公共终结点。 “Disabled”
“已启用”
还原 bool
restrictOutboundNetworkAccess bool
userOwnedStorage 此资源的存储帐户。 UserOwnedStorage[]

ApiProperties

名称 描述
aadClientId (指标顾问仅) Azure AD 客户端 ID (应用程序 ID) 。 字符串
aadTenantId (指标顾问仅) Azure AD 租户 ID。 字符串
eventHubConnectionString (个性化仅) 启用必应搜索统计信息的标志。 字符串
qnaAzureSearchEndpointId (QnAMaker 仅) QnAMaker 的 Azure 搜索终结点 ID。 字符串
qnaAzureSearchEndpointKey (QnAMaker 仅) QnAMaker 的 Azure 搜索终结点密钥。 字符串
qnaRuntimeEndpoint (QnAMaker 仅) QnAMaker 的运行时终结点。 字符串
statisticsEnabled (必应搜索 仅) 启用必应搜索统计信息的标志。 bool
storageAccountConnectionString (个性化仅) 存储帐户连接字符串。 字符串
superUser (指标顾问 仅) 指标顾问的超级用户。 字符串
websiteName 仅 (指标顾问) 指标顾问的网站名称。 字符串

Encryption

名称 描述
keySource 枚举 KeySource for Encryption 的可能值 “Microsoft.CognitiveServices”
“Microsoft.KeyVault”
keyVaultProperties KeyVault 的属性 KeyVaultProperties

KeyVaultProperties

名称 描述
identityClientId 字符串
keyName KeyVault 中的密钥的名称 字符串
keyVaultUri KeyVault 的 URI 字符串
keyVersion KeyVault 中的密钥版本 字符串

MultiRegionSettings

名称 描述
regions RegionSetting[]
routingMethod 多区域路由方法。 “性能”
“优先级”
“加权”

RegionSetting

名称 描述
customsubdomain 将区域映射到区域自定义子域。 字符串
name 区域的名称。 string
value 优先级或加权路由方法的值。 int

NetworkRuleSet

名称 描述
defaultAction ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 仅在评估 bypass 属性后,才使用此选项。 “允许”
“拒绝”
ipRules IP 地址规则的列表。 IpRule[]
virtualNetworkRules 虚拟网络规则列表。 VirtualNetworkRule[]

IpRule

名称 描述
value CIDR 表示法中的 IPv4 地址范围,例如“124.56.78.91” (简单 IP 地址) 或“124.56.78.0/24” (以 124.56.78) 开头的所有地址。 字符串 (必需)

VirtualNetworkRule

名称 描述 Value
id vnet 子网的完整资源 ID,例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。 字符串 (必需)
ignoreMissingVnetServiceEndpoint 忽略是否缺少 vnet 服务终结点。 bool
state 获取虚拟网络规则的状态。 字符串

UserOwnedStorage

名称 描述
identityClientId 字符串
ResourceId Microsoft.Storage 资源的完整资源 ID。 字符串

SKU

名称 描述
容量 如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩减,则可能会省略这一点。 int
family 如果服务具有不同代系的硬件(对于同一 SKU),则可以在此处进行捕获。 字符串
name SKU 的名称。 例如 - P3。 它通常是字母+数字代码 字符串 (必需)
大小 SKU 大小。 当名称字段是层和其他某个值的组合时,这将是独立代码。 字符串
如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序必须实现此字段。 "Basic"
“企业版”
"Free"
“Premium”
“Standard”