Accounts - Get
Возвращает учетную запись Cognitive Services, указанную параметрами.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2024-10-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
account
|
path | True |
string minLength: 2maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ |
Имя учетной записи Cognitive Services. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя не учитывает регистр. |
subscription
|
path | True |
string minLength: 1 |
Идентификатор целевой подписки. |
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для этой операции. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Поставщик ресурсов должен вернуть 200 (ОК), чтобы указать, что операция выполнена успешно. Подробное описание каждого поля в тексте ответа см. в описании текста запроса в разделе ресурса PUT. Единственными свойствами GET являются "name", "type" и "id". Требуется тип описания поля. Струна. Набор API для этой учетной записи API. Это может быть · один API, например API распознавания лиц, API визуального распознавания, API службы "Речь". пакет API: Face + Speech, Vision + Emotion и т. д. sku.name Обязательный. Ценовая категория или план этого API. Может быть: F0 - Бесплатный B0 - Basic S0 - Standard P0 - Premium |
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. Если ресурс не существует, возвращается значение 404 (NotFound). |
Примеры
Get Account
Образец запроса
Пример ответа
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount",
"name": "myAccount",
"type": "Microsoft.CognitiveServices/accounts",
"location": "westus",
"sku": {
"name": "F0"
},
"kind": "Emotion",
"tags": {
"Owner": "felixwa",
"ExpiredDate": "2017/09/01"
},
"etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded"
}
}
Определения
Имя | Описание |
---|---|
Abuse |
Наказание за злоупотребление. |
Abuse |
Действие AbusePenalty. |
Account |
Учетная запись Cognitive Services — это ресурс Azure, представляющий подготовленную учетную запись, тип, расположение и номер SKU. |
Account |
Свойства учетной записи Cognitive Services. |
Api |
Свойства API для специальных API. |
By |
Настройка доверенных служб. |
Call |
Учетная запись Ограничения частоты вызовов Cognitive Services. |
Commitment |
Ассоциация плана обязательств. |
created |
Тип удостоверения, создавшего ресурс. |
Encryption |
Свойства для настройки шифрования |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Identity |
Удостоверение ресурса. |
Ip |
Правило, которое управляет специальными возможностями из определенного IP-адреса или диапазона IP-адресов. |
key |
Перечисляет возможное значение keySource для шифрования |
Key |
Свойства для настройки свойств keyVault |
Multi |
Учетная запись Cognitive Services с несколькими агрегатами. |
Network |
Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода. |
Network |
Набор правил, определяющих доступность сети. |
Private |
Ресурс частной конечной точки. |
Private |
Ресурс подключения к частной конечной точке. |
Private |
Свойства PrivateEndpointConnectProperties. |
Private |
Текущее состояние подготовки. |
Private |
Состояние подключения к частной конечной точке. |
Private |
Коллекция сведений о состоянии подключения между потребителем службы и поставщиком. |
Provisioning |
Получает состояние учетной записи cognitive services во время вызова операции. |
Public |
Разрешен доступ к общедоступной конечной точке для этой учетной записи. |
Quota |
|
Rai |
Конфигурация монитора Rai в Cognitive Services. |
Region |
Учетная запись Ограничения частоты вызовов Cognitive Services. |
Request |
|
Resource |
Тип удостоверения. |
Routing |
Методы многорегионной маршрутизации. |
Sku |
Определение модели ресурсов, представляющее номер SKU |
Sku |
SkuCapability указывает на возможность определенной функции. |
Sku |
Сведения об изменении номера Sku учетной записи. |
Sku |
Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT. |
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
Throttling |
|
User |
Назначаемое пользователем управляемое удостоверение. |
User |
Пользователь владеет рабочей областью AML для учетной записи Cognitive Services. |
User |
Хранилище, принадлежаемое пользователю для учетной записи Cognitive Services. |
Virtual |
Правило, которое управляет специальными возможностями из определенной виртуальной сети. |
AbusePenalty
Наказание за злоупотребление.
Имя | Тип | Описание |
---|---|---|
action |
Действие AbusePenalty. |
|
expiration |
string (date-time) |
Дата окончания срока действия приложения AbusePenalty. |
rateLimitPercentage |
number |
Процент ограничения скорости. |
AbusePenaltyAction
Действие AbusePenalty.
Значение | Описание |
---|---|
Block | |
Throttle |
Account
Учетная запись Cognitive Services — это ресурс Azure, представляющий подготовленную учетную запись, тип, расположение и номер SKU.
Имя | Тип | Описание |
---|---|---|
etag |
string |
Etag ресурса. |
id |
string |
Полный идентификатор ресурса для ресурса. Ex - /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[] |
|
amlWorkspace |
Свойства рабочей области AML, принадлежащие пользователю. |
|
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 | ||
raiMonitorConfig |
Конфигурация монитора Rai в Cognitive Services. |
|
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
Дата запланированной очистки, доступная только для удаленной учетной записи. |
skuChangeInfo |
Сведения об изменении номера Sku учетной записи. |
|
userOwnedStorage |
Учетные записи хранения для этого ресурса. |
ApiProperties
Свойства API для специальных API.
Имя | Тип | Описание |
---|---|---|
aadClientId |
string maxLength: 500 |
(Только помощник по метрикам) Идентификатор клиента Azure AD (идентификатор приложения). |
aadTenantId |
string maxLength: 500 |
(Только помощник по метрикам) Идентификатор клиента Azure AD. |
eventHubConnectionString |
string maxLength: 1000pattern: ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$ |
(Только персонализация) Флаг для включения статистики поиска Bing. |
qnaAzureSearchEndpointId |
string |
(только QnAMaker) Идентификатор конечной точки поиска Azure qnAMaker. |
qnaAzureSearchEndpointKey |
string |
(только QnAMaker) Ключ конечной точки поиска Azure в QnAMaker. |
qnaRuntimeEndpoint |
string |
(только QnAMaker) Конечная точка среды выполнения QnAMaker. |
statisticsEnabled |
boolean |
(Только поиск Bing) Флаг для включения статистики поиска Bing. |
storageAccountConnectionString |
string maxLength: 1000pattern: ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$ |
(Только персонализация) Строка подключения учетной записи хранения. |
superUser |
string maxLength: 500 |
(Только помощник по метрикам) Супер пользователь помощника по метрикам. |
websiteName |
string maxLength: 500 |
(Только помощник по метрикам) Имя веб-сайта помощника по метрикам. |
ByPassSelection
Настройка доверенных служб.
Значение | Описание |
---|---|
AzureServices | |
None |
CallRateLimit
Учетная запись Ограничения частоты вызовов Cognitive Services.
Имя | Тип | Описание |
---|---|---|
count |
number |
Значение счетчика ограничения частоты звонков. |
renewalPeriod |
number |
Период продления в секундах ограничения частоты звонков. |
rules |
CommitmentPlanAssociation
Ассоциация плана обязательств.
Имя | Тип | Описание |
---|---|---|
commitmentPlanId |
string |
Идентификатор ресурса Azure плана обязательств. |
commitmentPlanLocation |
string |
Расположение плана обязательств. |
createdByType
Тип удостоверения, создавшего ресурс.
Значение | Описание |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
Encryption
Свойства для настройки шифрования
Имя | Тип | Default value | Описание |
---|---|---|---|
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 |
Идентификатор субъекта удостоверения ресурса. |
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 | |
Microsoft.KeyVault |
KeyVaultProperties
Свойства для настройки свойств keyVault
Имя | Тип | Описание |
---|---|---|
identityClientId |
string |
|
keyName |
string |
Имя ключа из KeyVault |
keyVaultUri |
string |
Универсальный код ресурса (URI) keyVault |
keyVersion |
string |
Версия ключа из KeyVault |
MultiRegionSettings
Учетная запись Cognitive Services с несколькими агрегатами.
Имя | Тип | Описание |
---|---|---|
regions |
Учетная запись Ограничения частоты вызовов Cognitive Services. |
|
routingMethod |
Методы многорегионной маршрутизации. |
NetworkRuleAction
Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода.
Значение | Описание |
---|---|
Allow | |
Deny |
NetworkRuleSet
Набор правил, определяющих доступность сети.
Имя | Тип | Описание |
---|---|---|
bypass |
Настройка доверенных служб. |
|
defaultAction |
Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода. |
|
ipRules |
Ip |
Список правил IP-адресов. |
virtualNetworkRules |
Список правил виртуальной сети. |
PrivateEndpoint
Ресурс частной конечной точки.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ARM для частной конечной точки |
PrivateEndpointConnection
Ресурс подключения к частной конечной точке.
Имя | Тип | Описание |
---|---|---|
etag |
string |
Etag ресурса. |
id |
string |
Полный идентификатор ресурса для ресурса. Ex - /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 | |
Deleting | |
Failed | |
Succeeded |
PrivateEndpointServiceConnectionStatus
Состояние подключения к частной конечной точке.
Значение | Описание |
---|---|
Approved | |
Pending | |
Rejected |
PrivateLinkServiceConnectionState
Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
Имя | Тип | Описание |
---|---|---|
actionsRequired |
string |
Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя. |
description |
string |
Причина утверждения или отклонения подключения. |
status |
Указывает, утверждено ли подключение, отклонено или удалено владельцем службы. |
ProvisioningState
Получает состояние учетной записи cognitive services во время вызова операции.
Значение | Описание |
---|---|
Accepted | |
Creating | |
Deleting | |
Failed | |
Moving | |
ResolvingDNS | |
Succeeded |
PublicNetworkAccess
Разрешен доступ к общедоступной конечной точке для этой учетной записи.
Значение | Описание |
---|---|
Disabled | |
Enabled |
QuotaLimit
Имя | Тип | Описание |
---|---|---|
count |
number |
|
renewalPeriod |
number |
|
rules |
RaiMonitorConfig
Конфигурация монитора Rai в Cognitive Services.
Имя | Тип | Описание |
---|---|---|
adxStorageResourceId |
string |
Идентификатор ресурса хранилища. |
identityClientId |
string |
Идентификатор клиента удостоверений для доступа к хранилищу. |
RegionSetting
Учетная запись Ограничения частоты вызовов Cognitive Services.
Имя | Тип | Описание |
---|---|---|
customsubdomain |
string |
Сопоставляет регион с региональным пользовательским поддоменом. |
name |
string |
Имя региона. |
value |
number |
Значение для методов маршрутизации с приоритетом или весовым значением. |
RequestMatchPattern
Имя | Тип | Описание |
---|---|---|
method |
string |
|
path |
string |
ResourceIdentityType
Тип удостоверения.
Значение | Описание |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
RoutingMethods
Методы многорегионной маршрутизации.
Значение | Описание |
---|---|
Performance | |
Priority | |
Weighted |
Sku
Определение модели ресурсов, представляющее номер SKU
Имя | Тип | Описание |
---|---|---|
capacity |
integer (int32) |
Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено. |
family |
string |
Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. |
name |
string |
Имя номера SKU. Ex - 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 | |
Enterprise | |
Free | |
Premium | |
Standard |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string (date-time) |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |
ThrottlingRule
Имя | Тип | Описание |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |
UserAssignedIdentity
Назначаемое пользователем управляемое удостоверение.
Имя | Тип | Описание |
---|---|---|
clientId |
string |
Идентификатор клиентского приложения, связанный с этим удостоверением. |
principalId |
string |
Идентификатор субъекта Azure Active Directory, связанный с этим удостоверением. |
UserOwnedAmlWorkspace
Пользователь владеет рабочей областью AML для учетной записи Cognitive Services.
Имя | Тип | Описание |
---|---|---|
identityClientId |
string |
Идентификатор клиента удостоверения ресурса рабочей области AML. |
resourceId |
string |
Полный идентификатор ресурса рабочей области AML. |
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 |
Возвращает состояние правила виртуальной сети. |