Accounts - Update

Service:

Azure AI Services

API Version:

2023-05-01

Novedades una cuenta de Cognitive Services

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string	Nombre de la cuenta de Cognitive Services. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
identity	Identity	Identidad del recurso.
kind	string	Tipo del recurso.
location	string	Ubicación geográfica donde reside el recurso
properties	AccountProperties	Propiedades de la cuenta de Cognitive Services.
sku	Sku	Definición del modelo de recursos que representa la SKU
tags	object	Etiquetas del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	Account	El proveedor de recursos debe devolver 200 (CORRECTO) para indicar que la operación se completó correctamente.
202 Accepted	Account	HTTP 202 (aceptado) si la operación se inició correctamente y se completará de forma asincrónica.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación. Si el grupo de recursos o el recurso no existe, se debe devolver 404 (NotFound).

Ejemplos

Update Account

Sample Request

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

Definiciones

Nombre	Description
AbusePenalty	La pena de abuso.
AbusePenaltyAction	La acción de AbusePenalty.
Account	La cuenta de Cognitive Services es un recurso de Azure que representa la cuenta aprovisionada, es el tipo, la ubicación y la SKU.
AccountProperties	Propiedades de la cuenta de Cognitive Services.
ApiProperties	Las propiedades de api de las API especiales.
CallRateLimit	La cuenta de Cognitive Services limita la tasa de llamadas.
CommitmentPlanAssociation	Asociación del plan de compromiso.
createdByType	Tipo de identidad que creó el recurso.
Encryption	Propiedades para configurar el cifrado
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Identity	Identidad del recurso.
IpRule	Una regla que rige la accesibilidad desde una dirección IP específica o un intervalo ip.
keySource	Enumera el valor posible de keySource para el cifrado.
KeyVaultProperties	Propiedades para configurar las propiedades de keyVault
MultiRegionSettings	La cuenta de Cognitive Services de configuración de varias regiones.
NetworkRuleAction	Acción predeterminada cuando no coinciden ninguna regla de ipRules y de virtualNetworkRules. Esto solo se usa después de evaluar la propiedad bypass.
NetworkRuleSet	Un conjunto de reglas que rigen la accesibilidad de la red.
PrivateEndpoint	Recurso de punto de conexión privado.
PrivateEndpointConnection	Recurso de conexión de punto de conexión privado.
PrivateEndpointConnectionProperties	Propiedades de PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
ProvisioningState	Obtiene el estado de la cuenta de Cognitive Services en el momento en que se llamó a la operación.
PublicNetworkAccess	Si se permite o no el acceso al punto de conexión público para esta cuenta.
QuotaLimit
RegionSetting	La cuenta de Cognitive Services limita la tasa de llamadas.
RequestMatchPattern
ResourceIdentityType	Tipo de identidad.
RoutingMethods	Métodos de enrutamiento multiregión.
Sku	Definición del modelo de recursos que representa la SKU
SkuCapability	SkuCapability indica la funcionalidad de una determinada característica.
SkuChangeInfo	SKU cambia la información de la cuenta.
SkuTier	El proveedor de recursos requiere que el proveedor de recursos implemente este campo si el servicio tiene más de un nivel, pero no es necesario en put.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
ThrottlingRule
UserAssignedIdentity	Identidad administrada asignada por el usuario.
UserOwnedStorage	Almacenamiento propiedad del usuario para la cuenta de Cognitive Services.
VirtualNetworkRule	Una regla que rige la accesibilidad desde una red virtual específica.

AbusePenalty

La pena de abuso.

Nombre	Tipo	Description
action	AbusePenaltyAction	La acción de AbusePenalty.
expiration	string	Fecha y hora de expiración de abusePenalty.
rateLimitPercentage	number	Porcentaje del límite de velocidad.

AbusePenaltyAction

La acción de AbusePenalty.

Nombre	Tipo	Description
Block	string
Throttle	string

Account

La cuenta de Cognitive Services es un recurso de Azure que representa la cuenta aprovisionada, es el tipo, la ubicación y la SKU.

Nombre	Tipo	Description
etag	string	Etag de recursos.
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Identidad del recurso.
kind	string	Tipo del recurso.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties	AccountProperties	Propiedades de la cuenta de Cognitive Services.
sku	Sku	Definición del modelo de recursos que representa la SKU
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

AccountProperties

Propiedades de la cuenta de Cognitive Services.

Nombre	Tipo	Description
abusePenalty	AbusePenalty	La pena de abuso.
allowedFqdnList	string[]
apiProperties	ApiProperties	Las propiedades de api de las API especiales.
callRateLimit	CallRateLimit	La cuenta de Cognitive Services limita la tasa de llamadas.
capabilities	SkuCapability[]	Obtiene las funcionalidades de la cuenta de Cognitive Services. Cada elemento indica la funcionalidad de una característica específica. Los valores son de solo lectura y solo para referencia.
commitmentPlanAssociations	CommitmentPlanAssociation[]	Las asociaciones del plan de compromiso de la cuenta de Cognitive Services.
customSubDomainName	string	Nombre de subdominio opcional usado para la autenticación basada en tokens.
dateCreated	string	Obtiene la fecha de creación de la cuenta de Cognitive Services.
deletionDate	string	La fecha de eliminación, solo disponible para la cuenta eliminada.
disableLocalAuth	boolean
dynamicThrottlingEnabled	boolean	Marca para habilitar la limitación dinámica.
encryption	Encryption	Las propiedades de cifrado de este recurso.
endpoint	string	Punto de conexión de la cuenta creada.
endpoints	object
internalId	string	El identificador interno (en desuso, no use esta propiedad).
isMigrated	boolean	Si el recurso se migra desde una clave existente.
locations	MultiRegionSettings	La configuración de varias regiones de la cuenta de Cognitive Services.
migrationToken	string	Token de migración de recursos.
networkAcls	NetworkRuleSet	Colección de reglas que rigen la accesibilidad desde ubicaciones de red específicas.
privateEndpointConnections	PrivateEndpointConnection[]	Conexión de punto de conexión privado asociada a la cuenta de Cognitive Services.
provisioningState	ProvisioningState	Obtiene el estado de la cuenta de Cognitive Services en el momento en que se llamó a la operación.
publicNetworkAccess	PublicNetworkAccess	Si se permite o no el acceso al punto de conexión público para esta cuenta.
quotaLimit	QuotaLimit
restore	boolean
restrictOutboundNetworkAccess	boolean
scheduledPurgeDate	string	La fecha de purga programada, solo disponible para la cuenta eliminada.
skuChangeInfo	SkuChangeInfo	SKU cambia la información de la cuenta.
userOwnedStorage	UserOwnedStorage[]	Las cuentas de almacenamiento de este recurso.

ApiProperties

Las propiedades de api de las API especiales.

Nombre	Tipo	Description
aadClientId	string	(Solo Metrics Advisor) Identificador de cliente de Azure AD (id. de aplicación).
aadTenantId	string	(Solo Metrics Advisor) Identificador de inquilino de Azure AD.
eventHubConnectionString	string	(Solo personalización) Marca para habilitar las estadísticas de Búsqueda de Bing.
qnaAzureSearchEndpointId	string	(Solo QnAMaker) Identificador del punto de conexión de Azure Search de QnAMaker.
qnaAzureSearchEndpointKey	string	(Solo QnAMaker) Clave de punto de conexión de Azure Search de QnAMaker.
qnaRuntimeEndpoint	string	(Solo QnAMaker) Punto de conexión en tiempo de ejecución de QnAMaker.
statisticsEnabled	boolean	(solo Búsqueda de Bing) Marca para habilitar las estadísticas de Búsqueda de Bing.
storageAccountConnectionString	string	(Solo personalización) La cuenta de almacenamiento cadena de conexión.
superUser	string	(Solo Metrics Advisor) Superusuario de Metrics Advisor.
websiteName	string	(Solo Metrics Advisor) Nombre del sitio web de Metrics Advisor.

CallRateLimit

La cuenta de Cognitive Services limita la tasa de llamadas.

Nombre	Tipo	Description
count	number	Valor de recuento del límite de frecuencia de llamadas.
renewalPeriod	number	Período de renovación en segundos del límite de frecuencia de llamadas.
rules	ThrottlingRule[]

CommitmentPlanAssociation

Asociación del plan de compromiso.

Nombre	Tipo	Description
commitmentPlanId	string	Identificador de recurso de Azure del plan de compromiso.
commitmentPlanLocation	string	Ubicación del plan de compromiso.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Encryption

Propiedades para configurar el cifrado

Nombre	Tipo	Valor predeterminado	Description
keySource	keySource	Microsoft.KeyVault	Enumera el valor posible de keySource para el cifrado.
keyVaultProperties	KeyVaultProperties		Propiedades de KeyVault

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Identity

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad de recurso.
tenantId	string	Identificador de inquilino del recurso.
type	ResourceIdentityType	Tipo de identidad.
userAssignedIdentities	<string,  UserAssignedIdentity>	Lista de identidades asignadas por el usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Una regla que rige la accesibilidad desde una dirección IP específica o un intervalo ip.

Nombre	Tipo	Description
value	string	Intervalo de direcciones IPv4 en notación CIDR, como "124.56.78.91" (dirección IP simple) o "124.56.78.0/24" (todas las direcciones que comienzan por 124.56.78).

keySource

Enumera el valor posible de keySource para el cifrado.

Nombre	Tipo	Description
Microsoft.CognitiveServices	string
Microsoft.KeyVault	string

KeyVaultProperties

Propiedades para configurar las propiedades de keyVault

Nombre	Tipo	Description
identityClientId	string
keyName	string	Nombre de la clave de KeyVault
keyVaultUri	string	Uri de KeyVault
keyVersion	string	Versión de la clave de KeyVault

MultiRegionSettings

La cuenta de Cognitive Services de configuración de varias regiones.

Nombre	Tipo	Description
regions	RegionSetting[]	La cuenta de Cognitive Services limita la tasa de llamadas.
routingMethod	RoutingMethods	Métodos de enrutamiento multiregión.

NetworkRuleAction

Acción predeterminada cuando no coinciden ninguna regla de ipRules y de virtualNetworkRules. Esto solo se usa después de evaluar la propiedad bypass.

Nombre	Tipo	Description
Allow	string
Deny	string

NetworkRuleSet

Un conjunto de reglas que rigen la accesibilidad de la red.

Nombre	Tipo	Description
defaultAction	NetworkRuleAction	Acción predeterminada cuando no coinciden ninguna regla de ipRules y de virtualNetworkRules. Esto solo se usa después de evaluar la propiedad bypass.
ipRules	IpRule[]	Lista de reglas de direcciones IP.
virtualNetworkRules	VirtualNetworkRule[]	Lista de reglas de red virtual.

PrivateEndpoint

Recurso de punto de conexión privado.

Nombre	Tipo	Description
id	string	El identificador de ARM para el punto de conexión privado

PrivateEndpointConnection

Recurso de conexión de punto de conexión privado.

Nombre	Tipo	Description
etag	string	Etag de recursos.
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación de la conexión de punto de conexión privado
name	string	Nombre del recurso.
properties	PrivateEndpointConnectionProperties	Propiedades de recursos.
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Propiedades de PrivateEndpointConnectProperties.

Nombre	Tipo	Description
groupIds	string[]	Identificadores del grupo de recursos de vínculo privado.
privateEndpoint	PrivateEndpoint	Recurso del punto de conexión privado.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Estado de conexión del punto de conexión privado.

Nombre	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre	Tipo	Description
actionsRequired	string	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo de la conexión.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión.

ProvisioningState

Obtiene el estado de la cuenta de Cognitive Services en el momento en que se llamó a la operación.

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

PublicNetworkAccess

Si se permite o no el acceso al punto de conexión público para esta cuenta.

Nombre	Tipo	Description
Disabled	string
Enabled	string

QuotaLimit

Nombre	Tipo	Description
count	number
renewalPeriod	number
rules	ThrottlingRule[]

RegionSetting

La cuenta de Cognitive Services limita la tasa de llamadas.

Nombre	Tipo	Description
customsubdomain	string	Asigna la región al subdominio personalizado regional.
name	string	Nombre de la región.
value	number	Valor de los métodos de enrutamiento prioritarios o ponderados.

RequestMatchPattern

Nombre	Tipo	Description
method	string
path	string

ResourceIdentityType

Tipo de identidad.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RoutingMethods

Métodos de enrutamiento multiregión.

Nombre	Tipo	Description
Performance	string
Priority	string
Weighted	string

Sku

Definición del modelo de recursos que representa la SKU

Nombre	Tipo	Description
capacity	integer	Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	El nombre de la SKU. Ex - P3. Normalmente es un código de letra y número.
size	string	Tamaño de la SKU. Cuando el campo de nombre es la combinación de nivel y otro valor, este sería el código independiente.
tier	SkuTier	El proveedor de recursos requiere que el proveedor de recursos implemente este campo si el servicio tiene más de un nivel, pero no es necesario en put.

SkuCapability

SkuCapability indica la funcionalidad de una determinada característica.

Nombre	Tipo	Description
name	string	Nombre de SkuCapability.
value	string	Valor de SkuCapability.

SkuChangeInfo

SKU cambia la información de la cuenta.

Nombre	Tipo	Description
countOfDowngrades	number	Obtiene el recuento de degradaciones.
countOfUpgradesAfterDowngrades	number	Obtiene el recuento de actualizaciones después de las degradaciones.
lastChangeDate	string	Obtiene la última fecha de cambio.

SkuTier

El proveedor de recursos requiere que el proveedor de recursos implemente este campo si el servicio tiene más de un nivel, pero no es necesario en put.

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

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

ThrottlingRule

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

UserAssignedIdentity

Identidad administrada asignada por el usuario.

Nombre	Tipo	Description
clientId	string	Id. de aplicación cliente asociado a esta identidad.
principalId	string	Identificador de entidad de seguridad de Azure Active Directory asociado a esta identidad.

UserOwnedStorage

Almacenamiento propiedad del usuario para la cuenta de Cognitive Services.

Nombre	Tipo	Description
identityClientId	string
resourceId	string	Identificador de recurso completo de un recurso microsoft.Storage.

VirtualNetworkRule

Una regla que rige la accesibilidad desde una red virtual específica.

Nombre	Tipo	Description
id	string	Identificador de recurso completo de una subred de red virtual, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Omita el punto de conexión de servicio de red virtual que falta o no.
state	string	Obtiene el estado de la regla de red virtual.