Compartir a través de


Accounts - Update

Actualiza una cuenta de Cognitive Services.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
accountName
path True

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

Nombre de la cuenta de Cognitive Services.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

Identificador de la suscripción de destino.

api-version
query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre Tipo Description
identity

Identity

Identidad del recurso.

kind

string

El 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 de recursos.

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 por qué se produjo un error en la operación. Si el grupo de recursos o recurso no existe, se debe devolver 404 (NotFound).

Ejemplos

Update Account

Solicitud de ejemplo

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

{
  "location": "global",
  "sku": {
    "name": "S2"
  }
}

Respuesta de muestra

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01
azure-AsyncOperation: http://azure.async.operation/status
{
  "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"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01
azure-AsyncOperation: http://azure.async.operation/status
{
  "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.

ByPassSelection

Configuración de servicios de confianza.

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 hay ninguna regla de ipRules y de virtualNetworkRules coinciden. Esto solo se usa después de evaluar la propiedad bypass.

NetworkRuleSet

Conjunto de reglas que rigen la accesibilidad de red.

PrivateEndpoint

El recurso Punto de conexión privado.

PrivateEndpointConnection

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

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

QuotaLimit
RaiMonitorConfig

Configuración de Cognitive Services Rai Monitor.

RegionSetting

La cuenta de Cognitive Services limita la tasa de llamadas.

RequestMatchPattern
ResourceIdentityType

Tipo de identidad.

RoutingMethods

Métodos de enrutamiento de varias regiones.

Sku

Definición del modelo de recursos que representa la SKU

SkuCapability

SkuCapability indica la capacidad de una determinada característica.

SkuChangeInfo

La SKU cambia la información de la cuenta.

SkuTier

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

systemData

Metadatos relativos a la creación y última modificación del recurso.

ThrottlingRule
UserAssignedIdentity

Identidad administrada asignada por el usuario.

UserOwnedAmlWorkspace

Área de trabajo de AML propiedad del usuario para la cuenta de Cognitive Services.

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 (date-time)

Fecha y hora de expiración de AbusePenalty.

rateLimitPercentage

number

Porcentaje del límite de velocidad.

AbusePenaltyAction

La acción de AbusePenalty.

Valor Description
Block
Throttle

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 para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identidad del recurso.

kind

string

El 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 relativos a la creación y última modificación del recurso.

tags

object

Etiquetas de recursos.

type

string

Tipo del 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[]

amlWorkspace

UserOwnedAmlWorkspace

Propiedades del área de trabajo de AML propiedad del usuario.

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

Propiedades de cifrado para 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

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

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

quotaLimit

QuotaLimit

raiMonitorConfig

RaiMonitorConfig

Configuración de Cognitive Services Rai Monitor.

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

La fecha de purga programada, solo disponible para la cuenta eliminada.

skuChangeInfo

SkuChangeInfo

La 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

maxLength: 500

(Solo Metrics Advisor) Identificador de cliente de Azure AD (id. de aplicación).

aadTenantId

string

maxLength: 500

(Solo Metrics Advisor) Identificador de inquilino de Azure AD.

eventHubConnectionString

string

maxLength: 1000
pattern: ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$

(Solo personalización) Marca para habilitar las estadísticas de Bing Search.

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 Bing Search) Marca para habilitar las estadísticas de Bing Search.

storageAccountConnectionString

string

maxLength: 1000
pattern: ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$

(Solo personalización) Cadena de conexión de la cuenta de almacenamiento.

superUser

string

maxLength: 500

(Solo Metrics Advisor) Superusuario de Metrics Advisor.

websiteName

string

maxLength: 500

(Solo Metrics Advisor) Nombre del sitio web de Metrics Advisor.

ByPassSelection

Configuración de servicios de confianza.

Valor Description
AzureServices
None

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.

Valor Description
Application
Key
ManagedIdentity
User

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

Detalles del error.

message

string

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

Valor Description
Microsoft.CognitiveServices
Microsoft.KeyVault

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 de varias regiones.

NetworkRuleAction

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

Valor Description
Allow
Deny

NetworkRuleSet

Conjunto de reglas que rigen la accesibilidad de red.

Nombre Tipo Description
bypass

ByPassSelection

Configuración de servicios de confianza.

defaultAction

NetworkRuleAction

Acción predeterminada cuando no hay ninguna regla de ipRules y de virtualNetworkRules coinciden. 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

El recurso Punto de conexión privado.

Nombre Tipo Description
id

string

Identificador de ARM para punto de conexión privado

PrivateEndpointConnection

El recurso Conexión de punto de conexión privado.

Nombre Tipo Description
etag

string

Etag de recursos.

id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Ubicación de la conexión del punto de conexión privado

name

string

Nombre del recurso

properties

PrivateEndpointConnectionProperties

Propiedades de recursos.

systemData

systemData

Metadatos relativos a la creación y última modificación del recurso.

type

string

Tipo del 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 private link.

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.

Valor Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

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

Valor Description
Approved
Pending
Rejected

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 o rechazado o eliminado la conexión.

ProvisioningState

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

Valor Description
Accepted
Creating
Deleting
Failed
Moving
ResolvingDNS
Succeeded

PublicNetworkAccess

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

Valor Description
Disabled
Enabled

QuotaLimit

Nombre Tipo Description
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RaiMonitorConfig

Configuración de Cognitive Services Rai Monitor.

Nombre Tipo Description
adxStorageResourceId

string

Identificador del recurso de almacenamiento.

identityClientId

string

Identificador de cliente de identidad para acceder al almacenamiento.

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.

Valor Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RoutingMethods

Métodos de enrutamiento de varias regiones.

Valor Description
Performance
Priority
Weighted

Sku

Definición del modelo de recursos que representa la SKU

Nombre Tipo Description
capacity

integer (int32)

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

Nombre de la SKU. Por ejemplo, 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 necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

SkuCapability

SkuCapability indica la capacidad de una determinada característica.

Nombre Tipo Description
name

string

Nombre de SkuCapability.

value

string

Valor de SkuCapability.

SkuChangeInfo

La 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 necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

Valor Description
Basic
Enterprise
Free
Premium
Standard

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

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 (date-time)

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.

UserOwnedAmlWorkspace

Área de trabajo de AML propiedad del usuario para la cuenta de Cognitive Services.

Nombre Tipo Description
identityClientId

string

Identificador de cliente de identidad de un recurso de área de trabajo de AML.

resourceId

string

Identificador de recurso completo de un recurso de área de trabajo de AML.

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