Поделиться через


Accounts - Update

Обновления учетной записи Cognitive Services

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

Параметры URI

Имя В Обязательно Тип Описание
accountName
path True

string

Имя учетной записи Cognitive Services.

Шаблон регулярного выражения: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Тип Описание
identity

Identity

Удостоверение ресурса.

kind

string

Тип ресурса.

location

string

Географическое расположение, в котором находится ресурс

properties

AccountProperties

Свойства учетной записи Cognitive Services.

sku

Sku

Определение модели ресурсов, представляющее SKU

tags

object

Теги ресурсов.

Ответы

Имя Тип Описание
200 OK

Account

Поставщик ресурсов должен вернуть 200 (ОК), чтобы указать, что операция успешно завершена.

202 Accepted

Account

HTTP 202 (принято), если операция была успешно запущена и завершится асинхронно.

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции. Если группа ресурсов или ресурс не существуют, необходимо вернуть 404 (NotFound).

Примеры

Update Account

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
AbusePenalty

Наказание за злоупотребление.

AbusePenaltyAction

Действие AbusePenalty.

Account

Учетная запись Cognitive Services — это ресурс Azure, представляющий подготовленную учетную запись, ее тип, расположение и номер SKU.

AccountProperties

Свойства учетной записи Cognitive Services.

ApiProperties

Свойства API для специальных API.

CallRateLimit

Учетная запись Cognitive Services с ограничением частоты вызовов.

CommitmentPlanAssociation

Сопоставление плана обязательств.

createdByType

Тип удостоверения, создавшего ресурс.

Encryption

Свойства для настройки шифрования

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

Identity

Удостоверение ресурса.

IpRule

Правило, регулирующее доступность из определенного IP-адреса или диапазона IP-адресов.

keySource

Перечисляет возможное значение keySource для шифрования.

KeyVaultProperties

Свойства для настройки свойств хранилища ключей

MultiRegionSettings

Учетная запись Cognitive Services для нескольких параметров.

NetworkRuleAction

Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода.

NetworkRuleSet

Набор правил, определяющих доступность сети.

PrivateEndpoint

Ресурс частной конечной точки.

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

PrivateEndpointConnectionProperties

Свойства PrivateEndpointConnectProperties.

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.

ProvisioningState

Возвращает состояние учетной записи cognitive services на момент вызова операции.

PublicNetworkAccess

Разрешен ли доступ к общедоступной конечной точке для этой учетной записи.

QuotaLimit
RegionSetting

Учетная запись Cognitive Services с ограничением частоты вызовов.

RequestMatchPattern
ResourceIdentityType

Тип удостоверения.

RoutingMethods

Методы маршрутизации в нескольких регионах.

Sku

Определение модели ресурсов, представляющее SKU

SkuCapability

SkuCapability указывает на возможности определенной функции.

SkuChangeInfo

Сведения об изменении номера SKU учетной записи.

SkuTier

Это поле должно быть реализовано поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

ThrottlingRule
UserAssignedIdentity

Управляемое удостоверение, назначаемое пользователем

UserOwnedStorage

Хранилище, принадлежаемое пользователю для учетной записи Cognitive Services.

VirtualNetworkRule

Правило, регулирующее специальные возможности из определенной виртуальной сети.

AbusePenalty

Наказание за злоупотребление.

Имя Тип Описание
action

AbusePenaltyAction

Действие 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

Identity

Удостоверение ресурса.

kind

string

Тип ресурса.

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties

AccountProperties

Свойства учетной записи Cognitive Services.

sku

Sku

Определение модели ресурсов, представляющее SKU

systemData

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AccountProperties

Свойства учетной записи Cognitive Services.

Имя Тип Описание
abusePenalty

AbusePenalty

Наказание за злоупотребление.

allowedFqdnList

string[]

apiProperties

ApiProperties

Свойства API для специальных API.

callRateLimit

CallRateLimit

Учетная запись Cognitive Services с ограничением частоты вызовов.

capabilities

SkuCapability[]

Возвращает возможности учетной записи cognitive services. Каждый элемент указывает возможности определенной функции. Значения доступны только для чтения и только для справки.

commitmentPlanAssociations

CommitmentPlanAssociation[]

Сопоставления плана обязательств учетной записи Cognitive Services.

customSubDomainName

string

Необязательное имя поддомена, используемое для проверки подлинности на основе маркеров.

dateCreated

string

Возвращает дату создания учетной записи Cognitive Services.

deletionDate

string

Дата удаления, доступная только для удаленной учетной записи.

disableLocalAuth

boolean

dynamicThrottlingEnabled

boolean

Флаг для включения динамического регулирования.

encryption

Encryption

Свойства шифрования для этого ресурса.

endpoint

string

Конечная точка созданной учетной записи.

endpoints

object

internalId

string

Внутренний идентификатор (не рекомендуется, не используйте это свойство).

isMigrated

boolean

Если ресурс переносится из существующего ключа.

locations

MultiRegionSettings

Параметры учетной записи Cognitive Services в нескольких областях.

migrationToken

string

Маркер миграции ресурсов.

networkAcls

NetworkRuleSet

Коллекция правил, определяющих специальные возможности из определенных сетевых расположений.

privateEndpointConnections

PrivateEndpointConnection[]

Подключение к частной конечной точке, связанное с учетной записью Cognitive Services.

provisioningState

ProvisioningState

Возвращает состояние учетной записи cognitive services на момент вызова операции.

publicNetworkAccess

PublicNetworkAccess

Разрешен ли доступ к общедоступной конечной точке для этой учетной записи.

quotaLimit

QuotaLimit

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

Запланированная дата очистки, доступная только для удаленной учетной записи.

skuChangeInfo

SkuChangeInfo

Сведения об изменении номера SKU учетной записи.

userOwnedStorage

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

ThrottlingRule[]

CommitmentPlanAssociation

Сопоставление плана обязательств.

Имя Тип Описание
commitmentPlanId

string

Идентификатор ресурса Azure плана обязательств.

commitmentPlanLocation

string

Расположение плана обязательств.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

Encryption

Свойства для настройки шифрования

Имя Тип Default value Описание
keySource

keySource

Microsoft.KeyVault

Перечисляет возможное значение keySource для шифрования.

keyVaultProperties

KeyVaultProperties

Свойства хранилища ключей

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

Identity

Удостоверение ресурса.

Имя Тип Описание
principalId

string

Идентификатор субъекта удостоверения ресурса.

tenantId

string

Идентификатор клиента ресурса.

type

ResourceIdentityType

Тип удостоверения.

userAssignedIdentities

<string,  UserAssignedIdentity>

Список назначенных пользователем удостоверений, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов 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

RegionSetting[]

Учетная запись Cognitive Services с ограничением частоты вызовов.

routingMethod

RoutingMethods

Методы маршрутизации в нескольких регионах.

NetworkRuleAction

Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода.

Имя Тип Описание
Allow

string

Deny

string

NetworkRuleSet

Набор правил, определяющих доступность сети.

Имя Тип Описание
defaultAction

NetworkRuleAction

Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода.

ipRules

IpRule[]

Список правил IP-адресов.

virtualNetworkRules

VirtualNetworkRule[]

Список правил виртуальной сети.

PrivateEndpoint

Ресурс частной конечной точки.

Имя Тип Описание
id

string

Идентификатор ARM для частной конечной точки

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

Имя Тип Описание
etag

string

Тег ресурса.

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.

Имя Тип Описание
groupIds

string[]

Идентификаторы группы ресурсов приватного канала.

privateEndpoint

PrivateEndpoint

Ресурс частной конечной точки.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.

provisioningState

PrivateEndpointConnectionProvisioningState

Состояние подготовки ресурса подключения к частной конечной точке.

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

Имя Тип Описание
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

Имя Тип Описание
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.

Имя Тип Описание
actionsRequired

string

Сообщение, указывающее, требуют ли изменения в поставщике услуг каких-либо обновлений для потребителя.

description

string

Причина утверждения или отклонения подключения.

status

PrivateEndpointServiceConnectionStatus

Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы.

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

ThrottlingRule[]

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

SkuTier

Это поле должно быть реализовано поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для 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

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.

ThrottlingRule

Имя Тип Описание
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

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

Возвращает состояние правила виртуальной сети.