共用方式為


Accounts - Update

匯報 認知服務帳戶

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2023-05-01

URI 參數

名稱 位於 必要 類型 Description
accountName
path True

string

認知服務帳戶的名稱。

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

要求本文

名稱 類型 Description
identity

Identity

資源的身分識別。

kind

string

資源的種類。

location

string

資源所在的地理位置

properties

AccountProperties

認知服務帳戶的屬性。

sku

Sku

代表 SKU 的資源模型定義

tags

object

資源標籤。

回應

名稱 類型 Description
200 OK

Account

資源提供者應該會傳回 200 (OK) ,以指出作業已順利完成。

202 Accepted

Account

HTTP 202 (如果作業已成功啟動,且會以異步方式完成,則接受) 。

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。 如果資源群組 資源不存在,應該傳回 404 (NotFound) 。

範例

Update Account

Sample Request

PATCH https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch?api-version=2023-05-01

{
  "location": "global",
  "sku": {
    "name": "S2"
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01
azure-AsyncOperation: http://azure.async.operation/status
{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
  "name": "bingSearch",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "global",
  "sku": {
    "name": "S2"
  },
  "kind": "Bing.Search",
  "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"",
  "properties": {
    "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
    "provisioningState": "Succeeded"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01
azure-AsyncOperation: http://azure.async.operation/status
{
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
  "name": "bingSearch",
  "type": "Microsoft.CognitiveServices/accounts",
  "location": "global",
  "sku": {
    "name": "S2"
  },
  "kind": "Bing.Search",
  "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"",
  "properties": {
    "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
    "provisioningState": "Succeeded"
  }
}

定義

名稱 Description
AbusePenalty

濫用懲罰。

AbusePenaltyAction

AbusePenalty 的動作。

Account

認知服務帳戶是 Azure 資源,代表已布建的帳戶、其類型、位置和 SKU。

AccountProperties

認知服務帳戶的屬性。

ApiProperties

特殊 API 的 API 屬性。

CallRateLimit

通話速率限制認知服務帳戶。

CommitmentPlanAssociation

承諾用量方案關聯。

createdByType

建立資源的身分識別類型。

Encryption

設定加密的屬性

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

Identity

資源的身分識別。

IpRule

從特定IP位址或IP範圍控管輔助功能的規則。

keySource

列舉 Encryption 的 keySource 可能值

KeyVaultProperties

要設定keyVault屬性的屬性

MultiRegionSettings

多區域設定認知服務帳戶。

NetworkRuleAction

當ipRules和 virtualNetworkRules 沒有規則相符時,默認動作。 這只有在評估略過屬性之後才會使用。

NetworkRuleSet

一組管理網路輔助功能的規則。

PrivateEndpoint

私人端點資源。

PrivateEndpointConnection

私人端點聯機資源。

PrivateEndpointConnectionProperties

PrivateEndpointConnectProperties 的屬性。

PrivateEndpointConnectionProvisioningState

目前的布建狀態。

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

ProvisioningState

取得呼叫作業時認知服務帳戶的狀態。

PublicNetworkAccess

此帳戶是否允許公用端點存取。

QuotaLimit
RegionSetting

通話速率限制認知服務帳戶。

RequestMatchPattern
ResourceIdentityType

識別類型。

RoutingMethods

多重區域路由方法。

Sku

代表 SKU 的資源模型定義

SkuCapability

SkuCapability 指出特定功能的功能。

SkuChangeInfo

帳戶的 SKU 變更資訊。

SkuTier

如果服務有一個以上的層級,但在PUT上則不需要此欄位,才能由資源提供者實作。

systemData

與建立和上次修改資源相關的元數據。

ThrottlingRule
UserAssignedIdentity

使用者指派的受控識別。

UserOwnedStorage

認知服務帳戶的用戶擁有記憶體。

VirtualNetworkRule

從特定虛擬網路控管輔助功能的規則。

AbusePenalty

濫用懲罰。

名稱 類型 Description
action

AbusePenaltyAction

AbusePenalty 的動作。

expiration

string

AbusePenalty 到期的日期時間。

rateLimitPercentage

number

速率限制的百分比。

AbusePenaltyAction

AbusePenalty 的動作。

名稱 類型 Description
Block

string

Throttle

string

Account

認知服務帳戶是 Azure 資源,代表已布建的帳戶、其類型、位置和 SKU。

名稱 類型 Description
etag

string

資源 Etag。

id

string

資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

資源的身分識別。

kind

string

資源的種類。

location

string

資源所在的地理位置

name

string

資源的名稱

properties

AccountProperties

認知服務帳戶的屬性。

sku

Sku

代表 SKU 的資源模型定義

systemData

systemData

與建立和上次修改資源相關的元數據。

tags

object

資源標籤。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

AccountProperties

認知服務帳戶的屬性。

名稱 類型 Description
abusePenalty

AbusePenalty

濫用懲罰。

allowedFqdnList

string[]

apiProperties

ApiProperties

特殊 API 的 API 屬性。

callRateLimit

CallRateLimit

通話速率限制認知服務帳戶。

capabilities

SkuCapability[]

取得認知服務帳戶的功能。 每個項目都會指出特定功能的功能。 這些值是只讀的,僅供參考。

commitmentPlanAssociations

CommitmentPlanAssociation[]

認知服務帳戶的承諾方案關聯。

customSubDomainName

string

用於令牌型驗證的選擇性子域名稱。

dateCreated

string

取得認知服務帳戶建立的日期。

deletionDate

string

刪除日期,僅適用於已刪除的帳戶。

disableLocalAuth

boolean

dynamicThrottlingEnabled

boolean

啟用動態節流的旗標。

encryption

Encryption

此資源的加密屬性。

endpoint

string

已建立帳戶的端點。

endpoints

object

internalId

string

內部標識碼 (已被取代,請勿使用此屬性) 。

isMigrated

boolean

如果資源是從現有的金鑰移轉。

locations

MultiRegionSettings

認知服務帳戶的多區域設定。

migrationToken

string

資源移轉令牌。

networkAcls

NetworkRuleSet

規則集合,控管來自特定網路位置的輔助功能。

privateEndpointConnections

PrivateEndpointConnection[]

與認知服務帳戶相關聯的私人端點連線。

provisioningState

ProvisioningState

取得呼叫作業時認知服務帳戶的狀態。

publicNetworkAccess

PublicNetworkAccess

此帳戶是否允許公用端點存取。

quotaLimit

QuotaLimit

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

排程的清除日期,僅適用於已刪除的帳戶。

skuChangeInfo

SkuChangeInfo

帳戶的 SKU 變更資訊。

userOwnedStorage

UserOwnedStorage[]

此資源的記憶體帳戶。

ApiProperties

特殊 API 的 API 屬性。

名稱 類型 Description
aadClientId

string

(Metrics Advisor 只會) Azure AD 用戶端識別碼 (應用程式識別碼) 。

aadTenantId

string

(Metrics Advisor 僅) Azure AD 租使用者識別碼。

eventHubConnectionString

string

(個人化僅) 啟用 Bing 搜尋 統計數據的旗標。

qnaAzureSearchEndpointId

string

(QnAMaker 僅) QnAMaker 的 Azure 搜尋服務端點標識符。

qnaAzureSearchEndpointKey

string

(QnAMaker 僅) QnAMaker 的 Azure 搜尋服務端點密鑰。

qnaRuntimeEndpoint

string

(QnAMaker 僅) QnAMaker 的運行時間端點。

statisticsEnabled

boolean

(Bing 搜尋 僅) 啟用 Bing 搜尋 統計數據的旗標。

storageAccountConnectionString

string

(個人化只會) 記憶體帳戶 連接字串。

superUser

string

(Metrics Advisor 僅) Metrics Advisor 的進階使用者。

websiteName

string

(Metrics Advisor 僅) Metrics Advisor 的網站名稱。

CallRateLimit

通話速率限制認知服務帳戶。

名稱 類型 Description
count

number

通話速率限制的計數值。

renewalPeriod

number

呼叫率限制的續約期間,以秒為單位。

rules

ThrottlingRule[]

CommitmentPlanAssociation

承諾用量方案關聯。

名稱 類型 Description
commitmentPlanId

string

承諾用量方案的 Azure 資源識別碼。

commitmentPlanLocation

string

承諾用量方案的位置。

createdByType

建立資源的身分識別類型。

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

Encryption

設定加密的屬性

名稱 類型 預設值 Description
keySource

keySource

Microsoft.KeyVault

列舉 Encryption 的 keySource 可能值

keyVaultProperties

KeyVaultProperties

KeyVault 的屬性

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。

Identity

資源的身分識別。

名稱 類型 Description
principalId

string

資源識別的主要標識碼。

tenantId

string

資源的租用戶標識碼。

type

ResourceIdentityType

識別類型。

userAssignedIdentities

<string,  UserAssignedIdentity>

與資源相關聯的使用者指派身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

從特定IP位址或IP範圍控管輔助功能的規則。

名稱 類型 Description
value

string

CIDR 表示法中的 IPv4 位址範圍,例如 '124.56.78.91' (簡單的 IP 位址) 或 '124.56.78.0/24' (開頭為 124.56.78) 的所有位址。

keySource

列舉 Encryption 的 keySource 可能值

名稱 類型 Description
Microsoft.CognitiveServices

string

Microsoft.KeyVault

string

KeyVaultProperties

要設定keyVault屬性的屬性

名稱 類型 Description
identityClientId

string

keyName

string

KeyVault 中的金鑰名稱

keyVaultUri

string

KeyVault 的 URI

keyVersion

string

KeyVault 的密鑰版本

MultiRegionSettings

多區域設定認知服務帳戶。

名稱 類型 Description
regions

RegionSetting[]

通話速率限制認知服務帳戶。

routingMethod

RoutingMethods

多重區域路由方法。

NetworkRuleAction

當ipRules和 virtualNetworkRules 沒有規則相符時,默認動作。 這只有在評估略過屬性之後才會使用。

名稱 類型 Description
Allow

string

Deny

string

NetworkRuleSet

一組管理網路輔助功能的規則。

名稱 類型 Description
defaultAction

NetworkRuleAction

當ipRules和 virtualNetworkRules 沒有規則相符時,默認動作。 這只有在評估略過屬性之後才會使用。

ipRules

IpRule[]

IP 位址規則的清單。

virtualNetworkRules

VirtualNetworkRule[]

虛擬網路規則的清單。

PrivateEndpoint

私人端點資源。

名稱 類型 Description
id

string

私人端點的ARM標識碼

PrivateEndpointConnection

私人端點聯機資源。

名稱 類型 Description
etag

string

資源 Etag。

id

string

資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

私人端點連線的位置

name

string

資源的名稱

properties

PrivateEndpointConnectionProperties

資源屬性。

systemData

systemData

與建立和上次修改資源相關的元數據。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProperties

PrivateEndpointConnectProperties 的屬性。

名稱 類型 Description
groupIds

string[]

私人鏈接資源群組識別碼。

privateEndpoint

PrivateEndpoint

私人端點的資源。

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

provisioningState

PrivateEndpointConnectionProvisioningState

私人端點聯機資源的布建狀態。

PrivateEndpointConnectionProvisioningState

目前的布建狀態。

名稱 類型 Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

名稱 類型 Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

名稱 類型 Description
actionsRequired

string

訊息,指出服務提供者上的變更是否需要在取用者上進行任何更新。

description

string

連接核准/拒絕的原因。

status

PrivateEndpointServiceConnectionStatus

指出服務擁有者是否已核准/拒絕/移除連線。

ProvisioningState

取得呼叫作業時認知服務帳戶的狀態。

名稱 類型 Description
Accepted

string

Creating

string

Deleting

string

Failed

string

Moving

string

ResolvingDNS

string

Succeeded

string

PublicNetworkAccess

此帳戶是否允許公用端點存取。

名稱 類型 Description
Disabled

string

Enabled

string

QuotaLimit

名稱 類型 Description
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RegionSetting

通話速率限制認知服務帳戶。

名稱 類型 Description
customsubdomain

string

將區域對應至區域自定義子域。

name

string

區域的名稱。

value

number

優先順序或加權路由方法的值。

RequestMatchPattern

名稱 類型 Description
method

string

path

string

ResourceIdentityType

識別類型。

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RoutingMethods

多重區域路由方法。

名稱 類型 Description
Performance

string

Priority

string

Weighted

string

Sku

代表 SKU 的資源模型定義

名稱 類型 Description
capacity

integer

如果 SKU 支援相應放大/縮小,則應該包含容量整數。 如果資源無法相應放大/縮小,可能會省略此專案。

family

string

如果服務有不同的硬體世代,則針對相同的 SKU,則可以在這裡擷取。

name

string

SKU 的名稱。 例如 - P3。 通常是字母+數位碼

size

string

SKU 大小。 當名稱欄位是階層和其他一些值的組合時,這會是獨立程序代碼。

tier

SkuTier

如果服務有一個以上的層級,但在PUT上則不需要此欄位,才能由資源提供者實作。

SkuCapability

SkuCapability 指出特定功能的功能。

名稱 類型 Description
name

string

SkuCapability 的名稱。

value

string

SkuCapability 的值。

SkuChangeInfo

帳戶的 SKU 變更資訊。

名稱 類型 Description
countOfDowngrades

number

取得降級的計數。

countOfUpgradesAfterDowngrades

number

取得降級后的升級計數。

lastChangeDate

string

取得上次變更日期。

SkuTier

如果服務有一個以上的層級,但在PUT上則不需要此欄位,才能由資源提供者實作。

名稱 類型 Description
Basic

string

Enterprise

string

Free

string

Premium

string

Standard

string

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳 (UTC) 。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。

ThrottlingRule

名稱 類型 Description
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number

UserAssignedIdentity

使用者指派的受控識別。

名稱 類型 Description
clientId

string

與此身分識別相關聯的用戶端應用程式標識碼。

principalId

string

與此身分識別相關聯的 Azure Active Directory 主體標識符。

UserOwnedStorage

認知服務帳戶的用戶擁有記憶體。

名稱 類型 Description
identityClientId

string

resourceId

string

Microsoft.Storage 資源的完整資源標識符。

VirtualNetworkRule

從特定虛擬網路控管輔助功能的規則。

名稱 類型 Description
id

string

vnet 子網的完整資源標識符,例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。

ignoreMissingVnetServiceEndpoint

boolean

忽略遺漏的 vnet 服務端點。

state

string

取得虛擬網路規則的狀態。