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 資源所在的地理位置 string
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 代表 SKU 的資源模型定義 Sku
kind 資源的種類。 string
身分識別 資源的身分識別。 身分識別
properties 認知服務帳戶的屬性。 AccountProperties

Identity

名称 描述
類型 識別類型。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 與資源相關聯的使用者指派身分識別清單。 使用者識別字典索引鍵參考的格式為 ARM 資源識別碼:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} object

AccountProperties

名稱 描述
allowedFqdnList string[]
apiProperties 特殊 API 的 API 屬性。 ApiProperties
customSubDomainName 用於權杖型驗證的選擇性子功能變數名稱稱。 string
disableLocalAuth bool
dynamicThrottlingEnabled 要啟用動態節流的旗標。 bool
加密 此資源的加密屬性。 加密
位置 認知服務帳戶的多區域設定。 MultiRegionSettings
migrationToken 資源移轉權杖。 string
networkAcls 規則集合,控管來自特定網路位置的協助工具。 NetworkRuleSet
publicNetworkAccess 此帳戶是否允許公用端點存取。 'Disabled'
'Enabled'
還原 bool
restrictOutboundNetworkAccess bool
userOwnedStorage 此資源的儲存體帳戶。 UserOwnedStorage[]

ApiProperties

名稱 描述
aadClientId (Metrics Advisor 只會) Azure AD 用戶端識別碼 (應用程式識別碼) 。 string
aadTenantId (Metrics Advisor 只會) Azure AD 租使用者識別碼。 string
eventHubConnectionString (個人化僅) 旗標,以啟用 Bing 搜尋的統計資料。 string
qnaAzureSearchEndpointId (QnAMaker 僅) QnAMaker 的 Azure 搜尋服務端點識別碼。 string
qnaAzureSearchEndpointKey (QnAMaker 僅) QnAMaker 的 Azure 搜尋服務端點金鑰。 string
qnaRuntimeEndpoint (QnAMaker 僅) QnAMaker 的執行時間端點。 string
statisticsEnabled (Bing 搜尋只會) 旗標來啟用 Bing 搜尋的統計資料。 bool
storageAccountConnectionString (個人化) 儲存體帳戶連接字串。 string
superUser (Metrics Advisor 僅) Metrics Advisor 的進階使用者。 string
websiteName (Metrics Advisor 僅) Metrics Advisor 的網站名稱。 string

加密

名稱 描述
keySource 列舉 KeySource for Encryption 的可能值 'Microsoft.CognitiveServices'
'Microsoft.KeyVault'
keyVaultProperties KeyVault 的屬性 KeyVaultProperties

KeyVaultProperties

名稱 描述
identityClientId string
keyName KeyVault 中的金鑰名稱 string
keyVaultUri KeyVault 的 URI string
keyVersion KeyVault 中的金鑰版本 string

MultiRegionSettings

名稱 描述
regions RegionSetting[]
routingMethod 多重區域路由方法。 'Performance'
'Priority'
'Weighted'

RegionSetting

名稱 描述
customubdomain 將區域對應至區域自訂子域。 字串
NAME 區域的名稱。 字串
value 優先順序或加權路由方法的值。 int

NetworkRuleSet

名稱 描述
defaultAction 沒有來自 ipRules 和 virtualNetworkRules 的規則相符時的預設動作。 這只有在評估略過屬性之後才會使用。 'Allow'
'Deny'
ipRules IP 位址規則的清單。 IpRule[]
virtualNetworkRules 虛擬網路規則的清單。 VirtualNetworkRule[]

IpRule

名稱 描述
value CIDR 標記法中的 IPv4 位址範圍,例如 '124.56.78.91' (簡單 IP 位址) 或 '124.56.78.0/24' (開頭為 124.56.78 的所有位址) 。 字串 (必要)

VirtualNetworkRule

名稱 描述
id vnet 子網的完整資源識別碼,例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。 字串 (必要)
ignoreMissingVnetServiceEndpoint 忽略遺漏的 vnet 服務端點。 bool
State 取得虛擬網路規則的狀態。 string

UserOwnedStorage

名稱 描述
identityClientId string
resourceId Microsoft.Storage 資源的完整資源識別碼。 string

SKU

名稱 描述
處理能力 如果 SKU 支援相應放大/縮小,則應該包含容量整數。 如果資源無法相應放大/縮小,則可能會省略此專案。 int
family 如果服務有不同層代的硬體,則針對相同的 SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱。 例如 - P3。 通常是字母+數位代碼 字串 (必要)
{1}size{2} SKU 大小。 當名稱欄位是階層和其他一些值的組合時,這會是獨立程式碼。 string
tier 如果服務有多個層級,但 PUT 上不需要,則資源提供者必須實作此欄位。 'Basic'
'Enterprise'
'Free'
'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

名稱 描述
類型 資源類型 'Microsoft.CognitiveServices/accounts'
apiVersion 資源 API 版本 '2023-05-01'
NAME 資源名稱 字串 (必要)

字元限制:2-64

有效字元:
英數字元和連字號。

以英數字元開頭及結尾。
location 資源所在的地理位置 string
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 代表 SKU 的資源模型定義 Sku
kind 資源的種類。 string
身分識別 資源的身分識別。 身分識別
properties 認知服務帳戶的屬性。 AccountProperties

Identity

名称 描述
類型 識別類型。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 與資源相關聯的使用者指派身分識別清單。 使用者識別字典索引鍵參考的格式為 ARM 資源識別碼:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} object

AccountProperties

名稱 描述
allowedFqdnList string[]
apiProperties 特殊 API 的 API 屬性。 ApiProperties
customSubDomainName 用於權杖型驗證的選擇性子功能變數名稱稱。 string
disableLocalAuth bool
dynamicThrottlingEnabled 要啟用動態節流的旗標。 bool
加密 此資源的加密屬性。 加密
位置 認知服務帳戶的多區域設定。 MultiRegionSettings
migrationToken 資源移轉權杖。 string
networkAcls 規則集合,控管來自特定網路位置的協助工具。 NetworkRuleSet
publicNetworkAccess 此帳戶是否允許公用端點存取。 'Disabled'
'Enabled'
還原 bool
restrictOutboundNetworkAccess bool
userOwnedStorage 此資源的儲存體帳戶。 UserOwnedStorage[]

ApiProperties

名稱 描述
aadClientId (Metrics Advisor 只會) Azure AD 用戶端識別碼 (應用程式識別碼) 。 string
aadTenantId (Metrics Advisor 只會) Azure AD 租使用者識別碼。 string
eventHubConnectionString (個人化僅) 旗標,以啟用 Bing 搜尋的統計資料。 string
qnaAzureSearchEndpointId (QnAMaker 僅) QnAMaker 的 Azure 搜尋服務端點識別碼。 string
qnaAzureSearchEndpointKey (QnAMaker 僅) QnAMaker 的 Azure 搜尋服務端點金鑰。 string
qnaRuntimeEndpoint (QnAMaker 僅) QnAMaker 的執行時間端點。 string
statisticsEnabled (Bing 搜尋只會) 旗標來啟用 Bing 搜尋的統計資料。 bool
storageAccountConnectionString (個人化) 儲存體帳戶連接字串。 string
superUser (Metrics Advisor 僅) Metrics Advisor 的進階使用者。 string
websiteName (Metrics Advisor 僅) Metrics Advisor 的網站名稱。 string

加密

名稱 描述
keySource 列舉 Encryption 的 keySource 可能值 'Microsoft.CognitiveServices'
'Microsoft.KeyVault'
keyVaultProperties KeyVault 的屬性 KeyVaultProperties

KeyVaultProperties

名稱 描述
identityClientId string
keyName KeyVault 中的金鑰名稱 string
keyVaultUri KeyVault 的 URI string
keyVersion KeyVault 的金鑰版本 string

MultiRegionSettings

名稱 描述
regions RegionSetting[]
routingMethod 多重區域路由方法。 'Performance'
'Priority'
'Weighted'

RegionSetting

名稱 描述
的ubdomain 將區域對應至區域自訂子域。 字串
NAME 區域的名稱。 字串
value 優先順序或加權路由方法的值。 int

NetworkRuleSet

名稱 描述
defaultAction 當 ipRules 和 virtualNetworkRules 沒有規則相符時,預設動作。 這只有在評估略過屬性之後才會使用。 'Allow'
'Deny'
ipRules IP 位址規則的清單。 IpRule[]
virtualNetworkRules 虛擬網路規則的清單。 VirtualNetworkRule[]

IpRule

名稱 描述
value CIDR 標記法中的 IPv4 位址範圍,例如 '124.56.78.91' (簡單的 IP 位址) 或 '124.56.78.0/24' (開頭為 124.56.78) 的所有位址。 需要字串 ()

VirtualNetworkRule

名稱 描述
id vnet 子網的完整資源識別碼,例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。 需要字串 ()
ignoreMissingVnetServiceEndpoint 忽略遺漏的 vnet 服務端點。 bool
State 取得虛擬網路規則的狀態。 string

UserOwnedStorage

名稱 描述
identityClientId string
resourceId Microsoft.Storage 資源的完整資源識別碼。 string

SKU

名稱 描述
處理能力 如果 SKU 支援相應放大/縮小,則應該包含容量整數。 如果資源無法相應放大/縮小,則可能會省略此專案。 int
family 如果服務有不同層代的硬體,則針對相同的 SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱。 例如 - P3。 通常是字母+數位代碼 字串 (必要)
{1}size{2} SKU 大小。 當名稱欄位是階層和其他一些值的組合時,這會是獨立程式碼。 string
tier 如果服務有多個層級,但 PUT 上不需要,則資源提供者必須實作此欄位。 'Basic'
'Enterprise'
'Free'
'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

名稱 描述
類型 資源類型 「Microsoft.CognitiveServices/accounts@2023-05-01」
NAME 資源名稱 字串 (必要)

字元限制:2-64

有效字元:
英數字元和連字號。

以英數字元開頭及結尾。
location 資源所在的地理位置 string
parent_id 若要部署至資源群組,請使用該資源群組的識別碼。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。
sku 代表 SKU 的資源模型定義 Sku
kind 資源的種類。 string
身分識別 資源的身分識別。 身分識別
properties 認知服務帳戶的屬性。 AccountProperties

Identity

名称 描述
類型 識別類型。 「SystemAssigned」
「SystemAssigned, UserAssigned」
「UserAssigned」
identity_ids 與資源相關聯的使用者指派身分識別清單。 使用者識別字典索引鍵參考的格式為 ARM 資源識別碼:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} 使用者身分識別識別碼的陣列。

AccountProperties

名稱 描述
allowedFqdnList string[]
apiProperties 特殊 API 的 API 屬性。 ApiProperties
customSubDomainName 用於權杖型驗證的選擇性子功能變數名稱稱。 string
disableLocalAuth bool
dynamicThrottlingEnabled 要啟用動態節流的旗標。 bool
加密 此資源的加密屬性。 加密
位置 認知服務帳戶的多區域設定。 MultiRegionSettings
migrationToken 資源移轉權杖。 string
networkAcls 規則集合,控管來自特定網路位置的協助工具。 NetworkRuleSet
publicNetworkAccess 此帳戶是否允許公用端點存取。 「Disabled」
「Enabled」
還原 bool
restrictOutboundNetworkAccess bool
userOwnedStorage 此資源的儲存體帳戶。 UserOwnedStorage[]

ApiProperties

名稱 描述
aadClientId (Metrics Advisor 只會) Azure AD 用戶端識別碼 (應用程式識別碼) 。 string
aadTenantId (Metrics Advisor 只會) Azure AD 租使用者識別碼。 string
eventHubConnectionString (個人化僅) 旗標,以啟用 Bing 搜尋的統計資料。 string
qnaAzureSearchEndpointId (QnAMaker 僅) QnAMaker 的 Azure 搜尋服務端點識別碼。 string
qnaAzureSearchEndpointKey (QnAMaker 僅) QnAMaker 的 Azure 搜尋服務端點金鑰。 string
qnaRuntimeEndpoint (QnAMaker 僅) QnAMaker 的執行時間端點。 string
statisticsEnabled (Bing 搜尋只會) 旗標來啟用 Bing 搜尋的統計資料。 bool
storageAccountConnectionString (個人化) 儲存體帳戶連接字串。 string
superUser (Metrics Advisor 僅) Metrics Advisor 的進階使用者。 string
websiteName (Metrics Advisor 僅) Metrics Advisor 的網站名稱。 string

加密

名稱 描述
keySource 列舉 KeySource for Encryption 的可能值 「Microsoft.CognitiveServices」
「Microsoft.KeyVault」
keyVaultProperties KeyVault 的屬性 KeyVaultProperties

KeyVaultProperties

名稱 描述
identityClientId string
keyName KeyVault 中的金鑰名稱 string
keyVaultUri KeyVault 的 URI string
keyVersion KeyVault 中的金鑰版本 string

MultiRegionSettings

名稱 描述
regions RegionSetting[]
routingMethod 多重區域路由方法。 「效能」
「Priority」
「加權」

RegionSetting

名稱 描述
的ubdomain 將區域對應至區域自訂子域。 字串
NAME 區域的名稱。 字串
value 優先順序或加權路由方法的值。 int

NetworkRuleSet

名稱 描述
defaultAction 當 ipRules 和 virtualNetworkRules 沒有規則相符時,預設動作。 這只有在評估略過屬性之後才會使用。 「允許」
「拒絕」
ipRules IP 位址規則的清單。 IpRule[]
virtualNetworkRules 虛擬網路規則的清單。 VirtualNetworkRule[]

IpRule

名稱 描述
value CIDR 標記法中的 IPv4 位址範圍,例如 '124.56.78.91' (簡單的 IP 位址) 或 '124.56.78.0/24' (開頭為 124.56.78) 的所有位址。 需要字串 ()

VirtualNetworkRule

名稱 描述
id vnet 子網的完整資源識別碼,例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。 需要字串 ()
ignoreMissingVnetServiceEndpoint 忽略遺漏的 vnet 服務端點。 bool
State 取得虛擬網路規則的狀態。 string

UserOwnedStorage

名稱 描述
identityClientId string
resourceId Microsoft.Storage 資源的完整資源識別碼。 string

SKU

名稱 描述
處理能力 如果 SKU 支援相應放大/縮小,則應該包含容量整數。 如果資源無法相應放大/縮小,可能會省略此專案。 int
family 如果服務有不同的硬體世代,則針對相同的 SKU,則可以在這裡擷取。 字串
NAME SKU 的名稱。 例如 - P3。 通常是字母+數位碼 需要字串 ()
{1}size{2} SKU 大小。 當名稱欄位是階層和其他一些值的組合時,這會是獨立程式碼。 string
tier 如果服務有一個以上的層級,但在 PUT 上則不需要此欄位,才能由資源提供者實作。 "Basic"
「企業」
「Free」
「Premium」
「標準」