Accounts - Update
Обновления учетной записи Cognitive Services
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2023-05-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
account
|
path | True |
string |
Имя учетной записи Cognitive Services. Шаблон регулярного выражения: |
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
identity |
Удостоверение ресурса. |
|
kind |
string |
Тип ресурса. |
location |
string |
Географическое расположение, в котором находится ресурс |
properties |
Свойства учетной записи Cognitive Services. |
|
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 |
Учетная запись Cognitive Services — это ресурс Azure, представляющий подготовленную учетную запись, ее тип, расположение и номер SKU. |
Account |
Свойства учетной записи Cognitive Services. |
Api |
Свойства API для специальных API. |
Call |
Учетная запись Cognitive Services с ограничением частоты вызовов. |
Commitment |
Сопоставление плана обязательств. |
created |
Тип удостоверения, создавшего ресурс. |
Encryption |
Свойства для настройки шифрования |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Identity |
Удостоверение ресурса. |
Ip |
Правило, регулирующее доступность из определенного IP-адреса или диапазона IP-адресов. |
key |
Перечисляет возможное значение keySource для шифрования. |
Key |
Свойства для настройки свойств хранилища ключей |
Multi |
Учетная запись Cognitive Services для нескольких параметров. |
Network |
Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода. |
Network |
Набор правил, определяющих доступность сети. |
Private |
Ресурс частной конечной точки. |
Private |
Ресурс подключения к частной конечной точке. |
Private |
Свойства PrivateEndpointConnectProperties. |
Private |
Текущее состояние подготовки. |
Private |
Состояние подключения к частной конечной точке. |
Private |
Коллекция сведений о состоянии соединения между потребителем службы и поставщиком. |
Provisioning |
Возвращает состояние учетной записи cognitive services на момент вызова операции. |
Public |
Разрешен ли доступ к общедоступной конечной точке для этой учетной записи. |
Quota |
|
Region |
Учетная запись Cognitive Services с ограничением частоты вызовов. |
Request |
|
Resource |
Тип удостоверения. |
Routing |
Методы маршрутизации в нескольких регионах. |
Sku |
Определение модели ресурсов, представляющее SKU |
Sku |
SkuCapability указывает на возможности определенной функции. |
Sku |
Сведения об изменении номера SKU учетной записи. |
Sku |
Это поле должно быть реализовано поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
Throttling |
|
User |
Управляемое удостоверение, назначаемое пользователем |
User |
Хранилище, принадлежаемое пользователю для учетной записи Cognitive Services. |
Virtual |
Правило, регулирующее специальные возможности из определенной виртуальной сети. |
AbusePenalty
Наказание за злоупотребление.
Имя | Тип | Описание |
---|---|---|
action |
Действие AbusePenalty. |
|
expiration |
string |
Дата и время истечения срока действия AbusePenalty. |
rateLimitPercentage |
number |
Процент ограничения скорости. |
AbusePenaltyAction
Действие AbusePenalty.
Имя | Тип | Описание |
---|---|---|
Block |
string |
|
Throttle |
string |
Account
Учетная запись Cognitive Services — это ресурс Azure, представляющий подготовленную учетную запись, ее тип, расположение и номер SKU.
Имя | Тип | Описание |
---|---|---|
etag |
string |
Тег ресурса. |
id |
string |
Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Удостоверение ресурса. |
|
kind |
string |
Тип ресурса. |
location |
string |
Географическое расположение, в котором находится ресурс |
name |
string |
Имя ресурса. |
properties |
Свойства учетной записи Cognitive Services. |
|
sku |
Определение модели ресурсов, представляющее SKU |
|
systemData |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
|
tags |
object |
Теги ресурсов. |
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
AccountProperties
Свойства учетной записи Cognitive Services.
Имя | Тип | Описание |
---|---|---|
abusePenalty |
Наказание за злоупотребление. |
|
allowedFqdnList |
string[] |
|
apiProperties |
Свойства API для специальных API. |
|
callRateLimit |
Учетная запись Cognitive Services с ограничением частоты вызовов. |
|
capabilities |
Возвращает возможности учетной записи cognitive services. Каждый элемент указывает возможности определенной функции. Значения доступны только для чтения и только для справки. |
|
commitmentPlanAssociations |
Сопоставления плана обязательств учетной записи Cognitive Services. |
|
customSubDomainName |
string |
Необязательное имя поддомена, используемое для проверки подлинности на основе маркеров. |
dateCreated |
string |
Возвращает дату создания учетной записи Cognitive Services. |
deletionDate |
string |
Дата удаления, доступная только для удаленной учетной записи. |
disableLocalAuth |
boolean |
|
dynamicThrottlingEnabled |
boolean |
Флаг для включения динамического регулирования. |
encryption |
Свойства шифрования для этого ресурса. |
|
endpoint |
string |
Конечная точка созданной учетной записи. |
endpoints |
object |
|
internalId |
string |
Внутренний идентификатор (не рекомендуется, не используйте это свойство). |
isMigrated |
boolean |
Если ресурс переносится из существующего ключа. |
locations |
Параметры учетной записи Cognitive Services в нескольких областях. |
|
migrationToken |
string |
Маркер миграции ресурсов. |
networkAcls |
Коллекция правил, определяющих специальные возможности из определенных сетевых расположений. |
|
privateEndpointConnections |
Подключение к частной конечной точке, связанное с учетной записью Cognitive Services. |
|
provisioningState |
Возвращает состояние учетной записи cognitive services на момент вызова операции. |
|
publicNetworkAccess |
Разрешен ли доступ к общедоступной конечной точке для этой учетной записи. |
|
quotaLimit | ||
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
Запланированная дата очистки, доступная только для удаленной учетной записи. |
skuChangeInfo |
Сведения об изменении номера SKU учетной записи. |
|
userOwnedStorage |
Учетные записи хранения для этого ресурса. |
ApiProperties
Свойства API для специальных API.
Имя | Тип | Описание |
---|---|---|
aadClientId |
string |
(Только помощник по метрикам) Идентификатор клиента Azure AD (идентификатор приложения). |
aadTenantId |
string |
(Только помощник по метрикам) Идентификатор клиента Azure AD. |
eventHubConnectionString |
string |
(Только персонализация) Флаг для включения статистики Поиск Bing. |
qnaAzureSearchEndpointId |
string |
(Только QnAMaker) Идентификатор конечной точки поиска Azure для QnAMaker. |
qnaAzureSearchEndpointKey |
string |
(Только QnAMaker) Ключ конечной точки поиска Azure для QnAMaker. |
qnaRuntimeEndpoint |
string |
(Только QnAMaker) Конечная точка среды выполнения QnAMaker. |
statisticsEnabled |
boolean |
(только Поиск Bing) Флаг для включения статистики Поиск Bing. |
storageAccountConnectionString |
string |
(Только персонализация) Учетная запись хранения строка подключения. |
superUser |
string |
(Только помощник по метрикам) Суперпользовать помощника по метрикам. |
websiteName |
string |
(Только помощник по метрикам) Имя веб-сайта помощника по метрикам. |
CallRateLimit
Учетная запись Cognitive Services с ограничением частоты вызовов.
Имя | Тип | Описание |
---|---|---|
count |
number |
Значение счетчика ограничения скорости вызовов. |
renewalPeriod |
number |
Период продления в секундах ограничения частоты вызовов. |
rules |
CommitmentPlanAssociation
Сопоставление плана обязательств.
Имя | Тип | Описание |
---|---|---|
commitmentPlanId |
string |
Идентификатор ресурса Azure плана обязательств. |
commitmentPlanLocation |
string |
Расположение плана обязательств. |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Encryption
Свойства для настройки шифрования
Имя | Тип | Default value | Описание |
---|---|---|---|
keySource | Microsoft.KeyVault |
Перечисляет возможное значение keySource для шифрования. |
|
keyVaultProperties |
Свойства хранилища ключей |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
Identity
Удостоверение ресурса.
Имя | Тип | Описание |
---|---|---|
principalId |
string |
Идентификатор субъекта удостоверения ресурса. |
tenantId |
string |
Идентификатор клиента ресурса. |
type |
Тип удостоверения. |
|
userAssignedIdentities |
<string,
User |
Список назначенных пользователем удостоверений, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
IpRule
Правило, регулирующее доступность из определенного IP-адреса или диапазона IP-адресов.
Имя | Тип | Описание |
---|---|---|
value |
string |
Диапазон адресов IPv4 в нотации CIDR, например "124.56.78.91" (простой IP-адрес) или "124.56.78.0/24" (все адреса, начинающиеся с 124.56.78). |
keySource
Перечисляет возможное значение keySource для шифрования.
Имя | Тип | Описание |
---|---|---|
Microsoft.CognitiveServices |
string |
|
Microsoft.KeyVault |
string |
KeyVaultProperties
Свойства для настройки свойств хранилища ключей
Имя | Тип | Описание |
---|---|---|
identityClientId |
string |
|
keyName |
string |
Имя ключа из Хранилища ключей |
keyVaultUri |
string |
URI хранилища ключей |
keyVersion |
string |
Версия ключа из Хранилища ключей |
MultiRegionSettings
Учетная запись Cognitive Services для нескольких параметров.
Имя | Тип | Описание |
---|---|---|
regions |
Учетная запись Cognitive Services с ограничением частоты вызовов. |
|
routingMethod |
Методы маршрутизации в нескольких регионах. |
NetworkRuleAction
Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода.
Имя | Тип | Описание |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleSet
Набор правил, определяющих доступность сети.
Имя | Тип | Описание |
---|---|---|
defaultAction |
Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода. |
|
ipRules |
Ip |
Список правил IP-адресов. |
virtualNetworkRules |
Список правил виртуальной сети. |
PrivateEndpoint
Ресурс частной конечной точки.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ARM для частной конечной точки |
PrivateEndpointConnection
Ресурс подключения к частной конечной точке.
Имя | Тип | Описание |
---|---|---|
etag |
string |
Тег ресурса. |
id |
string |
Полный идентификатор ресурса. Пример : /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[] |
Идентификаторы группы ресурсов приватного канала. |
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
Возвращает состояние учетной записи cognitive services на момент вызова операции.
Имя | Тип | Описание |
---|---|---|
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
Учетная запись Cognitive Services с ограничением частоты вызовов.
Имя | Тип | Описание |
---|---|---|
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 |
Идентификатор клиентского приложения, связанный с этим удостоверением. |
principalId |
string |
Идентификатор субъекта Azure Active Directory, связанный с этим удостоверением. |
UserOwnedStorage
Хранилище, принадлежаемое пользователю для учетной записи Cognitive Services.
Имя | Тип | Описание |
---|---|---|
identityClientId |
string |
|
resourceId |
string |
Полный идентификатор ресурса Microsoft.Storage. |
VirtualNetworkRule
Правило, регулирующее специальные возможности из определенной виртуальной сети.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". |
ignoreMissingVnetServiceEndpoint |
boolean |
Игнорировать конечную точку службы виртуальной сети или нет. |
state |
string |
Возвращает состояние правила виртуальной сети. |