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 de URI

Nome	Em	Obrigató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 diferencia maiúsculas de minúsculas.
subscriptionId	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.

Corpo da solicitação

Nome	Tipo	Description
identity	Identity	Identidade do recurso.
kind	string	O Tipo do recurso.
location	string	A localização geográfica em que o recurso reside
properties	AccountProperties	Propriedades da conta dos Serviços Cognitivos.
sku	Sku	A definição do modelo de recurso que representa o SKU
tags	object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	Account	O provedor de recursos deve retornar 200 (OK) para indicar que a operação foi concluída com êxito.
202 Accepted	Account	HTTP 202 (Aceito) se a operação foi iniciada com êxito e será concluída de forma assíncrona.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou. Se o grupo de recursos ou o recurso não existir, 404 (NotFound) deverá ser retornado.

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

Nome	Description
AbusePenalty	A pena de abuso.
AbusePenaltyAction	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.
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 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	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
Identity	Identidade do recurso.
IpRule	Uma regra que rege a acessibilidade de um endereço IP ou intervalo ip específico.
keySource	Enumera o valor possível de keySource para Criptografia
KeyVaultProperties	Propriedades para configurar as propriedades do keyVault
MultiRegionSettings	A conta dos 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 de bypass é avaliada.
NetworkRuleSet	Um conjunto de regras que regem a acessibilidade de rede.
PrivateEndpoint	O recurso ponto de extremidade privado.
PrivateEndpointConnection	O recurso conexão de ponto de extremidade privado.
PrivateEndpointConnectionProperties	Propriedades do PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	A conexão do ponto de extremidade privado status.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
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
RegionSetting	A conta dos Serviços Cognitivos do limite de taxa de chamada.
RequestMatchPattern
ResourceIdentityType	O tipo de identidade.
RoutingMethods	Métodos de roteamento de várias regiões.
Sku	A definição do modelo de recurso que representa o SKU
SkuCapability	SkuCapability indica a capacidade de um determinado recurso.
SkuChangeInfo	Informações de alteração de SKU da conta.
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.
systemData	Metadados relativos à criação e à última modificação do recurso.
ThrottlingRule
UserAssignedIdentity	Identidade gerenciada atribuída ao usuário.
UserOwnedStorage	O armazenamento de propriedade do usuário para a conta dos Serviços Cognitivos.
VirtualNetworkRule	Uma regra que rege a acessibilidade de uma rede virtual específica.

AbusePenalty

A pena de abuso.

Nome	Tipo	Description
action	AbusePenaltyAction	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	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	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	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	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 chamada.
capabilities	SkuCapability[]	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	CommitmentPlanAssociation[]	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	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	MultiRegionSettings	As configuraçõ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 de locais de rede específicos.
privateEndpointConnections	PrivateEndpointConnection[]	A conexão de ponto de extremidade privado associada à conta dos 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 ao ponto de extremidade público é permitido ou não para essa conta.
quotaLimit	QuotaLimit
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	A data de limpeza agendada, disponível apenas para a conta excluída.
skuChangeInfo	SkuChangeInfo	Informações de alteração de SKU da conta.
userOwnedStorage	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	ThrottlingRule[]

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	keySource	Microsoft.KeyVault	Enumera o valor possível de keySource para Criptografia
keyVaultProperties	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	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 de erro

Nome	Tipo	Description
error	ErrorDetail	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	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 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	RegionSetting[]	A conta dos Serviços Cognitivos do limite de taxa de chamada.
routingMethod	RoutingMethods	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	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.
ipRules	IpRule[]	A lista de regras de endereço IP.
virtualNetworkRules	VirtualNetworkRule[]	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	PrivateEndpointConnectionProperties	Propriedades do recurso.
systemData	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	PrivateEndpoint	O recurso do ponto de extremidade privado.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
provisioningState	PrivateEndpointConnectionProvisioningState	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	PrivateEndpointServiceConnectionStatus	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	ThrottlingRule[]

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	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.

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

Nome	Tipo	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
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.