你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Accounts - Update
汇报认知服务帐户
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2023-05-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
account
|
path | True |
string |
认知服务帐户的名称。 正则表达式模式: |
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
identity |
资源的标识。 |
|
kind |
string |
资源的类型。 |
location |
string |
资源所在的地理位置 |
properties |
认知服务帐户的属性。 |
|
sku |
表示 SKU 的资源模型定义 |
|
tags |
object |
资源标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
资源提供程序应返回 200 (正常) 以指示操作成功完成。 |
|
202 Accepted |
HTTP 202 (如果操作已成功启动并将异步完成,则接受) 。 |
|
Other Status Codes |
描述操作失败原因的错误响应。 如果资源组 或 资源不存在,应返回 404 (NotFound) 。 |
示例
Update Account
示例请求
示例响应
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"
}
}
定义
名称 | 说明 |
---|---|
Abuse |
滥用处罚。 |
Abuse |
AbusePenalty 的操作。 |
Account |
认知服务帐户是一种 Azure 资源,表示预配的帐户、类型、位置和 SKU。 |
Account |
认知服务帐户的属性。 |
Api |
特殊 API 的 API 属性。 |
Call |
调用速率限制认知服务帐户。 |
Commitment |
承诺计划关联。 |
created |
创建资源的标识类型。 |
Encryption |
用于配置加密的属性 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Identity |
资源的标识。 |
Ip |
从特定 IP 地址或 IP 范围控制辅助功能的规则。 |
key |
枚举 KeySource for Encryption 的可能值 |
Key |
用于配置 keyVault 属性的属性 |
Multi |
多区域设置认知服务帐户。 |
Network |
ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 仅在评估 bypass 属性后,才使用此选项。 |
Network |
一组管理网络可访问性的规则。 |
Private |
专用终结点资源。 |
Private |
专用终结点连接资源。 |
Private |
PrivateEndpointConnectProperties 的属性。 |
Private |
当前预配状态。 |
Private |
专用终结点连接状态。 |
Private |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
Provisioning |
获取调用操作时认知服务帐户的状态。 |
Public |
是否允许此帐户访问公共终结点。 |
Quota |
|
Region |
调用速率限制认知服务帐户。 |
Request |
|
Resource |
标识类型。 |
Routing |
多区域路由方法。 |
Sku |
表示 SKU 的资源模型定义 |
Sku |
SkuCapability 指示特定功能的功能。 |
Sku |
帐户的 SKU 更改信息。 |
Sku |
如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。 |
system |
与资源的创建和上次修改相关的元数据。 |
Throttling |
|
User |
用户分配的托管标识。 |
User |
用户拥有认知服务帐户的存储。 |
Virtual |
控制来自特定虚拟网络的辅助功能的规则。 |
AbusePenalty
滥用处罚。
名称 | 类型 | 说明 |
---|---|---|
action |
AbusePenalty 的操作。 |
|
expiration |
string |
AbusePenalty 到期的日期时间。 |
rateLimitPercentage |
number |
速率限制的百分比。 |
AbusePenaltyAction
AbusePenalty 的操作。
名称 | 类型 | 说明 |
---|---|---|
Block |
string |
|
Throttle |
string |
Account
认知服务帐户是一种 Azure 资源,表示预配的帐户、类型、位置和 SKU。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
资源 Etag。 |
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
资源的标识。 |
|
kind |
string |
资源的种类。 |
location |
string |
资源所在的地理位置 |
name |
string |
资源的名称 |
properties |
认知服务帐户的属性。 |
|
sku |
表示 SKU 的资源模型定义 |
|
systemData |
与资源的创建和上次修改相关的元数据。 |
|
tags |
object |
资源标记。 |
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
AccountProperties
认知服务帐户的属性。
名称 | 类型 | 说明 |
---|---|---|
abusePenalty |
滥用处罚。 |
|
allowedFqdnList |
string[] |
|
apiProperties |
特殊 API 的 API 属性。 |
|
callRateLimit |
调用速率限制认知服务帐户。 |
|
capabilities |
获取认知服务帐户的功能。 每个项都指示特定功能的功能。 这些值是只读的,仅供参考。 |
|
commitmentPlanAssociations |
认知服务帐户的承诺计划关联。 |
|
customSubDomainName |
string |
用于基于令牌的身份验证的可选子域名。 |
dateCreated |
string |
获取认知服务帐户创建日期。 |
deletionDate |
string |
删除日期,仅适用于已删除的帐户。 |
disableLocalAuth |
boolean |
|
dynamicThrottlingEnabled |
boolean |
用于启用动态限制的标志。 |
encryption |
此资源的加密属性。 |
|
endpoint |
string |
已创建帐户的终结点。 |
endpoints |
object |
|
internalId |
string |
内部标识符 (弃用,不要) 使用此属性。 |
isMigrated |
boolean |
如果资源是从现有密钥迁移的。 |
locations |
认知服务帐户的多区域设置。 |
|
migrationToken |
string |
资源迁移令牌。 |
networkAcls |
管理来自特定网络位置的可访问性的规则集合。 |
|
privateEndpointConnections |
与认知服务帐户关联的专用终结点连接。 |
|
provisioningState |
获取调用操作时认知服务帐户的状态。 |
|
publicNetworkAccess |
是否允许此帐户访问公共终结点。 |
|
quotaLimit | ||
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
计划的清除日期,仅适用于已删除的帐户。 |
skuChangeInfo |
帐户的 SKU 更改信息。 |
|
userOwnedStorage |
此资源的存储帐户。 |
ApiProperties
特殊 API 的 API 属性。
名称 | 类型 | 说明 |
---|---|---|
aadClientId |
string |
(指标顾问仅) Azure AD 客户端 ID (应用程序 ID) 。 |
aadTenantId |
string |
(指标顾问仅) Azure AD 租户 ID。 |
eventHubConnectionString |
string |
(个性化 仅) 用于启用必应搜索统计信息的标志。 |
qnaAzureSearchEndpointId |
string |
(QnAMaker 仅) QnAMaker 的 Azure 搜索终结点 ID。 |
qnaAzureSearchEndpointKey |
string |
(QnAMaker 仅) QnAMaker 的 Azure 搜索终结点密钥。 |
qnaRuntimeEndpoint |
string |
(QnAMaker 仅) QnAMaker 的运行时终结点。 |
statisticsEnabled |
boolean |
(必应搜索 仅) 启用必应搜索统计信息的标志。 |
storageAccountConnectionString |
string |
仅) 存储帐户连接字符串 (个性化。 |
superUser |
string |
(指标顾问 仅) 指标顾问的超级用户。 |
websiteName |
string |
仅 (指标顾问) 指标顾问的网站名称。 |
CallRateLimit
调用速率限制认知服务帐户。
名称 | 类型 | 说明 |
---|---|---|
count |
number |
呼叫速率限制的计数值。 |
renewalPeriod |
number |
呼叫速率限制的续订期(以秒为单位)。 |
rules |
CommitmentPlanAssociation
承诺计划关联。
名称 | 类型 | 说明 |
---|---|---|
commitmentPlanId |
string |
承诺计划的 Azure 资源 ID。 |
commitmentPlanLocation |
string |
承诺计划的位置。 |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Encryption
用于配置加密的属性
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
keySource | Microsoft.KeyVault |
枚举用于加密的 keySource 的可能值 |
|
keyVaultProperties |
KeyVault 的属性 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
Identity
资源的标识。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
资源标识的主体 ID。 |
tenantId |
string |
资源的租户 ID。 |
type |
标识类型。 |
|
userAssignedIdentities |
<string,
User |
与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
IpRule
从特定 IP 地址或 IP 范围控制辅助功能的规则。
名称 | 类型 | 说明 |
---|---|---|
value |
string |
CIDR 表示法中的 IPv4 地址范围,例如“124.56.78.91” (简单 IP 地址) 或“124.56.78.0/24” (以 124.56.78) 开头的所有地址。 |
keySource
枚举 KeySource for Encryption 的可能值
名称 | 类型 | 说明 |
---|---|---|
Microsoft.CognitiveServices |
string |
|
Microsoft.KeyVault |
string |
KeyVaultProperties
用于配置 keyVault 属性的属性
名称 | 类型 | 说明 |
---|---|---|
identityClientId |
string |
|
keyName |
string |
KeyVault 中的密钥的名称 |
keyVaultUri |
string |
KeyVault 的 URI |
keyVersion |
string |
KeyVault 中的密钥版本 |
MultiRegionSettings
多区域设置认知服务帐户。
名称 | 类型 | 说明 |
---|---|---|
regions |
调用速率限制认知服务帐户。 |
|
routingMethod |
多区域路由方法。 |
NetworkRuleAction
ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 仅在评估 bypass 属性后,才使用此选项。
名称 | 类型 | 说明 |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleSet
一组管理网络可访问性的规则。
名称 | 类型 | 说明 |
---|---|---|
defaultAction |
ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。 这仅在评估 bypass 属性后使用。 |
|
ipRules |
Ip |
IP 地址规则的列表。 |
virtualNetworkRules |
虚拟网络规则的列表。 |
PrivateEndpoint
专用终结点资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
专用终结点的 ARM 标识符 |
PrivateEndpointConnection
专用终结点连接资源。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
资源 Etag。 |
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
专用终结点连接的位置 |
name |
string |
资源的名称 |
properties |
资源属性。 |
|
systemData |
与资源的创建和上次修改相关的元数据。 |
|
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProperties
PrivateEndpointConnectProperties 的属性。
名称 | 类型 | 说明 |
---|---|---|
groupIds |
string[] |
专用链接资源组 ID。 |
privateEndpoint |
专用终结点的资源。 |
|
privateLinkServiceConnectionState |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
|
provisioningState |
专用终结点连接资源的预配状态。 |
PrivateEndpointConnectionProvisioningState
当前预配状态。
名称 | 类型 | 说明 |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
专用终结点连接状态。
名称 | 类型 | 说明 |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
有关服务使用者与提供程序之间的连接状态的信息集合。
名称 | 类型 | 说明 |
---|---|---|
actionsRequired |
string |
一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。 |
description |
string |
批准/拒绝连接的原因。 |
status |
指示连接是否已由服务的所有者批准/拒绝/删除。 |
ProvisioningState
获取调用操作时认知服务帐户的状态。
名称 | 类型 | 说明 |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
ResolvingDNS |
string |
|
Succeeded |
string |
PublicNetworkAccess
是否允许此帐户访问公共终结点。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
QuotaLimit
名称 | 类型 | 说明 |
---|---|---|
count |
number |
|
renewalPeriod |
number |
|
rules |
RegionSetting
调用速率限制认知服务帐户。
名称 | 类型 | 说明 |
---|---|---|
customsubdomain |
string |
将区域映射到区域自定义子域。 |
name |
string |
区域的名称。 |
value |
number |
优先级或加权路由方法的值。 |
RequestMatchPattern
名称 | 类型 | 说明 |
---|---|---|
method |
string |
|
path |
string |
ResourceIdentityType
标识类型。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RoutingMethods
多区域路由方法。
名称 | 类型 | 说明 |
---|---|---|
Performance |
string |
|
Priority |
string |
|
Weighted |
string |
Sku
表示 SKU 的资源模型定义
名称 | 类型 | 说明 |
---|---|---|
capacity |
integer |
如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果无法对资源进行横向扩展/缩减,则可能会省略此项。 |
family |
string |
如果服务针对同一 SKU 具有不同代系的硬件,则可以在此处捕获。 |
name |
string |
SKU 的名称。 例如 - P3。 它通常是字母+数字代码 |
size |
string |
SKU 大小。 当名称字段是层和一些其他值的组合时,这将是独立代码。 |
tier |
如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。 |
SkuCapability
SkuCapability 指示特定功能的功能。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
SkuCapability 的名称。 |
value |
string |
SkuCapability 的值。 |
SkuChangeInfo
帐户的 SKU 更改信息。
名称 | 类型 | 说明 |
---|---|---|
countOfDowngrades |
number |
获取降级的计数。 |
countOfUpgradesAfterDowngrades |
number |
获取降级后的升级计数。 |
lastChangeDate |
string |
获取上次更改日期。 |
SkuTier
如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。
名称 | 类型 | 说明 |
---|---|---|
Basic |
string |
|
Enterprise |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |
ThrottlingRule
名称 | 类型 | 说明 |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |
UserAssignedIdentity
用户分配的托管标识。
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
与此标识关联的客户端应用 ID。 |
principalId |
string |
与此标识关联的 Azure Active Directory 主体 ID。 |
UserOwnedStorage
用户拥有认知服务帐户的存储。
名称 | 类型 | 说明 |
---|---|---|
identityClientId |
string |
|
resourceId |
string |
Microsoft.Storage 资源的完整资源 ID。 |
VirtualNetworkRule
控制来自特定虚拟网络的辅助功能的规则。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
vnet 子网的完整资源 ID,例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。 |
ignoreMissingVnetServiceEndpoint |
boolean |
忽略是否缺少 vnet 服务终结点。 |
state |
string |
获取虚拟网络规则的状态。 |