Accounts - Get
Retorna uma conta dos Serviços Cognitivos especificada pelos parâmetros.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2023-05-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
account
|
path | True |
string |
O nome da conta dos Serviços Cognitivos. Padrão Regex: |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
O provedor de recursos deve retornar 200 (OK) para indicar que a operação foi concluída com êxito. Para obter uma explicação detalhada de cada campo no corpo da resposta, consulte a descrição do corpo da solicitação na seção Recurso PUT. As únicas propriedades específicas get são "name", "type" e "id". Tipo de Descrição do Campo necessário. Cadeia de caracteres. O conjunto de APIs para essa conta de API. Pode ser · uma única API, por exemplo: API de Detecção Facial, API de Visão, API de Fala. um pacote de APIs: Detecção Facial + Fala, Visão + Emoção etc. sku.name Obrigatório. O tipo de preço/plano dessa API. Pode ser: F0 – B0 Gratuito – Basic S0 – Standard P0 – Premium |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. Se o recurso não existir, 404 (NotFound) deverá ser retornado. |
Exemplos
Get Account
Solicitação de exemplo
Resposta de exemplo
{
"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"
}
}
Definições
Nome | Description |
---|---|
Abuse |
A pena de abuso. |
Abuse |
A ação de AbusePenalty. |
Account |
A conta dos Serviços Cognitivos é um recurso do Azure que representa a conta provisionada, seu tipo, local e SKU. |
Account |
Propriedades da conta dos Serviços Cognitivos. |
Api |
As propriedades da API para APIs especiais. |
Call |
A conta dos Serviços Cognitivos do limite de taxa de chamada. |
Commitment |
A associação do plano de compromisso. |
created |
O tipo de identidade que criou o recurso. |
Encryption |
Propriedades para configurar a criptografia |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
Os detalhes do erro. |
Error |
Resposta de erro |
Identity |
Identidade do recurso. |
Ip |
Uma regra que rege a acessibilidade de um endereço IP ou intervalo ip específico. |
key |
Enumera o valor possível de keySource para Criptografia |
Key |
Propriedades para configurar as propriedades do keyVault |
Multi |
A conta dos Serviços Cognitivos de configurações de várias regiões. |
Network |
A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade de bypass é avaliada. |
Network |
Um conjunto de regras que regem a acessibilidade de rede. |
Private |
O recurso ponto de extremidade privado. |
Private |
O recurso conexão de ponto de extremidade privado. |
Private |
Propriedades do PrivateEndpointConnectProperties. |
Private |
O estado de provisionamento atual. |
Private |
A conexão do ponto de extremidade privado status. |
Private |
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. |
Provisioning |
Obtém o status da conta de serviços cognitivos no momento em que a operação foi chamada. |
Public |
Se o acesso ao ponto de extremidade público é permitido ou não para essa conta. |
Quota |
|
Region |
A conta dos Serviços Cognitivos do limite de taxa de chamada. |
Request |
|
Resource |
O tipo de identidade. |
Routing |
Métodos de roteamento de várias regiões. |
Sku |
A definição do modelo de recurso que representa o SKU |
Sku |
SkuCapability indica a capacidade de um determinado recurso. |
Sku |
Informações de alteração de SKU da conta. |
Sku |
Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT. |
system |
Metadados relativos à criação e à última modificação do recurso. |
Throttling |
|
User |
Identidade gerenciada atribuída ao usuário. |
User |
O armazenamento de propriedade do usuário para a conta dos Serviços Cognitivos. |
Virtual |
Uma regra que rege a acessibilidade de uma rede virtual específica. |
AbusePenalty
A pena de abuso.
Nome | Tipo | Description |
---|---|---|
action |
A ação de AbusePenalty. |
|
expiration |
string |
A datetime de expiração do AbusePenalty. |
rateLimitPercentage |
number |
O percentual de limite de taxa. |
AbusePenaltyAction
A ação de AbusePenalty.
Nome | Tipo | Description |
---|---|---|
Block |
string |
|
Throttle |
string |
Account
A conta dos Serviços Cognitivos é um recurso do Azure que representa a conta provisionada, seu tipo, local e SKU.
Nome | Tipo | Description |
---|---|---|
etag |
string |
Etag de recurso. |
id |
string |
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Identidade do recurso. |
|
kind |
string |
O Tipo do recurso. |
location |
string |
A localização geográfica em que o recurso reside |
name |
string |
O nome do recurso |
properties |
Propriedades da conta dos Serviços Cognitivos. |
|
sku |
A definição do modelo de recurso que representa o SKU |
|
systemData |
Metadados relativos à criação e à última modificação do recurso. |
|
tags |
object |
Marcas de recurso. |
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
AccountProperties
Propriedades da conta dos Serviços Cognitivos.
Nome | Tipo | Description |
---|---|---|
abusePenalty |
A pena de abuso. |
|
allowedFqdnList |
string[] |
|
apiProperties |
As propriedades da API para APIs especiais. |
|
callRateLimit |
A conta dos Serviços Cognitivos do limite de taxa de chamada. |
|
capabilities |
Obtém os recursos da conta de serviços cognitivos. Cada item indica a funcionalidade de um recurso específico. Os valores são somente leitura e somente para referência. |
|
commitmentPlanAssociations |
As associações de plano de compromisso da conta dos Serviços Cognitivos. |
|
customSubDomainName |
string |
Nome do subdomínio opcional usado para autenticação baseada em token. |
dateCreated |
string |
Obtém a data de criação da conta de serviços cognitivos. |
deletionDate |
string |
A data de exclusão, disponível apenas para a conta excluída. |
disableLocalAuth |
boolean |
|
dynamicThrottlingEnabled |
boolean |
O sinalizador para habilitar a limitação dinâmica. |
encryption |
As propriedades de criptografia para esse recurso. |
|
endpoint |
string |
Ponto de extremidade da conta criada. |
endpoints |
object |
|
internalId |
string |
O identificador interno (preterido, não use essa propriedade). |
isMigrated |
boolean |
Se o recurso for migrado de uma chave existente. |
locations |
As configurações de várias regiões da conta dos Serviços Cognitivos. |
|
migrationToken |
string |
Token de migração de recursos. |
networkAcls |
Uma coleção de regras que regem a acessibilidade de locais de rede específicos. |
|
privateEndpointConnections |
A conexão de ponto de extremidade privado associada à conta dos Serviços Cognitivos. |
|
provisioningState |
Obtém o status da conta de serviços cognitivos no momento em que a operação foi chamada. |
|
publicNetworkAccess |
Se o acesso ao ponto de extremidade público é permitido ou não para essa conta. |
|
quotaLimit | ||
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
A data de limpeza agendada, disponível apenas para a conta excluída. |
skuChangeInfo |
Informações de alteração de SKU da conta. |
|
userOwnedStorage |
As contas de armazenamento para esse recurso. |
ApiProperties
As propriedades da API para APIs especiais.
Nome | Tipo | Description |
---|---|---|
aadClientId |
string |
(Somente Assistente de Métricas) A ID do cliente Azure AD (ID do aplicativo). |
aadTenantId |
string |
(Somente Assistente de Métricas) A ID do locatário do Azure AD. |
eventHubConnectionString |
string |
(Somente personalização) O sinalizador para habilitar estatísticas de Pesquisa do Bing. |
qnaAzureSearchEndpointId |
string |
(Somente QnAMaker) A ID do ponto de extremidade do Azure Search do QnAMaker. |
qnaAzureSearchEndpointKey |
string |
(Somente QnAMaker) A chave de ponto de extremidade do Azure Search do QnAMaker. |
qnaRuntimeEndpoint |
string |
(Somente QnAMaker) O ponto de extremidade de runtime do QnAMaker. |
statisticsEnabled |
boolean |
(somente Pesquisa do Bing) O sinalizador para habilitar estatísticas de Pesquisa do Bing. |
storageAccountConnectionString |
string |
(Somente personalização) A conta de armazenamento cadeia de conexão. |
superUser |
string |
(Somente Assistente de Métricas) O superusuário do Assistente de Métricas. |
websiteName |
string |
(Somente Assistente de Métricas) O nome do site do Assistente de Métricas. |
CallRateLimit
A conta dos Serviços Cognitivos do limite de taxa de chamada.
Nome | Tipo | Description |
---|---|---|
count |
number |
O valor de contagem de Limite de Taxa de Chamada. |
renewalPeriod |
number |
O período de renovação em segundos de Limite de Taxa de Chamada. |
rules |
CommitmentPlanAssociation
A associação do plano de compromisso.
Nome | Tipo | Description |
---|---|---|
commitmentPlanId |
string |
A ID de recurso do Azure do plano de compromisso. |
commitmentPlanLocation |
string |
O local do plano de compromisso. |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Encryption
Propriedades para configurar a criptografia
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
keySource | Microsoft.KeyVault |
Enumera o valor possível de keySource para Criptografia |
|
keyVaultProperties |
Propriedades do KeyVault |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
Os detalhes do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
Identity
Identidade do recurso.
Nome | Tipo | Description |
---|---|---|
principalId |
string |
A ID da entidade de segurança da identidade do recurso. |
tenantId |
string |
A ID do locatário do recurso. |
type |
O tipo de identidade. |
|
userAssignedIdentities |
<string,
User |
A lista de identidades atribuídas pelo usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
IpRule
Uma regra que rege a acessibilidade de um endereço IP ou intervalo ip específico.
Nome | Tipo | Description |
---|---|---|
value |
string |
Um intervalo de endereços IPv4 na notação CIDR, como '124.56.78.91' (endereço IP simples) ou '124.56.78.0/24' (todos os endereços que começam com 124.56.78). |
keySource
Enumera o valor possível de keySource para Criptografia
Nome | Tipo | Description |
---|---|---|
Microsoft.CognitiveServices |
string |
|
Microsoft.KeyVault |
string |
KeyVaultProperties
Propriedades para configurar as propriedades do keyVault
Nome | Tipo | Description |
---|---|---|
identityClientId |
string |
|
keyName |
string |
Nome da chave do KeyVault |
keyVaultUri |
string |
URI do KeyVault |
keyVersion |
string |
Versão da chave do KeyVault |
MultiRegionSettings
A conta dos Serviços Cognitivos de configurações de várias regiões.
Nome | Tipo | Description |
---|---|---|
regions |
A conta dos Serviços Cognitivos do limite de taxa de chamada. |
|
routingMethod |
Métodos de roteamento de várias regiões. |
NetworkRuleAction
A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade de bypass é avaliada.
Nome | Tipo | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleSet
Um conjunto de regras que regem a acessibilidade de rede.
Nome | Tipo | Description |
---|---|---|
defaultAction |
A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade de bypass é avaliada. |
|
ipRules |
Ip |
A lista de regras de endereço IP. |
virtualNetworkRules |
A lista de regras de rede virtual. |
PrivateEndpoint
O recurso ponto de extremidade privado.
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador do ARM para o ponto de extremidade privado |
PrivateEndpointConnection
O recurso conexão de ponto de extremidade privado.
Nome | Tipo | Description |
---|---|---|
etag |
string |
Etag de recurso. |
id |
string |
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
O local da conexão de ponto de extremidade privado |
name |
string |
O nome do recurso |
properties |
Propriedades do recurso. |
|
systemData |
Metadados relativos à criação e à última modificação do recurso. |
|
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProperties
Propriedades do PrivateEndpointConnectProperties.
Nome | Tipo | Description |
---|---|---|
groupIds |
string[] |
As IDs do grupo de recursos do link privado. |
privateEndpoint |
O recurso do ponto de extremidade privado. |
|
privateLinkServiceConnectionState |
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. |
|
provisioningState |
O estado de provisionamento do recurso de conexão de ponto de extremidade privado. |
PrivateEndpointConnectionProvisioningState
O estado de provisionamento atual.
Nome | Tipo | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
A conexão do ponto de extremidade privado status.
Nome | Tipo | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
Nome | Tipo | Description |
---|---|---|
actionsRequired |
string |
Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor. |
description |
string |
O motivo da aprovação/rejeição da conexão. |
status |
Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. |
ProvisioningState
Obtém o status da conta de serviços cognitivos no momento em que a operação foi chamada.
Nome | Tipo | Description |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
ResolvingDNS |
string |
|
Succeeded |
string |
PublicNetworkAccess
Se o acesso ao ponto de extremidade público é permitido ou não para essa conta.
Nome | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
QuotaLimit
Nome | Tipo | Description |
---|---|---|
count |
number |
|
renewalPeriod |
number |
|
rules |
RegionSetting
A conta dos Serviços Cognitivos do limite de taxa de chamada.
Nome | Tipo | Description |
---|---|---|
customsubdomain |
string |
Mapeia a região para o subdomínio personalizado regional. |
name |
string |
Nome da região. |
value |
number |
Um valor para métodos de roteamento ponderados ou de prioridade. |
RequestMatchPattern
Nome | Tipo | Description |
---|---|---|
method |
string |
|
path |
string |
ResourceIdentityType
O tipo de identidade.
Nome | Tipo | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RoutingMethods
Métodos de roteamento de várias regiões.
Nome | Tipo | Description |
---|---|---|
Performance |
string |
|
Priority |
string |
|
Weighted |
string |
Sku
A definição do modelo de recurso que representa o SKU
Nome | Tipo | Description |
---|---|---|
capacity |
integer |
Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se expansão/redução não for possível para o recurso, isso poderá ser omitido. |
family |
string |
Se o serviço tiver gerações diferentes de hardware, para a mesma SKU, isso poderá ser capturado aqui. |
name |
string |
O nome da SKU. Ex - P3. Normalmente, é um código de letra+número |
size |
string |
O tamanho do SKU. Quando o campo de nome é a combinação de camada e algum outro valor, esse seria o código autônomo. |
tier |
Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT. |
SkuCapability
SkuCapability indica a capacidade de um determinado recurso.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome do SkuCapability. |
value |
string |
O valor do SkuCapability. |
SkuChangeInfo
Informações de alteração de SKU da conta.
Nome | Tipo | Description |
---|---|---|
countOfDowngrades |
number |
Obtém a contagem de downgrades. |
countOfUpgradesAfterDowngrades |
number |
Obtém a contagem de atualizações após downgrades. |
lastChangeDate |
string |
Obtém a data da última alteração. |
SkuTier
Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.
Nome | Tipo | Description |
---|---|---|
Basic |
string |
|
Enterprise |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
Metadados relativos à criação e à última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
ThrottlingRule
Nome | Tipo | Description |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |
UserAssignedIdentity
Identidade gerenciada atribuída ao usuário.
Nome | Tipo | Description |
---|---|---|
clientId |
string |
ID do aplicativo cliente associada a essa identidade. |
principalId |
string |
ID da entidade de segurança do Azure Active Directory associada a essa Identidade. |
UserOwnedStorage
O armazenamento de propriedade do usuário para a conta dos Serviços Cognitivos.
Nome | Tipo | Description |
---|---|---|
identityClientId |
string |
|
resourceId |
string |
ID de recurso completa de um recurso Microsoft.Storage. |
VirtualNetworkRule
Uma regra que rege a acessibilidade de uma rede virtual específica.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completa de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. |
ignoreMissingVnetServiceEndpoint |
boolean |
Ignorar o ponto de extremidade de serviço de vnet ausente ou não. |
state |
string |
Obtém o estado da regra de rede virtual. |