Accounts - Update
Cognitive Services-fiók Frissítések
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2023-05-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
account
|
path | True |
string |
A Cognitive Services-fiók neve. Regex pattern: |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem törzse
Name | Típus | Description |
---|---|---|
identity |
Az erőforrás identitása. |
|
kind |
string |
Az erőforrás típusa. |
location |
string |
A földrajzi hely, ahol az erőforrás él |
properties |
A Cognitive Services-fiók tulajdonságai. |
|
sku |
A termékváltozatot képviselő erőforrásmodell-definíció |
|
tags |
object |
Erőforráscímkék. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Az erőforrás-szolgáltatónak 200-nak (OK) kell visszaadnia, hogy a művelet sikeresen befejeződött. |
|
202 Accepted |
HTTP 202 (Elfogadva), ha a művelet sikeresen elindult, és aszinkron módon fog befejeződni. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. Ha az erőforráscsoport vagy erőforrás nem létezik, a rendszer a 404-et (NotFound) adja vissza. |
Példák
Update Account
Sample Request
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"
}
}
Definíciók
Name | Description |
---|---|
Abuse |
A visszaélés büntetés. |
Abuse |
A AbusePenalty művelete. |
Account |
A Cognitive Services-fiók egy Azure-erőforrás, amely a kiépített fiókot képviseli, típusa, helye és termékváltozata. |
Account |
A Cognitive Services-fiók tulajdonságai. |
Api |
A speciális API-k API-tulajdonságai. |
Call |
A hívási sebesség korlátozza a Cognitive Services-fiókot. |
Commitment |
A kötelezettségvállalási terv társítása. |
created |
Az erőforrást létrehozó identitás típusa. |
Encryption |
A titkosítás konfigurálásához használt tulajdonságok |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Identity |
Az erőforrás identitása. |
Ip |
Egy adott IP-cím vagy IP-címtartomány akadálymentességét szabályozó szabály. |
key |
A keySource for Encryption lehetséges értékének számbavétele |
Key |
Tulajdonságok a keyVault tulajdonságainak konfigurálásához |
Multi |
A többrégiós beállítások Cognitive Services-fiók. |
Network |
Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer. |
Network |
A hálózati akadálymentességet szabályozó szabályok halmaza. |
Private |
A privát végpont erőforrása. |
Private |
A privát végpont kapcsolati erőforrása. |
Private |
A PrivateEndpointConnectProperties tulajdonságai. |
Private |
Az aktuális kiépítési állapot. |
Private |
A privát végpont kapcsolati állapota. |
Private |
A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye. |
Provisioning |
Lekéri a Cognitive Services-fiók állapotát a művelet meghívásának időpontjában. |
Public |
Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a fiókhoz. |
Quota |
|
Region |
A hívási sebesség korlátozza a Cognitive Services-fiókot. |
Request |
|
Resource |
Az identitás típusa. |
Routing |
Többrégiós útválasztási módszerek. |
Sku |
A termékváltozatot képviselő erőforrásmodell-definíció |
Sku |
A SkuCapability egy adott funkció képességeit jelzi. |
Sku |
A termékváltozat módosítási adatai a fiókról. |
Sku |
Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges. |
system |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
Throttling |
|
User |
Felhasználó által hozzárendelt felügyelt identitás. |
User |
A cognitive services-fiók felhasználó tulajdonában lévő tárterület. |
Virtual |
Egy adott virtuális hálózat akadálymentességét szabályozó szabály. |
AbusePenalty
A visszaélés büntetés.
Name | Típus | Description |
---|---|---|
action |
A AbusePenalty művelete. |
|
expiration |
string |
A AbusePenalty lejáratának dátuma. |
rateLimitPercentage |
number |
A sebességkorlát százalékos értéke. |
AbusePenaltyAction
A AbusePenalty művelete.
Name | Típus | Description |
---|---|---|
Block |
string |
|
Throttle |
string |
Account
A Cognitive Services-fiók egy Azure-erőforrás, amely a kiépített fiókot képviseli, típusa, helye és termékváltozata.
Name | Típus | Description |
---|---|---|
etag |
string |
Erőforráscímke. |
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Az erőforrás identitása. |
|
kind |
string |
Az erőforrás típusa. |
location |
string |
A földrajzi hely, ahol az erőforrás él |
name |
string |
Az erőforrás neve |
properties |
A Cognitive Services-fiók tulajdonságai. |
|
sku |
A termékváltozatot képviselő erőforrásmodell-definíció |
|
systemData |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
|
tags |
object |
Erőforráscímkék. |
type |
string |
Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
AccountProperties
A Cognitive Services-fiók tulajdonságai.
Name | Típus | Description |
---|---|---|
abusePenalty |
A visszaélés büntetés. |
|
allowedFqdnList |
string[] |
|
apiProperties |
A speciális API-k API-tulajdonságai. |
|
callRateLimit |
A hívási sebesség korlátozza a Cognitive Services-fiókot. |
|
capabilities |
Lekéri a Cognitive Services-fiók képességeit. Minden elem egy adott funkció képességeit jelzi. Az értékek írásvédettek, és csak referenciaként használhatók. |
|
commitmentPlanAssociations |
A Cognitive Services-fiók kötelezettségvállalási csomagjainak társításai. |
|
customSubDomainName |
string |
A tokenalapú hitelesítéshez használt nem kötelező altartománynév. |
dateCreated |
string |
Lekéri a Cognitive Services-fiók létrehozásának dátumát. |
deletionDate |
string |
A törlés dátuma, csak a törölt fiókhoz érhető el. |
disableLocalAuth |
boolean |
|
dynamicThrottlingEnabled |
boolean |
A dinamikus szabályozás engedélyezéséhez használandó jelző. |
encryption |
Az erőforrás titkosítási tulajdonságai. |
|
endpoint |
string |
A létrehozott fiók végpontja. |
endpoints |
object |
|
internalId |
string |
A belső azonosító (elavult, nem használja ezt a tulajdonságot). |
isMigrated |
boolean |
Ha az erőforrást egy meglévő kulcsból migrálják. |
locations |
A Cognitive Services-fiók többrégiós beállításai. |
|
migrationToken |
string |
Erőforrás-migrálási jogkivonat. |
networkAcls |
Az adott hálózati helyekről való akadálymentességet szabályozó szabályok gyűjteménye. |
|
privateEndpointConnections |
A Cognitive Services-fiókhoz társított privát végponti kapcsolat. |
|
provisioningState |
Lekéri a Cognitive Services-fiók állapotát a művelet meghívásának időpontjában. |
|
publicNetworkAccess |
Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a fiókhoz. |
|
quotaLimit | ||
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
Az ütemezett végleges törlés dátuma, amely csak törölt fiókhoz érhető el. |
skuChangeInfo |
A termékváltozat módosítási adatai a fiókról. |
|
userOwnedStorage |
Az erőforrás tárfiókja. |
ApiProperties
A speciális API-k API-tulajdonságai.
Name | Típus | Description |
---|---|---|
aadClientId |
string |
(Csak a Metrics Advisor esetében) A Azure AD ügyfél-azonosító (alkalmazásazonosító). |
aadTenantId |
string |
(Csak a Metrics Advisor esetében) A Azure AD bérlőazonosítója. |
eventHubConnectionString |
string |
(Csak személyre szabás) A Bing Search statisztikáinak engedélyezéséhez használandó jelző. |
qnaAzureSearchEndpointId |
string |
(Csak QnAMaker esetén) A QnAMaker Azure Search-végpontazonosítója. |
qnaAzureSearchEndpointKey |
string |
(Csak QnAMaker esetén) A QnAMaker Azure Search-végpontkulcsa. |
qnaRuntimeEndpoint |
string |
(Csak QnAMaker esetén) A QnAMaker futtatókörnyezeti végpontja. |
statisticsEnabled |
boolean |
(csak Bing Search) A Bing Search statisztikáinak engedélyezésére használható jelző. |
storageAccountConnectionString |
string |
(Csak személyre szabás) A tárfiók kapcsolati karakterlánc. |
superUser |
string |
(Csak a Metrics Advisor esetében) A Metrics Advisor felügyelője. |
websiteName |
string |
(Csak a Metrics Advisor esetében) A Metrics Advisor webhelyneve. |
CallRateLimit
A hívási sebesség korlátozza a Cognitive Services-fiókot.
Name | Típus | Description |
---|---|---|
count |
number |
A hívási sebesség korlátjának számértéke. |
renewalPeriod |
number |
A megújítási időszak másodpercben a hívási sebesség korlátja után. |
rules |
CommitmentPlanAssociation
A kötelezettségvállalási terv társítása.
Name | Típus | Description |
---|---|---|
commitmentPlanId |
string |
A kötelezettségvállalási csomag Azure-erőforrás-azonosítója. |
commitmentPlanLocation |
string |
A kötelezettségvállalási terv helye. |
createdByType
Az erőforrást létrehozó identitás típusa.
Name | Típus | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Encryption
A titkosítás konfigurálásához használt tulajdonságok
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
keySource | Microsoft.KeyVault |
A keySource for Encryption lehetséges értékének számbavétele |
|
keyVaultProperties |
A KeyVault tulajdonságai |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további adattípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hiba célja. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
Identity
Az erőforrás identitása.
Name | Típus | Description |
---|---|---|
principalId |
string |
Az erőforrás-identitás fő azonosítója. |
tenantId |
string |
Az erőforrás bérlőazonosítója. |
type |
Az identitás típusa. |
|
userAssignedIdentities |
<string,
User |
Az erőforráshoz társított felhasználó által hozzárendelt identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
IpRule
Egy adott IP-cím vagy IP-címtartomány akadálymentességét szabályozó szabály.
Name | Típus | Description |
---|---|---|
value |
string |
Egy IPv4-címtartomány CIDR-jelölésben, például "124.56.78.91" (egyszerű IP-cím) vagy "124.56.78.0/24" (minden cím, amely a 124.56.78-as számmal kezdődik). |
keySource
A keySource for Encryption lehetséges értékének számbavétele
Name | Típus | Description |
---|---|---|
Microsoft.CognitiveServices |
string |
|
Microsoft.KeyVault |
string |
KeyVaultProperties
Tulajdonságok a keyVault tulajdonságainak konfigurálásához
Name | Típus | Description |
---|---|---|
identityClientId |
string |
|
keyName |
string |
A KeyVault kulcsának neve |
keyVaultUri |
string |
A KeyVault URI-ja |
keyVersion |
string |
A KeyVault kulcsának verziója |
MultiRegionSettings
A többrégiós beállítások Cognitive Services-fiók.
Name | Típus | Description |
---|---|---|
regions |
A hívási sebesség korlátozza a Cognitive Services-fiókot. |
|
routingMethod |
Többrégiós útválasztási módszerek. |
NetworkRuleAction
Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer.
Name | Típus | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleSet
A hálózati akadálymentességet szabályozó szabályok halmaza.
Name | Típus | Description |
---|---|---|
defaultAction |
Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer. |
|
ipRules |
Ip |
Az IP-címszabályok listája. |
virtualNetworkRules |
A virtuális hálózati szabályok listája. |
PrivateEndpoint
A privát végpont erőforrása.
Name | Típus | Description |
---|---|---|
id |
string |
A privát végpont ARM-azonosítója |
PrivateEndpointConnection
A privát végpont kapcsolati erőforrása.
Name | Típus | Description |
---|---|---|
etag |
string |
Erőforráscímke. |
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
A privát végponti kapcsolat helye |
name |
string |
Az erőforrás neve |
properties |
Erőforrás tulajdonságai. |
|
systemData |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
|
type |
string |
Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProperties
A PrivateEndpointConnectProperties tulajdonságai.
Name | Típus | Description |
---|---|---|
groupIds |
string[] |
A private link erőforráscsoport-azonosítói. |
privateEndpoint |
A privát végpont erőforrása. |
|
privateLinkServiceConnectionState |
A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye. |
|
provisioningState |
A privát végpont kapcsolati erőforrásának kiépítési állapota. |
PrivateEndpointConnectionProvisioningState
Az aktuális kiépítési állapot.
Name | Típus | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
A privát végpont kapcsolati állapota.
Name | Típus | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
Name | Típus | Description |
---|---|---|
actionsRequired |
string |
Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére. |
description |
string |
A kapcsolat jóváhagyásának/elutasításának oka. |
status |
Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot. |
ProvisioningState
Lekéri a Cognitive Services-fiók állapotát a művelet meghívásának időpontjában.
Name | Típus | Description |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
ResolvingDNS |
string |
|
Succeeded |
string |
PublicNetworkAccess
Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a fiókhoz.
Name | Típus | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
QuotaLimit
Name | Típus | Description |
---|---|---|
count |
number |
|
renewalPeriod |
number |
|
rules |
RegionSetting
A hívási sebesség korlátozza a Cognitive Services-fiókot.
Name | Típus | Description |
---|---|---|
customsubdomain |
string |
Leképezi a régiót a regionális egyéni altartományra. |
name |
string |
A régió neve. |
value |
number |
A prioritási vagy súlyozott útválasztási módszerek értéke. |
RequestMatchPattern
Name | Típus | Description |
---|---|---|
method |
string |
|
path |
string |
ResourceIdentityType
Az identitás típusa.
Name | Típus | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RoutingMethods
Többrégiós útválasztási módszerek.
Name | Típus | Description |
---|---|---|
Performance |
string |
|
Priority |
string |
|
Weighted |
string |
Sku
A termékváltozatot képviselő erőforrásmodell-definíció
Name | Típus | Description |
---|---|---|
capacity |
integer |
Ha a termékváltozat támogatja a fel- és leskálázást, akkor a kapacitás egészét is tartalmaznia kell. Ha az erőforráshoz nem lehet vertikális felskálázást/beskálázást végezni, ez kihagyható. |
family |
string |
Ha a szolgáltatás eltérő hardvergenerációval rendelkezik ugyanahhoz a termékváltozathoz, akkor az itt rögzíthető. |
name |
string |
A termékváltozat neve. Ex - P3. Ez általában egy betű+szám kód |
size |
string |
A termékváltozat mérete. Ha a névmező a réteg és más értékek kombinációja, ez a különálló kód. |
tier |
Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges. |
SkuCapability
A SkuCapability egy adott funkció képességeit jelzi.
Name | Típus | Description |
---|---|---|
name |
string |
A SkuCapability neve. |
value |
string |
A SkuCapability értéke. |
SkuChangeInfo
A termékváltozat módosítási adatai a fiókról.
Name | Típus | Description |
---|---|---|
countOfDowngrades |
number |
Lekéri a visszalépések számát. |
countOfUpgradesAfterDowngrades |
number |
Lekéri a visszalépések utáni frissítések számát. |
lastChangeDate |
string |
Lekéri az utolsó módosítás dátumát. |
SkuTier
Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.
Name | Típus | Description |
---|---|---|
Basic |
string |
|
Enterprise |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Name | Típus | Description |
---|---|---|
createdAt |
string |
Az erőforrás-létrehozás időbélyege (UTC). |
createdBy |
string |
Az erőforrást létrehozó identitás. |
createdByType |
Az erőforrást létrehozó identitás típusa. |
|
lastModifiedAt |
string |
Az erőforrás utolsó módosításának időbélyege (UTC) |
lastModifiedBy |
string |
Az erőforrást utoljára módosító identitás. |
lastModifiedByType |
Az erőforrást legutóbb módosító identitás típusa. |
ThrottlingRule
Name | Típus | Description |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |
UserAssignedIdentity
Felhasználó által hozzárendelt felügyelt identitás.
Name | Típus | Description |
---|---|---|
clientId |
string |
Az identitáshoz társított ügyfélalkalmazás-azonosító. |
principalId |
string |
Az identitáshoz társított Azure Active Directory-rendszerbiztonsági tag azonosítója. |
UserOwnedStorage
A cognitive services-fiók felhasználó tulajdonában lévő tárterület.
Name | Típus | Description |
---|---|---|
identityClientId |
string |
|
resourceId |
string |
Egy Microsoft.Storage-erőforrás teljes erőforrás-azonosítója. |
VirtualNetworkRule
Egy adott virtuális hálózat akadálymentességét szabályozó szabály.
Name | Típus | Description |
---|---|---|
id |
string |
Egy virtuális hálózat alhálózatának teljes erőforrás-azonosítója, például "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". |
ignoreMissingVnetServiceEndpoint |
boolean |
Hagyja figyelmen kívül a hiányzó virtuális hálózati szolgáltatásvégpontot. |
state |
string |
Lekéri a virtuális hálózati szabály állapotát. |