Accounts - List

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-10-01

Retorna todos os recursos de um tipo específico pertencentes a uma assinatura.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts?api-version=2024-10-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	AccountListResult	O provedor de recursos deve retornar 200 (OK) para indicar que a operação foi concluída com êxito. Para outros erros (por exemplo, erros internos) use o código de erro HTTP apropriado. Espera-se que o campo nextLink aponte para a URL que o cliente deve usar para buscar a próxima página (por paginação do lado do servidor). Isso corresponde às diretrizes do OData para respostas paginadas. Se um provedor de recursos não oferecer suporte à paginação, ele deverá retornar o mesmo corpo, mas deixar nextLink vazio para compatibilidade futura. 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 de recursos PUT.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou

Exemplos

List Accounts by Subscription

Pedido de amostra

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.CognitiveServices/accounts?api-version=2024-10-01


/**
 * Samples for Accounts List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListAccountsBySubscription.json
     */
    /**
     * Sample code: List Accounts by Subscription.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        listAccountsBySubscription(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.accounts().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python list_accounts_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    )

    response = client.accounts.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsBySubscription.json
func ExampleAccountsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAccountsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AccountListResult = armcognitiveservices.AccountListResult{
		// 	Value: []*armcognitiveservices.Account{
		// 		{
		// 			Name: to.Ptr("bingSearch"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/accounts"),
		// 			ID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch"),
		// 			Etag: to.Ptr("W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\""),
		// 			Kind: to.Ptr("Bing.Search"),
		// 			Location: to.Ptr("global"),
		// 			Properties: &armcognitiveservices.AccountProperties{
		// 				Endpoint: to.Ptr("https://api.cognitive.microsoft.com/bing/v5.0"),
		// 				ProvisioningState: to.Ptr(armcognitiveservices.ProvisioningStateSucceeded),
		// 			},
		// 			SKU: &armcognitiveservices.SKU{
		// 				Name: to.Ptr("S1"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("CrisProd"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/accounts"),
		// 			ID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd"),
		// 			Etag: to.Ptr("W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\""),
		// 			Kind: to.Ptr("CRIS"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armcognitiveservices.AccountProperties{
		// 				Endpoint: to.Ptr("https://westus.api.cognitive.microsoft.com/sts/v1.0"),
		// 				ProvisioningState: to.Ptr(armcognitiveservices.ProvisioningStateSucceeded),
		// 			},
		// 			SKU: &armcognitiveservices.SKU{
		// 				Name: to.Ptr("S0"),
		// 			},
		// 			Tags: map[string]*string{
		// 				"can't delete it successfully": to.Ptr("v-yunjin"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("rayrptest0308"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/accounts"),
		// 			ID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308"),
		// 			Etag: to.Ptr("W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\""),
		// 			Kind: to.Ptr("Face"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armcognitiveservices.AccountProperties{
		// 				Endpoint: to.Ptr("https://westus.api.cognitive.microsoft.com/face/v1.0"),
		// 				ProvisioningState: to.Ptr(armcognitiveservices.ProvisioningStateSucceeded),
		// 			},
		// 			SKU: &armcognitiveservices.SKU{
		// 				Name: to.Ptr("S0"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("raytest02"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/accounts"),
		// 			ID: to.Ptr("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02"),
		// 			Etag: to.Ptr("W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\""),
		// 			Kind: to.Ptr("Emotion"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armcognitiveservices.AccountProperties{
		// 				Endpoint: to.Ptr("https://westus.api.cognitive.microsoft.com/emotion/v1.0"),
		// 				ProvisioningState: to.Ptr(armcognitiveservices.ProvisioningStateSucceeded),
		// 			},
		// 			SKU: &armcognitiveservices.SKU{
		// 				Name: to.Ptr("S0"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns all the resources of a particular type belonging to a subscription.
 *
 * @summary Returns all the resources of a particular type belonging to a subscription.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsBySubscription.json
 */
async function listAccountsBySubscription() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.accounts.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListAccountsBySubscription.json
// this example is just showing the usage of "Accounts_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (CognitiveServicesAccountResource item in subscriptionResource.GetCognitiveServicesAccountsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    CognitiveServicesAccountData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
      "name": "bingSearch",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "global",
      "sku": {
        "name": "S1"
      },
      "kind": "Bing.Search",
      "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"",
      "properties": {
        "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd",
      "name": "CrisProd",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "CRIS",
      "tags": {
        "can't delete it successfully": "v-yunjin"
      },
      "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308",
      "name": "rayrptest0308",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "Face",
      "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02",
      "name": "raytest02",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "Emotion",
      "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definições

Name	Description
AbusePenalty	A pena de abuso.
AbusePenaltyAction	A ação de AbusePenalty.
Account	A conta de Serviços Cognitivos é um recurso do Azure que representa a conta provisionada, seu tipo, local e SKU.
AccountListResult	A lista de respostas de operação de contas de serviços cognitivos.
AccountProperties	Propriedades da conta de Serviços Cognitivos.
ApiProperties	As propriedades da api para APIs especiais.
ByPassSelection	Configuração para serviços confiáveis.
CallRateLimit	A conta de Serviços Cognitivos de limite de taxa de chamada.
CommitmentPlanAssociation	A associação do plano de compromisso.
createdByType	O tipo de identidade que criou o recurso.
Encryption	Propriedades para configurar a criptografia
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Identity	Identidade do recurso.
IpRule	Uma regra que rege a acessibilidade a partir de um endereço IP específico ou intervalo de ip.
keySource	Enumera o valor possível de keySource for Encryption
KeyVaultProperties	Propriedades para configurar as propriedades do keyVault
MultiRegionSettings	A conta de Serviços Cognitivos de configurações 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 bypass foi avaliada.
NetworkRuleSet	Um conjunto de regras que regem a acessibilidade da rede.
PrivateEndpoint	O recurso Ponto Final Privado.
PrivateEndpointConnection	O recurso Private Endpoint Connection.
PrivateEndpointConnectionProperties	Propriedades do PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
ProvisioningState	Obtém o status da conta de serviços cognitivos no momento em que a operação foi chamada.
PublicNetworkAccess	Se o acesso público ao ponto de extremidade é permitido ou não para essa conta.
QuotaLimit
RaiMonitorConfig	Serviços Cognitivos Rai Monitor Config.
RegionSetting	A conta de Serviços Cognitivos de limite de taxa de chamada.
RequestMatchPattern
ResourceIdentityType	O tipo de identidade.
RoutingMethods	Métodos de roteamento multirregião.
Sku	A definição do modelo de recursos que representa a SKU
SkuCapability	SkuCapability indica a capacidade de um determinado recurso.
SkuChangeInfo	Sku alterar informações da conta.
SkuTier	Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.
systemData	Metadados referentes à criação e última modificação do recurso.
ThrottlingRule
UserAssignedIdentity	Identidade gerenciada atribuída pelo usuário.
UserOwnedAmlWorkspace	O espaço de trabalho AML de propriedade do usuário para a conta de Serviços Cognitivos.
UserOwnedStorage	O armazenamento de propriedade do usuário para a conta de Serviços Cognitivos.
VirtualNetworkRule	Uma regra que rege a acessibilidade a partir de uma rede virtual específica.

AbusePenalty

Object

A pena de abuso.

Name	Tipo	Description
action	AbusePenaltyAction	A ação de AbusePenalty.
expiration	string (date-time)	A data-hora de expiração da AbusePenalty.
rateLimitPercentage	number	A percentagem do limite tarifário.

AbusePenaltyAction

Enumeração

A ação de AbusePenalty.

Valor	Description
Block
Throttle

Account

Object

A conta de Serviços Cognitivos é um recurso do Azure que representa a conta provisionada, seu tipo, local e SKU.

Name	Tipo	Description
etag	string	Etag de recurso.
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identidade do recurso.
kind	string	O tipo do recurso.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties	AccountProperties	Propriedades da conta de Serviços Cognitivos.
sku	Sku	A definição do modelo de recursos que representa a SKU
systemData	systemData	Metadados referentes à criação e última modificação do recurso.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AccountListResult

Object

A lista de respostas de operação de contas de serviços cognitivos.

Name	Tipo	Description
nextLink	string	O link usado para obter a próxima página de contas.
value	Account[]	Obtém a lista de contas de Serviços Cognitivos e suas propriedades.

AccountProperties

Object

Propriedades da conta de Serviços Cognitivos.

Name	Tipo	Description
abusePenalty	AbusePenalty	A pena de abuso.
allowedFqdnList	string[]
amlWorkspace	UserOwnedAmlWorkspace	As propriedades do espaço de trabalho AML de propriedade do usuário.
apiProperties	ApiProperties	As propriedades da api para APIs especiais.
callRateLimit	CallRateLimit	A conta de Serviços Cognitivos de limite de taxa de chamada.
capabilities	SkuCapability[]	Obtém os recursos da conta de serviços cognitivos. Cada item indica a capacidade de um recurso específico. Os valores são somente leitura e apenas para referência.
commitmentPlanAssociations	CommitmentPlanAssociation[]	O plano de compromisso associa a conta de Serviços Cognitivos.
customSubDomainName	string	Nome de 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	Encryption	As propriedades de criptografia para este recurso.
endpoint	string	Ponto de extremidade da conta criada.
endpoints	object
internalId	string	O identificador interno (preterido, não use esta propriedade).
isMigrated	boolean	Se o recurso for migrado de uma chave existente.
locations	MultiRegionSettings	As configurações de várias regiões da conta de Serviços Cognitivos.
migrationToken	string	Token de migração de recursos.
networkAcls	NetworkRuleSet	Um conjunto de regras que regem a acessibilidade a partir de locais de rede específicos.
privateEndpointConnections	PrivateEndpointConnection[]	A conexão de ponto de extremidade privada associada à conta de Serviços Cognitivos.
provisioningState	ProvisioningState	Obtém o status da conta de serviços cognitivos no momento em que a operação foi chamada.
publicNetworkAccess	PublicNetworkAccess	Se o acesso público ao ponto de extremidade é permitido ou não para essa conta.
quotaLimit	QuotaLimit
raiMonitorConfig	RaiMonitorConfig	Serviços Cognitivos Rai Monitor Config.
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	A data de limpeza agendada, disponível apenas para conta excluída.
skuChangeInfo	SkuChangeInfo	Sku alterar informações da conta.
userOwnedStorage	UserOwnedStorage[]	O armazenamento é responsável por esse recurso.

ApiProperties

Object

As propriedades da api para APIs especiais.

Name	Tipo	Description
aadClientId	string maxLength: 500	(Somente Consultor de Métricas) A ID do Cliente do Azure AD (ID do Aplicativo).
aadTenantId	string maxLength: 500	(Somente Consultor de Métricas) A ID do locatário do Azure AD.
eventHubConnectionString	string maxLength: 1000 pattern: ^( )Endpoint=sb://(.);( )SharedAccessKeyName=(.);( )SharedAccessKey=(.)$	(Apenas personalização) O sinalizador para habilitar estatísticas da Pesquisa do Bing.
qnaAzureSearchEndpointId	string	(Apenas QnAMaker) A ID do ponto de extremidade do Azure Search do QnAMaker.
qnaAzureSearchEndpointKey	string	(Apenas QnAMaker) A chave do ponto de extremidade do Azure Search do QnAMaker.
qnaRuntimeEndpoint	string	(Apenas QnAMaker) O ponto de extremidade de tempo de execução do QnAMaker.
statisticsEnabled	boolean	(Somente Pesquisa do Bing) O sinalizador para habilitar estatísticas da Pesquisa do Bing.
storageAccountConnectionString	string maxLength: 1000 pattern: ^(( )DefaultEndpointsProtocol=(http\|https)( );( ))?AccountName=(.)AccountKey=(.)EndpointSuffix=(.)$	(Apenas personalização) A cadeia de conexão da conta de armazenamento.
superUser	string maxLength: 500	(Somente Consultor de Métricas) O super usuário do Metrics Advisor.
websiteName	string maxLength: 500	(Somente Consultor de Métricas) O nome do site do Metrics Advisor.

ByPassSelection

Enumeração

Configuração para serviços confiáveis.

Valor	Description
AzureServices
None

CallRateLimit

Object

A conta de Serviços Cognitivos de limite de taxa de chamada.

Name	Tipo	Description
count	number	O valor de contagem de Limite de Taxa de Chamada.
renewalPeriod	number	O período de renovação em segundos do Limite de Taxa de Chamada.
rules	ThrottlingRule[]

CommitmentPlanAssociation

Object

A associação do plano de compromisso.

Name	Tipo	Description
commitmentPlanId	string	A ID de recurso do Azure do plano de compromisso.
commitmentPlanLocation	string	A localização do plano de compromisso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

Encryption

Object

Propriedades para configurar a criptografia

Name	Tipo	Default value	Description
keySource	keySource	Microsoft.KeyVault	Enumera o valor possível de keySource for Encryption
keyVaultProperties	KeyVaultProperties		Propriedades de KeyVault

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Identity

Object

Identidade do recurso.

Name	Tipo	Description
principalId	string	A ID principal da identidade do recurso.
tenantId	string	A ID do locatário do recurso.
type	ResourceIdentityType	O tipo de identidade.
userAssignedIdentities	<string, UserAssignedIdentity>	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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Object

Uma regra que rege a acessibilidade a partir de um endereço IP específico ou intervalo de ip.

Name	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

Enumera o valor possível de keySource for Encryption

Valor	Description
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Object

Propriedades para configurar as propriedades do keyVault

Name	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

Object

A conta de Serviços Cognitivos de configurações de várias regiões.

Name	Tipo	Description
regions	RegionSetting[]	A conta de Serviços Cognitivos de limite de taxa de chamada.
routingMethod	RoutingMethods	Métodos de roteamento multirregião.

NetworkRuleAction

Enumeração

A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass foi avaliada.

Valor	Description
Allow
Deny

NetworkRuleSet

Object

Um conjunto de regras que regem a acessibilidade da rede.

Name	Tipo	Description
bypass	ByPassSelection	Configuração para serviços confiáveis.
defaultAction	NetworkRuleAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass foi avaliada.
ipRules	IpRule[]	A lista de regras de endereço IP.
virtualNetworkRules	VirtualNetworkRule[]	A lista de regras de rede virtual.

PrivateEndpoint

Object

O recurso Ponto Final Privado.

Name	Tipo	Description
id	string	O identificador ARM para Private Endpoint

PrivateEndpointConnection

Object

O recurso Private Endpoint Connection.

Name	Tipo	Description
etag	string	Etag de recurso.
id	string	ID de recurso totalmente qualificado 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	PrivateEndpointConnectionProperties	Propriedades do recurso.
systemData	systemData	Metadados referentes à criação e última modificação do recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Object

Propriedades do PrivateEndpointConnectProperties.

Name	Tipo	Description
groupIds	string[]	As ids do grupo de recursos de link privado.
privateEndpoint	PrivateEndpoint	O recurso do ponto final privado.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.

PrivateEndpointConnectionProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeração

O status da conexão de ponto de extremidade privado.

Valor	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.

Name	Tipo	Description
actionsRequired	string	Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

ProvisioningState

Enumeração

Obtém o status da conta de serviços cognitivos no momento em que a operação foi chamada.

Valor	Description
Accepted
Creating
Deleting
Failed
Moving
ResolvingDNS
Succeeded

PublicNetworkAccess

Enumeração

Se o acesso público ao ponto de extremidade é permitido ou não para essa conta.

Valor	Description
Disabled
Enabled

QuotaLimit

Object

Name	Tipo	Description
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RaiMonitorConfig

Object

Serviços Cognitivos Rai Monitor Config.

Name	Tipo	Description
adxStorageResourceId	string	O ID do recurso de armazenamento.
identityClientId	string	O ID do cliente de identidade para acessar o armazenamento.

RegionSetting

Object

A conta de Serviços Cognitivos de limite de taxa de chamada.

Name	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

Object

Name	Tipo	Description
method	string
path	string

ResourceIdentityType

Enumeração

O tipo de identidade.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RoutingMethods

Enumeração

Métodos de roteamento multirregião.

Valor	Description
Performance
Priority
Weighted

Sku

Object

A definição do modelo de recursos que representa a SKU

Name	Tipo	Description
capacity	integer (int32)	Se a SKU suportar scaleout/in, o inteiro de capacidade deve ser incluído. Se a expansão/entrada não for possível para o recurso, isso poderá ser omitido.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do 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, este seria o código autônomo.
tier	SkuTier	Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.

SkuCapability

Object

SkuCapability indica a capacidade de um determinado recurso.

Name	Tipo	Description
name	string	O nome do SkuCapability.
value	string	O valor do SkuCapability.

SkuChangeInfo

Object

Sku alterar informações da conta.

Name	Tipo	Description
countOfDowngrades	number	Obtém a contagem de downgrades.
countOfUpgradesAfterDowngrades	number	Obtém a contagem de upgrades após downgrades.
lastChangeDate	string	Obtém a data da última alteração.

SkuTier

Enumeração

Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.

Valor	Description
Basic
Enterprise
Free
Premium
Standard

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

ThrottlingRule

Object

Name	Tipo	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

UserAssignedIdentity

Object

Identidade gerenciada atribuída pelo usuário.

Name	Tipo	Description
clientId	string	ID do aplicativo cliente associado a essa identidade.
principalId	string	ID principal do Azure Ative Directory associada a esta Identidade.

UserOwnedAmlWorkspace

Object

O espaço de trabalho AML de propriedade do usuário para a conta de Serviços Cognitivos.

Name	Tipo	Description
identityClientId	string	ID do cliente de identidade de um recurso de espaço de trabalho AML.
resourceId	string	ID de recurso completo de um recurso de espaço de trabalho AML.

UserOwnedStorage

Object

O armazenamento de propriedade do usuário para a conta de Serviços Cognitivos.

Name	Tipo	Description
identityClientId	string
resourceId	string	ID de recurso completo de um recurso Microsoft.Storage.

VirtualNetworkRule

Object

Uma regra que rege a acessibilidade a partir de uma rede virtual específica.

Name	Tipo	Description
id	string	ID de recurso completo de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
ignoreMissingVnetServiceEndpoint	boolean	Ignore o ponto de extremidade do serviço vnet ausente ou não.
state	string	Obtém o estado da regra de rede virtual.