Accounts - Update

Aktualizacje konto usług Cognitive Services

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
accountName
path True

string

Nazwa konta usług Cognitive Services.

Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Typ Opis
identity

Identity

Tożsamość zasobu.

kind

string

Rodzaj zasobu.

location

string

Lokalizacja geograficzna, w której znajduje się zasób

properties

AccountProperties

Właściwości konta usług Cognitive Services.

sku

Sku

Definicja modelu zasobów reprezentująca jednostkę SKU

tags

object

Tagi zasobów.

Odpowiedzi

Nazwa Typ Opis
200 OK

Account

Dostawca zasobów powinien zwrócić 200 (OK), aby wskazać, że operacja została ukończona pomyślnie.

202 Accepted

Account

HTTP 202 (Zaakceptowano), jeśli operacja została pomyślnie uruchomiona i zostanie ukończona asynchronicznie.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. Jeśli grupa zasobów lub zasób nie istnieje, należy zwrócić 404 (NotFound).

Przykłady

Update Account

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AbusePenalty

Kara za nadużycie.

AbusePenaltyAction

Działanie AbusePenalty.

Account

Konto usług Cognitive Services to zasób platformy Azure reprezentujący zaaprowizowane konto, typ, lokalizację i jednostkę SKU.

AccountProperties

Właściwości konta usług Cognitive Services.

ApiProperties

Właściwości interfejsu API dla specjalnych interfejsów API.

CallRateLimit

Limit liczby wywołań konta usług Cognitive Services.

CommitmentPlanAssociation

Skojarzenie planu zobowiązania.

createdByType

Typ tożsamości, która utworzyła zasób.

Encryption

Właściwości do konfigurowania szyfrowania

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

Identity

Tożsamość zasobu.

IpRule

Reguła rządząca ułatwieniami dostępu z określonego adresu IP lub zakresu adresów IP.

keySource

Wylicza możliwą wartość kluczaSource dla szyfrowania

KeyVaultProperties

Właściwości do konfigurowania właściwości usługi KeyVault

MultiRegionSettings

Konto usług Cognitive Services w wielu regionach.

NetworkRuleAction

Akcja domyślna, gdy nie jest zgodna żadna reguła z reguł ipRules i virtualNetworkRules. Jest to używane tylko po ocenie właściwości obejścia.

NetworkRuleSet

Zestaw reguł zarządzających ułatwieniami dostępu do sieci.

PrivateEndpoint

Zasób prywatnego punktu końcowego.

PrivateEndpointConnection

Zasób połączenia prywatnego punktu końcowego.

PrivateEndpointConnectionProperties

Właściwości właściwości PrivateEndpointConnectProperties.

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

PrivateLinkServiceConnectionState

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

ProvisioningState

Pobiera stan konta usług Cognitive Services w momencie wywołania operacji.

PublicNetworkAccess

Niezależnie od tego, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego konta.

QuotaLimit
RegionSetting

Limit liczby wywołań konta usług Cognitive Services.

RequestMatchPattern
ResourceIdentityType

Typ tożsamości.

RoutingMethods

Metody routingu w wielu regionach.

Sku

Definicja modelu zasobów reprezentująca jednostkę SKU

SkuCapability

SkuCapability wskazuje możliwości określonej funkcji.

SkuChangeInfo

Informacje o zmianie konta przez jednostkę SKU.

SkuTier

To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ThrottlingRule
UserAssignedIdentity

Tożsamość zarządzana przypisana przez użytkownika.

UserOwnedStorage

Magazyn należący do użytkownika dla konta usług Cognitive Services.

VirtualNetworkRule

Reguła rządząca ułatwieniami dostępu z określonej sieci wirtualnej.

AbusePenalty

Kara za nadużycie.

Nazwa Typ Opis
action

AbusePenaltyAction

Działanie AbusePenalty.

expiration

string

Data/godzina wygaśnięcia nadużyciaPenalty.

rateLimitPercentage

number

Procent limitu szybkości.

AbusePenaltyAction

Działanie AbusePenalty.

Nazwa Typ Opis
Block

string

Throttle

string

Account

Konto usług Cognitive Services to zasób platformy Azure reprezentujący zaaprowizowane konto, typ, lokalizację i jednostkę SKU.

Nazwa Typ Opis
etag

string

Zasób Etag.

id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Tożsamość zasobu.

kind

string

Rodzaj zasobu.

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties

AccountProperties

Właściwości konta usług Cognitive Services.

sku

Sku

Definicja modelu zasobów reprezentująca jednostkę SKU

systemData

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

AccountProperties

Właściwości konta usług Cognitive Services.

Nazwa Typ Opis
abusePenalty

AbusePenalty

Kara za nadużycie.

allowedFqdnList

string[]

apiProperties

ApiProperties

Właściwości interfejsu API dla specjalnych interfejsów API.

callRateLimit

CallRateLimit

Limit liczby wywołań konta usług Cognitive Services.

capabilities

SkuCapability[]

Pobiera możliwości konta usług Cognitive Services. Każdy element wskazuje możliwość określonej funkcji. Wartości są tylko do odczytu i są przeznaczone tylko do celów referencyjnych.

commitmentPlanAssociations

CommitmentPlanAssociation[]

Skojarzenia planu zobowiązania konta usług Cognitive Services.

customSubDomainName

string

Opcjonalna nazwa poddomeny używana do uwierzytelniania opartego na tokenach.

dateCreated

string

Pobiera datę utworzenia konta usług Cognitive Services.

deletionDate

string

Data usunięcia, dostępna tylko dla usuniętego konta.

disableLocalAuth

boolean

dynamicThrottlingEnabled

boolean

Flaga umożliwiająca dynamiczne ograniczanie przepustowości.

encryption

Encryption

Właściwości szyfrowania dla tego zasobu.

endpoint

string

Punkt końcowy utworzonego konta.

endpoints

object

internalId

string

Identyfikator wewnętrzny (przestarzały, nie używaj tej właściwości).

isMigrated

boolean

Jeśli zasób jest migrowany z istniejącego klucza.

locations

MultiRegionSettings

Ustawienia wieloregionowe konta usług Cognitive Services.

migrationToken

string

Token migracji zasobów.

networkAcls

NetworkRuleSet

Kolekcja reguł zarządzających ułatwieniami dostępu z określonych lokalizacji sieciowych.

privateEndpointConnections

PrivateEndpointConnection[]

Połączenie prywatnego punktu końcowego skojarzone z kontem usług Cognitive Services.

provisioningState

ProvisioningState

Pobiera stan konta usług Cognitive Services w momencie wywołania operacji.

publicNetworkAccess

PublicNetworkAccess

Niezależnie od tego, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego konta.

quotaLimit

QuotaLimit

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

Zaplanowana data przeczyszczania, dostępna tylko dla usuniętego konta.

skuChangeInfo

SkuChangeInfo

Informacje o zmianie konta przez jednostkę SKU.

userOwnedStorage

UserOwnedStorage[]

Konta magazynu dla tego zasobu.

ApiProperties

Właściwości interfejsu API dla specjalnych interfejsów API.

Nazwa Typ Opis
aadClientId

string

(Tylko doradca metryk) Identyfikator klienta Azure AD (identyfikator aplikacji).

aadTenantId

string

(Tylko doradca metryk) Identyfikator dzierżawy Azure AD.

eventHubConnectionString

string

(Tylko personalizacja) Flaga umożliwiająca włączenie statystyk Wyszukiwanie Bing.

qnaAzureSearchEndpointId

string

(Tylko QnAMaker) Identyfikator punktu końcowego usługi Azure Search usługi QnAMaker.

qnaAzureSearchEndpointKey

string

(Tylko QnAMaker) Klucz punktu końcowego usługi Azure Search usługi QnAMaker.

qnaRuntimeEndpoint

string

(Tylko QnAMaker) Punkt końcowy środowiska uruchomieniowego QnAMaker.

statisticsEnabled

boolean

(tylko Wyszukiwanie Bing) Flaga umożliwiająca włączenie statystyk Wyszukiwanie Bing.

storageAccountConnectionString

string

(Tylko personalizacja) Konto magazynu parametry połączenia.

superUser

string

(Tylko doradca metryk) Superuchemij użytkownik klasyfikatora metryk.

websiteName

string

(Tylko doradca metryk) Nazwa witryny internetowej klasyfikatora metryk.

CallRateLimit

Limit liczby wywołań konta usług Cognitive Services.

Nazwa Typ Opis
count

number

Wartość licznika limitu liczby wywołań.

renewalPeriod

number

Okres odnawiania w sekundach limitu liczby wywołań.

rules

ThrottlingRule[]

CommitmentPlanAssociation

Skojarzenie planu zobowiązania.

Nazwa Typ Opis
commitmentPlanId

string

Identyfikator zasobu platformy Azure planu zobowiązania.

commitmentPlanLocation

string

Lokalizacja planu zobowiązania.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

Encryption

Właściwości do konfigurowania szyfrowania

Nazwa Typ Domyślna wartość Opis
keySource

keySource

Microsoft.KeyVault

Wylicza możliwą wartość kluczaSource dla szyfrowania

keyVaultProperties

KeyVaultProperties

Właściwości usługi KeyVault

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

Identity

Tożsamość zasobu.

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu.

tenantId

string

Identyfikator dzierżawy zasobu.

type

ResourceIdentityType

Typ tożsamości.

userAssignedIdentities

<string,  UserAssignedIdentity>

Lista tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Reguła rządząca ułatwieniami dostępu z określonego adresu IP lub zakresu adresów IP.

Nazwa Typ Opis
value

string

Zakres adresów IPv4 w notacji CIDR, taki jak "124.56.78.91" (prosty adres IP) lub "124.56.78.0/24" (wszystkie adresy rozpoczynające się od 124.56.78).

keySource

Wylicza możliwą wartość kluczaSource dla szyfrowania

Nazwa Typ Opis
Microsoft.CognitiveServices

string

Microsoft.KeyVault

string

KeyVaultProperties

Właściwości do konfigurowania właściwości usługi KeyVault

Nazwa Typ Opis
identityClientId

string

keyName

string

Nazwa klucza z usługi KeyVault

keyVaultUri

string

Identyfikator URI usługi KeyVault

keyVersion

string

Wersja klucza z usługi KeyVault

MultiRegionSettings

Konto usług Cognitive Services w wielu regionach.

Nazwa Typ Opis
regions

RegionSetting[]

Limit liczby wywołań konta usług Cognitive Services.

routingMethod

RoutingMethods

Metody routingu w wielu regionach.

NetworkRuleAction

Akcja domyślna, gdy nie jest zgodna żadna reguła z reguł ipRules i virtualNetworkRules. Jest to używane tylko po ocenie właściwości obejścia.

Nazwa Typ Opis
Allow

string

Deny

string

NetworkRuleSet

Zestaw reguł zarządzających ułatwieniami dostępu do sieci.

Nazwa Typ Opis
defaultAction

NetworkRuleAction

Akcja domyślna, gdy nie jest zgodna żadna reguła z reguł ipRules i virtualNetworkRules. Jest to używane tylko po ocenie właściwości obejścia.

ipRules

IpRule[]

Lista reguł adresów IP.

virtualNetworkRules

VirtualNetworkRule[]

Lista reguł sieci wirtualnej.

PrivateEndpoint

Zasób prywatnego punktu końcowego.

Nazwa Typ Opis
id

string

Identyfikator usługi ARM dla prywatnego punktu końcowego

PrivateEndpointConnection

Zasób połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
etag

string

Zasób Etag.

id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Lokalizacja połączenia prywatnego punktu końcowego

name

string

Nazwa zasobu

properties

PrivateEndpointConnectionProperties

Właściwości zasobu.

systemData

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Właściwości właściwości PrivateEndpointConnectProperties.

Nazwa Typ Opis
groupIds

string[]

Identyfikatory grupy zasobów łącza prywatnego.

privateEndpoint

PrivateEndpoint

Zasób prywatnego punktu końcowego.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

provisioningState

PrivateEndpointConnectionProvisioningState

Stan aprowizacji zasobu połączenia prywatnego punktu końcowego.

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

Nazwa Typ Opis
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

Nazwa Typ Opis
actionsRequired

string

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

description

string

Przyczyna zatwierdzenia/odrzucenia połączenia.

status

PrivateEndpointServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

ProvisioningState

Pobiera stan konta usług Cognitive Services w momencie wywołania operacji.

Nazwa Typ Opis
Accepted

string

Creating

string

Deleting

string

Failed

string

Moving

string

ResolvingDNS

string

Succeeded

string

PublicNetworkAccess

Niezależnie od tego, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego konta.

Nazwa Typ Opis
Disabled

string

Enabled

string

QuotaLimit

Nazwa Typ Opis
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RegionSetting

Limit liczby wywołań konta usług Cognitive Services.

Nazwa Typ Opis
customsubdomain

string

Mapuje region na regionalną poddomenę niestandardową.

name

string

Nazwa regionu.

value

number

Wartość dla metod routingu priorytetowego lub ważonego.

RequestMatchPattern

Nazwa Typ Opis
method

string

path

string

ResourceIdentityType

Typ tożsamości.

Nazwa Typ Opis
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RoutingMethods

Metody routingu w wielu regionach.

Nazwa Typ Opis
Performance

string

Priority

string

Weighted

string

Sku

Definicja modelu zasobów reprezentująca jednostkę SKU

Nazwa Typ Opis
capacity

integer

Jeśli jednostka SKU obsługuje skalowanie w poziomie/w poziomie, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte.

family

string

Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj.

name

string

Nazwa jednostki SKU. Ex — P3. Zazwyczaj jest to kod litery i cyfry

size

string

Rozmiar jednostki SKU. Gdy pole nazwy jest kombinacją warstwy i inną wartością, będzie to autonomiczny kod.

tier

SkuTier

To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

SkuCapability

SkuCapability wskazuje możliwości określonej funkcji.

Nazwa Typ Opis
name

string

Nazwa skuCapability.

value

string

Wartość skuCapability.

SkuChangeInfo

Informacje o zmianie konta przez jednostkę SKU.

Nazwa Typ Opis
countOfDowngrades

number

Pobiera liczbę obniżek.

countOfUpgradesAfterDowngrades

number

Pobiera liczbę uaktualnień po obniżeniu poziomu.

lastChangeDate

string

Pobiera ostatnią datę zmiany.

SkuTier

To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

Nazwa Typ Opis
Basic

string

Enterprise

string

Free

string

Premium

string

Standard

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

ThrottlingRule

Nazwa Typ Opis
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number

UserAssignedIdentity

Tożsamość zarządzana przypisana przez użytkownika.

Nazwa Typ Opis
clientId

string

Identyfikator aplikacji klienckiej skojarzony z tą tożsamością.

principalId

string

Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory skojarzony z tą tożsamością.

UserOwnedStorage

Magazyn należący do użytkownika dla konta usług Cognitive Services.

Nazwa Typ Opis
identityClientId

string

resourceId

string

Pełny identyfikator zasobu Microsoft.Storage.

VirtualNetworkRule

Reguła rządząca ułatwieniami dostępu z określonej sieci wirtualnej.

Nazwa Typ Opis
id

string

Pełny identyfikator zasobu podsieci sieci wirtualnej, taki jak "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

ignoreMissingVnetServiceEndpoint

boolean

Ignoruj brakujący punkt końcowy usługi sieci wirtualnej lub nie.

state

string

Pobiera stan reguły sieci wirtualnej.