Accounts - Update

Referência

Service:: Azure AI Services

API Version:: 2023-05-01

Atualizações uma conta dos Serviços Cognitivos

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da conta dos Serviços Cognitivos. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_.-]*$`
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
identity	Identity	Identidade do recurso.
kind	string	O Tipo do recurso.
location	string	A localização geográfica onde o recurso se encontra
properties	AccountProperties	Propriedades da conta dos Serviços Cognitivos.
sku	Sku	A definição do modelo de recurso que representa o SKU
tags	object	Etiquetas de recursos.

Respostas

Name	Tipo	Description
200 OK	Account	O fornecedor de recursos deve devolver 200 (OK) para indicar que a operação foi concluída com êxito.
202 Accepted	Account	HTTP 202 (Aceite) se a operação tiver sido iniciada com êxito e será concluída de forma assíncrona.
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou. Se o grupo de recursos ou recurso não existir, deve ser devolvido 404 (NotFound).

Exemplos

Update Account

Sample Request

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

import com.azure.resourcemanager.cognitiveservices.models.Account;
import com.azure.resourcemanager.cognitiveservices.models.Sku;

/** Samples for Accounts Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/UpdateAccount.json
     */
    /**
     * Sample code: Update Account.
     *
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void updateAccount(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        Account resource =
            manager
                .accounts()
                .getByResourceGroupWithResponse("bvttest", "bingSearch", com.azure.core.util.Context.NONE)
                .getValue();
        resource.update().withSku(new Sku().withName("S2")).apply();
    }
}

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 update_account.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.begin_update(
        resource_group_name="bvttest",
        account_name="bingSearch",
        account={"location": "global", "sku": {"name": "S2"}},
    ).result()
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/UpdateAccount.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/azcore/to"
	"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/310a0100f5b020c1900c527a6aa70d21992f078a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/UpdateAccount.json
func ExampleAccountsClient_BeginUpdate() {
	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)
	}
	poller, err := clientFactory.NewAccountsClient().BeginUpdate(ctx, "bvttest", "bingSearch", armcognitiveservices.Account{
		Location: to.Ptr("global"),
		SKU: &armcognitiveservices.SKU{
			Name: to.Ptr("S2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = 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-04-10T07%3A46%3A21.5618831Z'\""),
	// 	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("S2"),
	// 	},
	// }
}

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 Updates a Cognitive Services account
 *
 * @summary Updates a Cognitive Services account
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/UpdateAccount.json
 */
async function updateAccount() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "bvttest";
  const accountName = "bingSearch";
  const account = { location: "global", sku: { name: "S2" } };
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.accounts.beginUpdateAndWait(resourceGroupName, accountName, account);
  console.log(result);
}

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

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

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2023-05-01/examples/UpdateAccount.json
// this example is just showing the usage of "Accounts_Update" 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 CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
string resourceGroupName = "bvttest";
string accountName = "bingSearch";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// invoke the operation
CognitiveServicesAccountData data = new CognitiveServicesAccountData(new AzureLocation("global"))
{
    Sku = new CognitiveServicesSku("S2"),
};
ArmOperation<CognitiveServicesAccountResource> lro = await cognitiveServicesAccount.UpdateAsync(WaitUntil.Completed, data);
CognitiveServicesAccountResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Sample Response

Status code:: 200

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

Response Body

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

Status code:: 202

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

Response Body

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

Definições

Name	Description
AbusePenalty	A pena de abuso.
AbusePenaltyAction	A acção de AbusePenalty.
Account	A conta dos Serviços Cognitivos é um recurso do Azure que representa a conta aprovisionada, o tipo, a localização e o SKU.
AccountProperties	Propriedades da conta dos Serviços Cognitivos.
ApiProperties	As propriedades da API para APIs especiais.
CallRateLimit	A conta dos Serviços Cognitivos do limite de taxa de chamadas.
CommitmentPlanAssociation	A associação do plano de alocação.
createdByType	O tipo de identidade que criou o recurso.
Encryption	Propriedades para configurar a Encriptação
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
Identity	Identidade do recurso.
IpRule	Uma regra que rege a acessibilidade a partir de um endereço IP ou intervalo ip específico.
keySource	Enumera o valor possível de keySource para Encriptação
KeyVaultProperties	Propriedades para configurar propriedades keyVault
MultiRegionSettings	A conta dos Serviços Cognitivos das definições de várias regiões.
NetworkRuleAction	A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.
NetworkRuleSet	Um conjunto de regras que regem a acessibilidade de rede.
PrivateEndpoint	O recurso ponto final privado.
PrivateEndpointConnection	O recurso Ligação de Ponto Final Privado.
PrivateEndpointConnectionProperties	Propriedades do PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState	O estado de aprovisionamento atual.
PrivateEndpointServiceConnectionStatus	O estado da ligação do ponto final privado.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor de serviços.
ProvisioningState	Obtém o estado da conta dos serviços cognitivos no momento em que a operação foi chamada.
PublicNetworkAccess	Se o acesso ao ponto final público é ou não permitido para esta conta.
QuotaLimit
RegionSetting	A conta dos Serviços Cognitivos do limite de taxa de chamadas.
RequestMatchPattern
ResourceIdentityType	O tipo de identidade.
RoutingMethods	Métodos de encaminhamento de várias regiões.
Sku	A definição do modelo de recurso que representa o SKU
SkuCapability	SkuCapability indica a capacidade de uma determinada funcionalidade.
SkuChangeInfo	As informações de alteração do SKU da conta.
SkuTier	Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.
systemData	Metadados relativos à criação e última modificação do recurso.
ThrottlingRule
UserAssignedIdentity	Identidade gerida atribuída pelo utilizador.
UserOwnedStorage	O armazenamento do utilizador da conta dos Serviços Cognitivos.
VirtualNetworkRule	Uma regra que rege a acessibilidade a partir de uma rede virtual específica.

AbusePenalty

A pena de abuso.

Name	Tipo	Description
action	AbusePenaltyAction	A acção de AbusePenalty.
expiration	string	O datetime de expiração do AbusePenalty.
rateLimitPercentage	number	A percentagem do limite de taxa.

AbusePenaltyAction

A acção de AbusePenalty.

Name	Tipo	Description
Block	string
Throttle	string

Account

A conta dos Serviços Cognitivos é um recurso do Azure que representa a conta aprovisionada, o tipo, a localização e o SKU.

Name	Tipo	Description
etag	string	Resource Etag.
id	string	ID de recurso completamente 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 localização geográfica onde o recurso se encontra
name	string	O nome do recurso
properties	AccountProperties	Propriedades da conta dos Serviços Cognitivos.
sku	Sku	A definição do modelo de recurso que representa o SKU
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
tags	object	Etiquetas de recursos.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AccountProperties

Propriedades da conta dos Serviços Cognitivos.

Name	Tipo	Description
abusePenalty	AbusePenalty	A pena de abuso.
allowedFqdnList	string[]
apiProperties	ApiProperties	As propriedades da API para APIs especiais.
callRateLimit	CallRateLimit	A conta dos Serviços Cognitivos do limite de taxa de chamadas.
capabilities	SkuCapability[]	Obtém as capacidades da conta dos serviços cognitivos. Cada item indica a capacidade de uma funcionalidade específica. Os valores são só de leitura e apenas para referência.
commitmentPlanAssociations	CommitmentPlanAssociation[]	As associações do plano de alocação da conta dos Serviços Cognitivos.
customSubDomainName	string	Nome de subdomínio opcional utilizado para autenticação baseada em tokens.
dateCreated	string	Obtém a data de criação da conta dos serviços cognitivos.
deletionDate	string	A data de eliminação, disponível apenas para a conta eliminada.
disableLocalAuth	boolean
dynamicThrottlingEnabled	boolean	O sinalizador para ativar a limitação dinâmica.
encryption	Encryption	As propriedades de encriptação para este recurso.
endpoint	string	Ponto final da conta criada.
endpoints	object
internalId	string	O identificador interno (preterido, não utilize esta propriedade).
isMigrated	boolean	Se o recurso for migrado de uma chave existente.
locations	MultiRegionSettings	As definições de várias regiões da conta dos Serviços Cognitivos.
migrationToken	string	Token de migração de recursos.
networkAcls	NetworkRuleSet	Uma coleção de regras que regem a acessibilidade a partir de localizações de rede específicas.
privateEndpointConnections	PrivateEndpointConnection[]	A ligação de ponto final privado associada à conta dos Serviços Cognitivos.
provisioningState	ProvisioningState	Obtém o estado da conta dos serviços cognitivos no momento em que a operação foi chamada.
publicNetworkAccess	PublicNetworkAccess	Se o acesso ao ponto final público é ou não permitido para esta conta.
quotaLimit	QuotaLimit
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	A data de remoção agendada, disponível apenas para a conta eliminada.
skuChangeInfo	SkuChangeInfo	As informações de alteração do SKU da conta.
userOwnedStorage	UserOwnedStorage[]	As contas de armazenamento deste recurso.

ApiProperties

As propriedades da API para APIs especiais.

Name	Tipo	Description
aadClientId	string	(Apenas Assistente de Métricas) O ID de Cliente Azure AD (ID da Aplicação).
aadTenantId	string	(Apenas Assistente de Métricas) O ID do Inquilino Azure AD.
eventHubConnectionString	string	(Apenas Personalização) O sinalizador para ativar as estatísticas de Pesquisa do Bing.
qnaAzureSearchEndpointId	string	(Apenas QnAMaker) O ID do ponto final do Azure Search do QnAMaker.
qnaAzureSearchEndpointKey	string	(Apenas QnAMaker) A chave de ponto final do Azure Search do QnAMaker.
qnaRuntimeEndpoint	string	(Apenas QnAMaker) O ponto final de runtime do QnAMaker.
statisticsEnabled	boolean	(apenas Pesquisa do Bing) O sinalizador para ativar as estatísticas de Pesquisa do Bing.
storageAccountConnectionString	string	(Apenas Personalização) A conta de armazenamento cadeia de ligação.
superUser	string	(Apenas Assistente de Métricas) O superutilizador do Assistente de Métricas.
websiteName	string	(Apenas 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 chamadas.

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

CommitmentPlanAssociation

A associação do plano de alocação.

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

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Encryption

Propriedades para configurar a Encriptação

Name	Tipo	Valor Predefinido	Description
keySource	keySource	Microsoft.KeyVault	Enumera o valor possível de keySource para Encriptação
keyVaultProperties	KeyVaultProperties		Propriedades do KeyVault

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Identity

Identidade do recurso.

Name	Tipo	Description
principalId	string	O ID principal da identidade de recurso.
tenantId	string	O ID do inquilino do recurso.
type	ResourceIdentityType	O tipo de identidade.
userAssignedIdentities	<string, UserAssignedIdentity>	A lista de identidades atribuídas pelo utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

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

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 valor possível de keySource para Encriptação

Name	Tipo	Description
Microsoft.CognitiveServices	string
Microsoft.KeyVault	string

KeyVaultProperties

Propriedades para configurar propriedades keyVault

Name	Tipo	Description
identityClientId	string
keyName	string	Nome da Chave do KeyVault
keyVaultUri	string	Uri de KeyVault
keyVersion	string	Versão da Chave do KeyVault

MultiRegionSettings

A conta dos Serviços Cognitivos das definições de várias regiões.

Name	Tipo	Description
regions	RegionSetting[]	A conta dos Serviços Cognitivos do limite de taxa de chamadas.
routingMethod	RoutingMethods	Métodos de encaminhamento de várias regiões.

NetworkRuleAction

A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.

Name	Tipo	Description
Allow	string
Deny	string

NetworkRuleSet

Um conjunto de regras que regem a acessibilidade de rede.

Name	Tipo	Description
defaultAction	NetworkRuleAction	A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.
ipRules	IpRule[]	A lista de regras de endereços IP.
virtualNetworkRules	VirtualNetworkRule[]	A lista de regras de rede virtual.

PrivateEndpoint

O recurso ponto final privado.

Name	Tipo	Description
id	string	O identificador do ARM para o Ponto Final Privado

PrivateEndpointConnection

O recurso Ligação de Ponto Final Privado.

Name	Tipo	Description
etag	string	Resource Etag.
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização da ligação de ponto final privado
name	string	O nome do recurso
properties	PrivateEndpointConnectionProperties	Propriedades do recurso.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Propriedades do PrivateEndpointConnectProperties.

Name	Tipo	Description
groupIds	string[]	Os IDs do grupo de recursos de ligação privada.
privateEndpoint	PrivateEndpoint	O recurso do ponto final privado.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor de serviços.
provisioningState	PrivateEndpointConnectionProvisioningState	O estado de aprovisionamento do recurso de ligação de ponto final privado.

PrivateEndpointConnectionProvisioningState

O estado de aprovisionamento atual.

Name	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

O estado da ligação do ponto final privado.

Name	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

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

Name	Tipo	Description
actionsRequired	string	Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateEndpointServiceConnectionStatus	Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço.

ProvisioningState

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

Name	Tipo	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Moving	string
ResolvingDNS	string
Succeeded	string

PublicNetworkAccess

Se o acesso ao ponto final público é ou não permitido para esta conta.

Name	Tipo	Description
Disabled	string
Enabled	string

QuotaLimit

Name	Tipo	Description
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RegionSetting

A conta dos Serviços Cognitivos do limite de taxa de chamadas.

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 encaminhamento prioritários ou ponderados.

RequestMatchPattern

Name	Tipo	Description
method	string
path	string

ResourceIdentityType

O tipo de identidade.

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RoutingMethods

Métodos de encaminhamento de várias regiões.

Name	Tipo	Description
Performance	string
Priority	string
Weighted	string

Sku

A definição do modelo de recurso que representa o SKU

Name	Tipo	Description
capacity	integer	Se o SKU suportar o aumento horizontal/in, o número inteiro de capacidade deve ser incluído. Se não for possível aumentar/reduzir horizontalmente o recurso, tal 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 letter+number
size	string	O tamanho do SKU. Quando o campo de nome é a combinação de camada e outro valor, este seria o código autónomo.
tier	SkuTier	Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.

SkuCapability

SkuCapability indica a capacidade de uma determinada funcionalidade.

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

SkuChangeInfo

As informações de alteração do SKU da conta.

Name	Tipo	Description
countOfDowngrades	number	Obtém a contagem de versões anteriores.
countOfUpgradesAfterDowngrades	number	Obtém a contagem de atualizações após as versões anteriores.
lastChangeDate	string	Obtém a data da última alteração.

SkuTier

Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.

Name	Tipo	Description
Basic	string
Enterprise	string
Free	string
Premium	string
Standard	string

systemData

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

Name	Tipo	Description
createdAt	string	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	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

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

UserAssignedIdentity

Identidade gerida atribuída pelo utilizador.

Name	Tipo	Description
clientId	string	ID da Aplicação de Cliente associado a esta identidade.
principalId	string	ID principal do Azure Active Directory associado a esta Identidade.

UserOwnedStorage

O armazenamento do utilizador da conta dos Serviços Cognitivos.

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

VirtualNetworkRule

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 de vnet, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Ignore ou não o ponto final de serviço da vnet em falta.
state	string	Obtém o estado da regra de rede virtual.