Condividi tramite


Accounts - Update

Aggiorna un account servizi cognitivi

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
accountName
path True

string

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

Nome dell'account servizi cognitivi.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

minLength: 1

ID della sottoscrizione di destinazione.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
identity

Identity

Identità per la risorsa.

kind

string

Tipo di risorsa.

location

string

Posizione geografica in cui risiede la risorsa

properties

AccountProperties

Proprietà dell'account servizi cognitivi.

sku

Sku

Definizione del modello di risorse che rappresenta lo SKU

tags

object

Tag di risorsa.

Risposte

Nome Tipo Descrizione
200 OK

Account

Il provider di risorse deve restituire 200 (OK) per indicare che l'operazione è stata completata correttamente.

202 Accepted

Account

HTTP 202 (accettato) se l'operazione è stata avviata correttamente e verrà completata in modo asincrono.

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. Se il gruppo di risorse o risorsa non esiste, deve essere restituito 404 (NotFound).

Esempio

Update Account

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
AbusePenalty

La pena di abuso.

AbusePenaltyAction

L'azione di AbusePenalty.

Account

L'account di Servizi cognitivi è una risorsa di Azure che rappresenta l'account di cui è stato effettuato il provisioning, ovvero il tipo, la posizione e lo SKU.

AccountProperties

Proprietà dell'account servizi cognitivi.

ApiProperties

Proprietà api per API speciali.

ByPassSelection

Impostazione per i servizi attendibili.

CallRateLimit

L'account servizi cognitivi limita la frequenza delle chiamate.

CommitmentPlanAssociation

Associazione del piano di impegno.

createdByType

Tipo di identità che ha creato la risorsa.

Encryption

Proprietà per configurare la crittografia

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

Identity

Identità per la risorsa.

IpRule

Regola che regola l'accessibilità da un indirizzo IP o un intervallo ip specifico.

keySource

Enumera il valore possibile di keySource per la crittografia

KeyVaultProperties

Proprietà per configurare le proprietà dell'insieme di credenziali delle chiavi

MultiRegionSettings

L'account Servizi cognitivi delle impostazioni di più aree.

NetworkRuleAction

Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass.

NetworkRuleSet

Set di regole che regolano l'accessibilità di rete.

PrivateEndpoint

Risorsa endpoint privato.

PrivateEndpointConnection

Risorsa connessione endpoint privato.

PrivateEndpointConnectionProperties

Proprietà di PrivateEndpointConnectProperties.

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.

ProvisioningState

Ottiene lo stato dell'account servizi cognitivi al momento della chiamata dell'operazione.

PublicNetworkAccess

Indica se l'accesso all'endpoint pubblico è consentito per questo account.

QuotaLimit
RaiMonitorConfig

Configurazione di Rai Monitor di Servizi cognitivi.

RegionSetting

L'account servizi cognitivi limita la frequenza delle chiamate.

RequestMatchPattern
ResourceIdentityType

Tipo di identità.

RoutingMethods

Metodi di routing di più aree.

Sku

Definizione del modello di risorse che rappresenta lo SKU

SkuCapability

SkuCapability indica la funzionalità di una determinata funzionalità.

SkuChangeInfo

Informazioni sulla modifica dello SKU dell'account.

SkuTier

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

ThrottlingRule
UserAssignedIdentity

Identità gestita assegnata dall'utente.

UserOwnedAmlWorkspace

Area di lavoro AML di proprietà dell'utente per l'account servizi cognitivi.

UserOwnedStorage

Archiviazione di proprietà dell'utente per l'account servizi cognitivi.

VirtualNetworkRule

Regola che regola l'accessibilità da una rete virtuale specifica.

AbusePenalty

La pena di abuso.

Nome Tipo Descrizione
action

AbusePenaltyAction

L'azione di AbusePenalty.

expiration

string (date-time)

Data di scadenza di AbusePenalty.

rateLimitPercentage

number

Percentuale di limite di velocità.

AbusePenaltyAction

L'azione di AbusePenalty.

Valore Descrizione
Block
Throttle

Account

L'account di Servizi cognitivi è una risorsa di Azure che rappresenta l'account di cui è stato effettuato il provisioning, ovvero il tipo, la posizione e lo SKU.

Nome Tipo Descrizione
etag

string

Etag risorsa.

id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identità per la risorsa.

kind

string

Tipo di risorsa.

location

string

Posizione geografica in cui risiede la risorsa

name

string

Nome della risorsa

properties

AccountProperties

Proprietà dell'account servizi cognitivi.

sku

Sku

Definizione del modello di risorse che rappresenta lo SKU

systemData

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

tags

object

Tag di risorsa.

type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

AccountProperties

Proprietà dell'account servizi cognitivi.

Nome Tipo Descrizione
abusePenalty

AbusePenalty

La pena di abuso.

allowedFqdnList

string[]

amlWorkspace

UserOwnedAmlWorkspace

Proprietà dell'area di lavoro AML di proprietà dell'utente.

apiProperties

ApiProperties

Proprietà api per API speciali.

callRateLimit

CallRateLimit

L'account servizi cognitivi limita la frequenza delle chiamate.

capabilities

SkuCapability[]

Ottiene le funzionalità dell'account servizi cognitivi. Ogni elemento indica la funzionalità di una funzionalità specifica. I valori sono di sola lettura e solo per riferimento.

commitmentPlanAssociations

CommitmentPlanAssociation[]

Associazioni del piano di impegno dell'account di Servizi cognitivi.

customSubDomainName

string

Nome sottodominio facoltativo usato per l'autenticazione basata su token.

dateCreated

string

Ottiene la data di creazione dell'account di Servizi cognitivi.

deletionDate

string

Data di eliminazione, disponibile solo per l'account eliminato.

disableLocalAuth

boolean

dynamicThrottlingEnabled

boolean

Flag per abilitare la limitazione dinamica.

encryption

Encryption

Proprietà di crittografia per questa risorsa.

endpoint

string

Endpoint dell'account creato.

endpoints

object

internalId

string

Identificatore interno (deprecato, non usare questa proprietà).

isMigrated

boolean

Se la risorsa viene migrata da una chiave esistente.

locations

MultiRegionSettings

Impostazioni multiregione dell'account servizi cognitivi.

migrationToken

string

Token di migrazione delle risorse.

networkAcls

NetworkRuleSet

Raccolta di regole che regolano l'accessibilità da percorsi di rete specifici.

privateEndpointConnections

PrivateEndpointConnection[]

Connessione dell'endpoint privato associato all'account servizi cognitivi.

provisioningState

ProvisioningState

Ottiene lo stato dell'account servizi cognitivi al momento della chiamata dell'operazione.

publicNetworkAccess

PublicNetworkAccess

Indica se l'accesso all'endpoint pubblico è consentito per questo account.

quotaLimit

QuotaLimit

raiMonitorConfig

RaiMonitorConfig

Configurazione di Rai Monitor di Servizi cognitivi.

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

Data di eliminazione pianificata, disponibile solo per l'account eliminato.

skuChangeInfo

SkuChangeInfo

Informazioni sulla modifica dello SKU dell'account.

userOwnedStorage

UserOwnedStorage[]

Account di archiviazione per questa risorsa.

ApiProperties

Proprietà api per API speciali.

Nome Tipo Descrizione
aadClientId

string

maxLength: 500

(Solo Advisor metriche) ID client di Azure AD (ID applicazione).

aadTenantId

string

maxLength: 500

(Solo Advisor metriche) ID tenant di Azure AD.

eventHubConnectionString

string

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

(Solo personalizzazione) Flag per abilitare le statistiche di Ricerca Bing.

qnaAzureSearchEndpointId

string

(solo QnAMaker) ID endpoint di Ricerca di Azure di QnAMaker.

qnaAzureSearchEndpointKey

string

(solo QnAMaker) Chiave dell'endpoint di Ricerca di Azure di QnAMaker.

qnaRuntimeEndpoint

string

(solo QnAMaker) Endpoint di runtime di QnAMaker.

statisticsEnabled

boolean

(Solo ricerca Bing) Flag per abilitare le statistiche di Ricerca Bing.

storageAccountConnectionString

string

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

(Solo personalizzazione) Stringa di connessione dell'account di archiviazione.

superUser

string

maxLength: 500

(Solo Advisor metriche) Utente con privilegi avanzati di Advisor metriche.

websiteName

string

maxLength: 500

(Solo Advisor metriche) Nome del sito Web di Advisor metriche.

ByPassSelection

Impostazione per i servizi attendibili.

Valore Descrizione
AzureServices
None

CallRateLimit

L'account servizi cognitivi limita la frequenza delle chiamate.

Nome Tipo Descrizione
count

number

Valore count di Call Rate Limit.

renewalPeriod

number

Periodo di rinnovo in secondi del limite di frequenza delle chiamate.

rules

ThrottlingRule[]

CommitmentPlanAssociation

Associazione del piano di impegno.

Nome Tipo Descrizione
commitmentPlanId

string

ID risorsa di Azure del piano di impegno.

commitmentPlanLocation

string

Posizione del piano di impegno.

createdByType

Tipo di identità che ha creato la risorsa.

Valore Descrizione
Application
Key
ManagedIdentity
User

Encryption

Proprietà per configurare la crittografia

Nome Tipo Valore predefinito Descrizione
keySource

keySource

Microsoft.KeyVault

Enumera il valore possibile di keySource per la crittografia

keyVaultProperties

KeyVaultProperties

Proprietà di KeyVault

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

Identity

Identità per la risorsa.

Nome Tipo Descrizione
principalId

string

ID principale dell'identità della risorsa.

tenantId

string

ID tenant della risorsa.

type

ResourceIdentityType

Tipo di identità.

userAssignedIdentities

<string,  UserAssignedIdentity>

Elenco di identità assegnate dall'utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Regola che regola l'accessibilità da un indirizzo IP o un intervallo ip specifico.

Nome Tipo Descrizione
value

string

Intervallo di indirizzi IPv4 nella notazione CIDR, ad esempio "124.56.78.91" (indirizzo IP semplice) o "124.56.78.0/24" (tutti gli indirizzi che iniziano con 124.56.78).

keySource

Enumera il valore possibile di keySource per la crittografia

Valore Descrizione
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Proprietà per configurare le proprietà dell'insieme di credenziali delle chiavi

Nome Tipo Descrizione
identityClientId

string

keyName

string

Nome della chiave da KeyVault

keyVaultUri

string

Uri dell'insieme di credenziali delle chiavi

keyVersion

string

Versione della chiave da KeyVault

MultiRegionSettings

L'account Servizi cognitivi delle impostazioni di più aree.

Nome Tipo Descrizione
regions

RegionSetting[]

L'account servizi cognitivi limita la frequenza delle chiamate.

routingMethod

RoutingMethods

Metodi di routing di più aree.

NetworkRuleAction

Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass.

Valore Descrizione
Allow
Deny

NetworkRuleSet

Set di regole che regolano l'accessibilità di rete.

Nome Tipo Descrizione
bypass

ByPassSelection

Impostazione per i servizi attendibili.

defaultAction

NetworkRuleAction

Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrispondono. Questa proprietà viene utilizzata solo dopo la valutazione della proprietà bypass.

ipRules

IpRule[]

Elenco delle regole degli indirizzi IP.

virtualNetworkRules

VirtualNetworkRule[]

Elenco delle regole di rete virtuale.

PrivateEndpoint

Risorsa endpoint privato.

Nome Tipo Descrizione
id

string

Identificatore arm per endpoint privato

PrivateEndpointConnection

Risorsa connessione endpoint privato.

Nome Tipo Descrizione
etag

string

Etag risorsa.

id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Posizione della connessione all'endpoint privato

name

string

Nome della risorsa

properties

PrivateEndpointConnectionProperties

Proprietà delle risorse.

systemData

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Proprietà di PrivateEndpointConnectProperties.

Nome Tipo Descrizione
groupIds

string[]

ID del gruppo di risorse collegamento privato.

privateEndpoint

PrivateEndpoint

Risorsa dell'endpoint privato.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.

provisioningState

PrivateEndpointConnectionProvisioningState

Stato di provisioning della risorsa di connessione dell'endpoint privato.

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

Valore Descrizione
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

Valore Descrizione
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.

Nome Tipo Descrizione
actionsRequired

string

Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer.

description

string

Motivo dell'approvazione/rifiuto della connessione.

status

PrivateEndpointServiceConnectionStatus

Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.

ProvisioningState

Ottiene lo stato dell'account servizi cognitivi al momento della chiamata dell'operazione.

Valore Descrizione
Accepted
Creating
Deleting
Failed
Moving
ResolvingDNS
Succeeded

PublicNetworkAccess

Indica se l'accesso all'endpoint pubblico è consentito per questo account.

Valore Descrizione
Disabled
Enabled

QuotaLimit

Nome Tipo Descrizione
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RaiMonitorConfig

Configurazione di Rai Monitor di Servizi cognitivi.

Nome Tipo Descrizione
adxStorageResourceId

string

ID risorsa di archiviazione.

identityClientId

string

ID client di identità per accedere all'archiviazione.

RegionSetting

L'account servizi cognitivi limita la frequenza delle chiamate.

Nome Tipo Descrizione
customsubdomain

string

Esegue il mapping dell'area al sottodominio personalizzato a livello di area.

name

string

Nome dell'area.

value

number

Valore per i metodi di routing con priorità o ponderata.

RequestMatchPattern

Nome Tipo Descrizione
method

string

path

string

ResourceIdentityType

Tipo di identità.

Valore Descrizione
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RoutingMethods

Metodi di routing di più aree.

Valore Descrizione
Performance
Priority
Weighted

Sku

Definizione del modello di risorse che rappresenta lo SKU

Nome Tipo Descrizione
capacity

integer (int32)

Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso.

family

string

Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui.

name

string

Nome dello SKU. Ad esempio - P3. Si tratta in genere di un codice lettera+numero

size

string

Dimensioni dello SKU. Quando il campo nome è la combinazione di livello e un altro valore, si tratta del codice autonomo.

tier

SkuTier

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

SkuCapability

SkuCapability indica la funzionalità di una determinata funzionalità.

Nome Tipo Descrizione
name

string

Nome dell'oggetto SkuCapability.

value

string

Valore di SkuCapability.

SkuChangeInfo

Informazioni sulla modifica dello SKU dell'account.

Nome Tipo Descrizione
countOfDowngrades

number

Ottiene il conteggio dei downgrade.

countOfUpgradesAfterDowngrades

number

Ottiene il numero di aggiornamenti dopo il downgrade.

lastChangeDate

string

Ottiene l'ultima data di modifica.

SkuTier

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

Valore Descrizione
Basic
Enterprise
Free
Premium
Standard

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string (date-time)

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

ThrottlingRule

Nome Tipo Descrizione
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number

UserAssignedIdentity

Identità gestita assegnata dall'utente.

Nome Tipo Descrizione
clientId

string

ID app client associato a questa identità.

principalId

string

ID entità di Azure Active Directory associato a questa identità.

UserOwnedAmlWorkspace

Area di lavoro AML di proprietà dell'utente per l'account servizi cognitivi.

Nome Tipo Descrizione
identityClientId

string

ID client di identità di una risorsa dell'area di lavoro AML.

resourceId

string

ID risorsa completa di una risorsa dell'area di lavoro AML.

UserOwnedStorage

Archiviazione di proprietà dell'utente per l'account servizi cognitivi.

Nome Tipo Descrizione
identityClientId

string

resourceId

string

ID risorsa completo di una risorsa Microsoft.Storage.

VirtualNetworkRule

Regola che regola l'accessibilità da una rete virtuale specifica.

Nome Tipo Descrizione
id

string

ID risorsa completo di una subnet di rete virtuale, ad esempio "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

ignoreMissingVnetServiceEndpoint

boolean

Ignorare o meno l'endpoint del servizio di rete virtuale mancante.

state

string

Ottiene lo stato della regola di rete virtuale.