Partager via


Accounts - Update

Mises à jour un compte Cognitive Services

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

Paramètres URI

Nom Dans Obligatoire Type Description
accountName
path True

string

Nom du compte Cognitive Services.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
identity

Identity

Identité de la ressource.

kind

string

Type de la ressource.

location

string

Emplacement géographique où réside la ressource

properties

AccountProperties

Propriétés du compte Cognitive Services.

sku

Sku

Définition du modèle de ressource représentant la référence SKU

tags

object

Balises de ressource.

Réponses

Nom Type Description
200 OK

Account

Le fournisseur de ressources doit retourner 200 (OK) pour indiquer que l’opération s’est terminée avec succès.

202 Accepted

Account

HTTP 202 (Accepté) si l’opération a été correctement démarrée et se termine de manière asynchrone.

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération. Si le groupe de ressources ou la ressource n’existe pas, la valeur 404 (NotFound) doit être retournée.

Exemples

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

Sample Response

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
{
  "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=2023-05-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"
  }
}

Définitions

Nom Description
AbusePenalty

La pénalité d’abus.

AbusePenaltyAction

L’action d’AbusePenalty.

Account

Le compte Cognitive Services est une ressource Azure qui représente le compte provisionné, son type, son emplacement et sa référence SKU.

AccountProperties

Propriétés du compte Cognitive Services.

ApiProperties

Propriétés de l’API pour les API spéciales.

CallRateLimit

La limite de débit d’appels compte Cognitive Services.

CommitmentPlanAssociation

Association du plan d’engagement.

createdByType

Type d’identité qui a créé la ressource.

Encryption

Propriétés pour configurer le chiffrement

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

Identity

Identité de la ressource.

IpRule

Règle régissant l’accessibilité à partir d’une adresse ip ou d’une plage d’adresses IP spécifiques.

keySource

Énumère la valeur possible de keySource pour le chiffrement

KeyVaultProperties

Propriétés pour configurer les propriétés keyVault

MultiRegionSettings

Compte Cognitive Services des paramètres multirégions.

NetworkRuleAction

Action par défaut quand aucune règle d’ipRules et de virtualNetworkRules ne correspondent. Elle est utilisée uniquement après l’évaluation de la propriété bypass.

NetworkRuleSet

Ensemble de règles régissant l’accessibilité du réseau.

PrivateEndpoint

Ressource de point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

PrivateEndpointConnectionProperties

Propriétés de PrivateEndpointConnectProperties.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

PrivateEndpointServiceConnectionStatus

La connexion de point de terminaison privé status.

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

ProvisioningState

Obtient la status du compte Cognitive Services au moment de l’appel de l’opération.

PublicNetworkAccess

Indique si l’accès au point de terminaison public est autorisé pour ce compte.

QuotaLimit
RegionSetting

La limite de débit d’appels compte Cognitive Services.

RequestMatchPattern
ResourceIdentityType

Type d’identité.

RoutingMethods

Méthodes de routage multirégion.

Sku

Définition du modèle de ressource représentant la référence SKU

SkuCapability

SkuCapability indique la fonctionnalité d’une certaine fonctionnalité.

SkuChangeInfo

Informations de modification de la référence SKU du compte.

SkuTier

Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas requis sur un PUT.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

ThrottlingRule
UserAssignedIdentity

Identité managée affectée par l’utilisateur.

UserOwnedStorage

Stockage appartenant à l’utilisateur pour le compte Cognitive Services.

VirtualNetworkRule

Règle régissant l’accessibilité à partir d’un réseau virtuel spécifique.

AbusePenalty

La pénalité d’abus.

Nom Type Description
action

AbusePenaltyAction

L’action d’AbusePenalty.

expiration

string

Dateheure d’expiration de AbusePenalty.

rateLimitPercentage

number

Pourcentage de la limite de débit.

AbusePenaltyAction

L’action d’AbusePenalty.

Nom Type Description
Block

string

Throttle

string

Account

Le compte Cognitive Services est une ressource Azure qui représente le compte provisionné, son type, son emplacement et sa référence SKU.

Nom Type Description
etag

string

Etag de la ressource.

id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identité de la ressource.

kind

string

Type de la ressource.

location

string

Emplacement géographique où réside la ressource

name

string

nom de la ressource.

properties

AccountProperties

Propriétés du compte Cognitive Services.

sku

Sku

Définition du modèle de ressource représentant la référence SKU

systemData

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

AccountProperties

Propriétés du compte Cognitive Services.

Nom Type Description
abusePenalty

AbusePenalty

La pénalité d’abus.

allowedFqdnList

string[]

apiProperties

ApiProperties

Propriétés de l’API pour les API spéciales.

callRateLimit

CallRateLimit

La limite de débit d’appels compte Cognitive Services.

capabilities

SkuCapability[]

Obtient les fonctionnalités du compte Cognitive Services. Chaque élément indique la fonctionnalité d’une fonctionnalité spécifique. Les valeurs sont en lecture seule et à titre de référence uniquement.

commitmentPlanAssociations

CommitmentPlanAssociation[]

Associations de plan d’engagement du compte Cognitive Services.

customSubDomainName

string

Nom de sous-domaine facultatif utilisé pour l’authentification basée sur les jetons.

dateCreated

string

Obtient la date de création du compte Cognitive Services.

deletionDate

string

Date de suppression, disponible uniquement pour le compte supprimé.

disableLocalAuth

boolean

dynamicThrottlingEnabled

boolean

Indicateur permettant d’activer la limitation dynamique.

encryption

Encryption

Propriétés de chiffrement de cette ressource.

endpoint

string

Point de terminaison du compte créé.

endpoints

object

internalId

string

Identificateur interne (déconseillé, n’utilisez pas cette propriété).

isMigrated

boolean

Si la ressource est migrée à partir d’une clé existante.

locations

MultiRegionSettings

Paramètres multirégions du compte Cognitive Services.

migrationToken

string

Jeton de migration de ressource.

networkAcls

NetworkRuleSet

Collection de règles régissant l’accessibilité à partir d’emplacements réseau spécifiques.

privateEndpointConnections

PrivateEndpointConnection[]

Connexion de point de terminaison privé associée au compte Cognitive Services.

provisioningState

ProvisioningState

Obtient la status du compte Cognitive Services au moment de l’appel de l’opération.

publicNetworkAccess

PublicNetworkAccess

Indique si l’accès au point de terminaison public est autorisé pour ce compte.

quotaLimit

QuotaLimit

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

Date de vidage planifiée, disponible uniquement pour le compte supprimé.

skuChangeInfo

SkuChangeInfo

Informations de modification de la référence SKU du compte.

userOwnedStorage

UserOwnedStorage[]

Comptes de stockage pour cette ressource.

ApiProperties

Propriétés de l’API pour les API spéciales.

Nom Type Description
aadClientId

string

(Metrics Advisor uniquement) ID client Azure AD (ID d’application).

aadTenantId

string

(Metrics Advisor uniquement) ID de locataire Azure AD.

eventHubConnectionString

string

(Personnalisation uniquement) Indicateur permettant d’activer les statistiques de Recherche Bing.

qnaAzureSearchEndpointId

string

(QnAMaker uniquement) ID de point de terminaison Recherche Azure de QnAMaker.

qnaAzureSearchEndpointKey

string

(QnAMaker uniquement) Clé de point de terminaison Recherche Azure de QnAMaker.

qnaRuntimeEndpoint

string

(QnAMaker uniquement) Point de terminaison d’exécution de QnAMaker.

statisticsEnabled

boolean

(Recherche Bing uniquement) Indicateur permettant d’activer les statistiques de Recherche Bing.

storageAccountConnectionString

string

(Personnalisation uniquement) Le compte de stockage chaîne de connexion.

superUser

string

(Metrics Advisor uniquement) Super utilisateur de Metrics Advisor.

websiteName

string

(Metrics Advisor uniquement) Nom du site web de Metrics Advisor.

CallRateLimit

La limite de débit d’appels compte Cognitive Services.

Nom Type Description
count

number

Valeur de nombre de la limite de débit d’appels.

renewalPeriod

number

Période de renouvellement en secondes de limite de débit d’appels.

rules

ThrottlingRule[]

CommitmentPlanAssociation

Association du plan d’engagement.

Nom Type Description
commitmentPlanId

string

ID de ressource Azure du plan d’engagement.

commitmentPlanLocation

string

Emplacement du plan d’engagement.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

Encryption

Propriétés pour configurer le chiffrement

Nom Type Valeur par défaut Description
keySource

keySource

Microsoft.KeyVault

Énumère la valeur possible de keySource pour le chiffrement

keyVaultProperties

KeyVaultProperties

Propriétés de KeyVault

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

Identity

Identité de la ressource.

Nom Type Description
principalId

string

ID principal de l’identité de ressource.

tenantId

string

ID de locataire de la ressource.

type

ResourceIdentityType

Type d’identité.

userAssignedIdentities

<string,  UserAssignedIdentity>

Liste des identités affectées par l’utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Règle régissant l’accessibilité à partir d’une adresse ip ou d’une plage d’adresses IP spécifiques.

Nom Type Description
value

string

Une plage d’adresses IPv4 en notation CIDR, telle que « 124.56.78.91 » (adresse IP simple) ou « 124.56.78.0/24 » (toutes les adresses qui commencent par 124.56.78).

keySource

Énumère la valeur possible de keySource pour le chiffrement

Nom Type Description
Microsoft.CognitiveServices

string

Microsoft.KeyVault

string

KeyVaultProperties

Propriétés pour configurer les propriétés keyVault

Nom Type Description
identityClientId

string

keyName

string

Nom de la clé de KeyVault

keyVaultUri

string

URI de KeyVault

keyVersion

string

Version de la clé à partir de KeyVault

MultiRegionSettings

Compte Cognitive Services des paramètres multirégions.

Nom Type Description
regions

RegionSetting[]

La limite de débit d’appels compte Cognitive Services.

routingMethod

RoutingMethods

Méthodes de routage multirégion.

NetworkRuleAction

Action par défaut quand aucune règle d’ipRules et de virtualNetworkRules ne correspondent. Elle est utilisée uniquement après l’évaluation de la propriété bypass.

Nom Type Description
Allow

string

Deny

string

NetworkRuleSet

Ensemble de règles régissant l’accessibilité du réseau.

Nom Type Description
defaultAction

NetworkRuleAction

Action par défaut quand aucune règle d’ipRules et de virtualNetworkRules ne correspondent. Elle est utilisée uniquement après l’évaluation de la propriété bypass.

ipRules

IpRule[]

Liste des règles d’adresse IP.

virtualNetworkRules

VirtualNetworkRule[]

Liste des règles de réseau virtuel.

PrivateEndpoint

Ressource de point de terminaison privé.

Nom Type Description
id

string

Identificateur ARM pour le point de terminaison privé

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Nom Type Description
etag

string

Etag de la ressource.

id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Emplacement de la connexion de point de terminaison privé

name

string

nom de la ressource.

properties

PrivateEndpointConnectionProperties

Propriétés de ressource.

systemData

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProperties

Propriétés de PrivateEndpointConnectProperties.

Nom Type Description
groupIds

string[]

ID de groupe de ressources private link.

privateEndpoint

PrivateEndpoint

Ressource du point de terminaison privé.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

provisioningState

PrivateEndpointConnectionProvisioningState

État d’approvisionnement de la ressource de connexion de point de terminaison privé.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

Nom Type Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

La connexion de point de terminaison privé status.

Nom Type Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

Nom Type Description
actionsRequired

string

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

description

string

Motif de l’approbation/du rejet de la connexion.

status

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

ProvisioningState

Obtient la status du compte Cognitive Services au moment de l’appel de l’opération.

Nom Type Description
Accepted

string

Creating

string

Deleting

string

Failed

string

Moving

string

ResolvingDNS

string

Succeeded

string

PublicNetworkAccess

Indique si l’accès au point de terminaison public est autorisé pour ce compte.

Nom Type Description
Disabled

string

Enabled

string

QuotaLimit

Nom Type Description
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RegionSetting

La limite de débit d’appels compte Cognitive Services.

Nom Type Description
customsubdomain

string

Mappe la région au sous-domaine personnalisé régional.

name

string

Nom de la région.

value

number

Valeur pour les méthodes de routage prioritaires ou pondérées.

RequestMatchPattern

Nom Type Description
method

string

path

string

ResourceIdentityType

Type d’identité.

Nom Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RoutingMethods

Méthodes de routage multirégion.

Nom Type Description
Performance

string

Priority

string

Weighted

string

Sku

Définition du modèle de ressource représentant la référence SKU

Nom Type Description
capacity

integer

Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si un scale-out/scale-in n’est pas possible pour la ressource, cela peut être omis.

family

string

Si le service a différentes générations de matériel, pour la même référence SKU, cela peut être capturé ici.

name

string

Nom de la référence SKU. Ex - P3. Il s’agit généralement d’un code lettre+nombre

size

string

Taille de la référence SKU. Lorsque le champ name est la combinaison du niveau et d’une autre valeur, il s’agit du code autonome.

tier

SkuTier

Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas requis sur un PUT.

SkuCapability

SkuCapability indique la fonctionnalité d’une certaine fonctionnalité.

Nom Type Description
name

string

Nom de la SkuCapability.

value

string

Valeur de la SkuCapability.

SkuChangeInfo

Informations de modification de la référence SKU du compte.

Nom Type Description
countOfDowngrades

number

Obtient le nombre de rétrogradations.

countOfUpgradesAfterDowngrades

number

Obtient le nombre de mises à niveau après les rétrogradations.

lastChangeDate

string

Obtient la date de la dernière modification.

SkuTier

Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas requis sur un PUT.

Nom Type Description
Basic

string

Enterprise

string

Free

string

Premium

string

Standard

string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

ThrottlingRule

Nom Type Description
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number

UserAssignedIdentity

Identité managée affectée par l’utilisateur.

Nom Type Description
clientId

string

ID d’application client associé à cette identité.

principalId

string

ID de principal Azure Active Directory associé à cette identité.

UserOwnedStorage

Stockage appartenant à l’utilisateur pour le compte Cognitive Services.

Nom Type Description
identityClientId

string

resourceId

string

ID de ressource complet d’une ressource Microsoft.Storage.

VirtualNetworkRule

Règle régissant l’accessibilité à partir d’un réseau virtuel spécifique.

Nom Type Description
id

string

ID de ressource complet d’un sous-réseau de réseau virtuel, tel que « /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnets/subnets1 ».

ignoreMissingVnetServiceEndpoint

boolean

Ignorez ou non le point de terminaison de service de réseau virtuel manquant.

state

string

Obtient l’état de la règle de réseau virtuel.