Accounts - Update
Uppdateringar ett Cognitive Services-konto
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2023-05-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
account
|
path | True |
string |
Namnet på Cognitive Services-kontot. Regex pattern: |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandetext
Name | Typ | Description |
---|---|---|
identity |
Identitet för resursen. |
|
kind |
string |
Resursens typ. |
location |
string |
Den geo-plats där resursen finns |
properties |
Egenskaper för Cognitive Services-konto. |
|
sku |
Resursmodelldefinitionen som representerar SKU |
|
tags |
object |
Resurstaggar. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Resursprovidern bör returnera 200 (OK) för att indikera att åtgärden har slutförts. |
|
202 Accepted |
HTTP 202 (accepterad) om åtgärden har startats och slutförs asynkront. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. Om resursgruppen eller resursen inte finns ska 404 (NotFound) returneras. |
Exempel
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"
}
}
Definitioner
Name | Description |
---|---|
Abuse |
Missbruksstraffet. |
Abuse |
Agerandet av Missbruksstraff. |
Account |
Cognitive Services-kontot är en Azure-resurs som representerar det etablerade kontot, dess typ, plats och SKU. |
Account |
Egenskaper för Cognitive Services-kontot. |
Api |
API-egenskaperna för särskilda API:er. |
Call |
Anropsfrekvensen begränsar Cognitive Services-kontot. |
Commitment |
Åtagandeplansassociationen. |
created |
Den typ av identitet som skapade resursen. |
Encryption |
Egenskaper för att konfigurera kryptering |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Identity |
Identitet för resursen. |
Ip |
En regel som styr tillgängligheten från en specifik IP-adress eller ip-adressintervall. |
key |
Räknar upp det möjliga värdet för keySource för kryptering |
Key |
Egenskaper för att konfigurera keyVault-egenskaper |
Multi |
Cognitive Services-kontot för inställningar för flera regioner. |
Network |
Standardåtgärden när ingen regel från ipRules och virtualNetworkRules matchar. Detta används endast när egenskapen bypass har utvärderats. |
Network |
En uppsättning regler som styr nätverkets tillgänglighet. |
Private |
Den privata slutpunktsresursen. |
Private |
Resursen Anslutning till privat slutpunkt. |
Private |
Egenskaper för PrivateEndpointConnectProperties. |
Private |
Det aktuella etableringstillståndet. |
Private |
Anslutningsstatus för privat slutpunkt. |
Private |
En samling med information om tillståndet för anslutningen mellan tjänstekonsumenten och leverantören. |
Provisioning |
Hämtar status för Cognitive Services-kontot när åtgärden anropades. |
Public |
Om offentlig slutpunktsåtkomst tillåts för det här kontot eller inte. |
Quota |
|
Region |
Anropsfrekvensen begränsar Cognitive Services-kontot. |
Request |
|
Resource |
Identitetstypen. |
Routing |
Routningsmetoder för flera regioner. |
Sku |
Resursmodelldefinitionen som representerar SKU |
Sku |
SkuCapability anger funktionen för en viss funktion. |
Sku |
SKU:ns ändringsinformation för kontot. |
Sku |
Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
Throttling |
|
User |
Användartilldelad hanterad identitet. |
User |
Användarägd lagring för Cognitive Services-kontot. |
Virtual |
En regel som styr tillgängligheten från ett specifikt virtuellt nätverk. |
AbusePenalty
Missbruksstraffet.
Name | Typ | Description |
---|---|---|
action |
Agerandet av Missbruksstraff. |
|
expiration |
string |
Datetime för förfallodatum för missbruksstraffet. |
rateLimitPercentage |
number |
Procentandelen av hastighetsgränsen. |
AbusePenaltyAction
Agerandet av Missbruksstraff.
Name | Typ | Description |
---|---|---|
Block |
string |
|
Throttle |
string |
Account
Cognitive Services-kontot är en Azure-resurs som representerar det etablerade kontot, dess typ, plats och SKU.
Name | Typ | Description |
---|---|---|
etag |
string |
Resurs-Etag. |
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Identitet för resursen. |
|
kind |
string |
Resursens typ. |
location |
string |
Den geo-plats där resursen finns |
name |
string |
Namnet på resursen |
properties |
Egenskaper för Cognitive Services-kontot. |
|
sku |
Resursmodelldefinitionen som representerar SKU |
|
systemData |
Metadata som rör skapande och senaste ändring av resursen. |
|
tags |
object |
Resurstaggar. |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
AccountProperties
Egenskaper för Cognitive Services-kontot.
Name | Typ | Description |
---|---|---|
abusePenalty |
Missbruksstraffet. |
|
allowedFqdnList |
string[] |
|
apiProperties |
API-egenskaperna för särskilda API:er. |
|
callRateLimit |
Anropsfrekvensen begränsar Cognitive Services-kontot. |
|
capabilities |
Hämtar funktionerna i Cognitive Services-kontot. Varje objekt anger funktionen för en specifik funktion. Värdena är skrivskyddade och endast som referens. |
|
commitmentPlanAssociations |
Åtagandeplanassociationer för Cognitive Services-kontot. |
|
customSubDomainName |
string |
Valfritt underdomännamn som används för tokenbaserad autentisering. |
dateCreated |
string |
Hämtar datumet då Cognitive Services-kontot skapades. |
deletionDate |
string |
Borttagningsdatum, endast tillgängligt för borttaget konto. |
disableLocalAuth |
boolean |
|
dynamicThrottlingEnabled |
boolean |
Flaggan för att aktivera dynamisk begränsning. |
encryption |
Krypteringsegenskaperna för den här resursen. |
|
endpoint |
string |
Slutpunkten för det skapade kontot. |
endpoints |
object |
|
internalId |
string |
Den interna identifieraren (inaktuell, använd inte den här egenskapen). |
isMigrated |
boolean |
Om resursen migreras från en befintlig nyckel. |
locations |
Inställningarna för Flera regioner för Cognitive Services-kontot. |
|
migrationToken |
string |
Resursmigreringstoken. |
networkAcls |
En samling regler som styr tillgängligheten från specifika nätverksplatser. |
|
privateEndpointConnections |
Den privata slutpunktsanslutning som är associerad med Cognitive Services-kontot. |
|
provisioningState |
Hämtar status för Cognitive Services-kontot när åtgärden anropades. |
|
publicNetworkAccess |
Om offentlig slutpunktsåtkomst tillåts för det här kontot eller inte. |
|
quotaLimit | ||
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
Det schemalagda rensningsdatumet, endast tillgängligt för borttaget konto. |
skuChangeInfo |
SKU:ns ändringsinformation för kontot. |
|
userOwnedStorage |
Lagringskontona för den här resursen. |
ApiProperties
API-egenskaperna för särskilda API:er.
Name | Typ | Description |
---|---|---|
aadClientId |
string |
(Endast Metrics Advisor) Klient-ID för Azure AD (program-ID). |
aadTenantId |
string |
(Endast Metrics Advisor) Azure AD klientorganisations-ID. |
eventHubConnectionString |
string |
(Endast anpassning) Flaggan för att aktivera statistik för Bing-sökning. |
qnaAzureSearchEndpointId |
string |
(Endast QnAMaker) Azure Search-slutpunkts-ID för QnAMaker. |
qnaAzureSearchEndpointKey |
string |
(Endast QnAMaker) Azure Search-slutpunktsnyckeln för QnAMaker. |
qnaRuntimeEndpoint |
string |
(Endast QnAMaker) Körningsslutpunkten för QnAMaker. |
statisticsEnabled |
boolean |
(endast Bing-sökning) Flaggan för att aktivera statistik för Bing-sökning. |
storageAccountConnectionString |
string |
(Endast anpassning) Lagringskontot anslutningssträng. |
superUser |
string |
(Endast Metrics Advisor) Superanvändaren av Metrics Advisor. |
websiteName |
string |
(Endast Metrics Advisor) Webbplatsnamnet för Metrics Advisor. |
CallRateLimit
Anropsfrekvensen begränsar Cognitive Services-kontot.
Name | Typ | Description |
---|---|---|
count |
number |
Antalsvärden för samtalsfrekvensgräns. |
renewalPeriod |
number |
Förnyelseperioden i sekunder av samtalsfrekvensgräns. |
rules |
CommitmentPlanAssociation
Åtagandeplansassociationen.
Name | Typ | Description |
---|---|---|
commitmentPlanId |
string |
Azure-resurs-ID för åtagandeplanen. |
commitmentPlanLocation |
string |
Platsen för åtagandeplanen. |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Encryption
Egenskaper för att konfigurera kryptering
Name | Typ | Standardvärde | Description |
---|---|---|---|
keySource | Microsoft.KeyVault |
Räknar upp det möjliga värdet för keySource för kryptering |
|
keyVaultProperties |
Egenskaper för KeyVault |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Den ytterligare informationstypen. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
Identity
Identitet för resursen.
Name | Typ | Description |
---|---|---|
principalId |
string |
Huvud-ID för resursidentitet. |
tenantId |
string |
Klientorganisations-ID för resursen. |
type |
Identitetstypen. |
|
userAssignedIdentities |
<string,
User |
Listan över användartilldelade identiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
IpRule
En regel som styr tillgängligheten från en specifik IP-adress eller ip-adressintervall.
Name | Typ | Description |
---|---|---|
value |
string |
Ett IPv4-adressintervall i CIDR-notation, till exempel "124.56.78.91" (enkel IP-adress) eller "124.56.78.0/24" (alla adresser som börjar med 124.56.78). |
keySource
Räknar upp det möjliga värdet för keySource för kryptering
Name | Typ | Description |
---|---|---|
Microsoft.CognitiveServices |
string |
|
Microsoft.KeyVault |
string |
KeyVaultProperties
Egenskaper för att konfigurera keyVault-egenskaper
Name | Typ | Description |
---|---|---|
identityClientId |
string |
|
keyName |
string |
Namnet på nyckeln från KeyVault |
keyVaultUri |
string |
Uri för KeyVault |
keyVersion |
string |
Version av nyckeln från KeyVault |
MultiRegionSettings
Cognitive Services-kontot för inställningar för flera regioner.
Name | Typ | Description |
---|---|---|
regions |
Anropsfrekvensen begränsar Cognitive Services-kontot. |
|
routingMethod |
Routningsmetoder för flera regioner. |
NetworkRuleAction
Standardåtgärden när ingen regel från ipRules och virtualNetworkRules matchar. Detta används endast när egenskapen bypass har utvärderats.
Name | Typ | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleSet
En uppsättning regler som styr nätverkets tillgänglighet.
Name | Typ | Description |
---|---|---|
defaultAction |
Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast när egenskapen bypass har utvärderats. |
|
ipRules |
Ip |
Listan över IP-adressregler. |
virtualNetworkRules |
Listan över regler för virtuella nätverk. |
PrivateEndpoint
Den privata slutpunktsresursen.
Name | Typ | Description |
---|---|---|
id |
string |
ARM-identifieraren för privat slutpunkt |
PrivateEndpointConnection
Resursen Anslutning till privat slutpunkt.
Name | Typ | Description |
---|---|---|
etag |
string |
Resurs-Etag. |
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Platsen för den privata slutpunktsanslutningen |
name |
string |
Namnet på resursen |
properties |
Resursegenskaper. |
|
systemData |
Metadata som rör skapande och senaste ändring av resursen. |
|
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProperties
Egenskaper för PrivateEndpointConnectProperties.
Name | Typ | Description |
---|---|---|
groupIds |
string[] |
Resursgrupp-ID:t för den privata länken. |
privateEndpoint |
Resursen för den privata slutpunkten. |
|
privateLinkServiceConnectionState |
En samling med information om tillståndet för anslutningen mellan tjänstekonsumenten och leverantören. |
|
provisioningState |
Etableringstillståndet för den privata slutpunktsanslutningsresursen. |
PrivateEndpointConnectionProvisioningState
Det aktuella etableringstillståndet.
Name | Typ | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
Anslutningsstatus för privat slutpunkt.
Name | Typ | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
En samling med information om tillståndet för anslutningen mellan tjänstekonsumenten och leverantören.
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten. |
description |
string |
Anledningen till godkännande/avvisande av anslutningen. |
status |
Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare. |
ProvisioningState
Hämtar status för Cognitive Services-kontot när åtgärden anropades.
Name | Typ | Description |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
ResolvingDNS |
string |
|
Succeeded |
string |
PublicNetworkAccess
Om offentlig slutpunktsåtkomst tillåts för det här kontot eller inte.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
QuotaLimit
Name | Typ | Description |
---|---|---|
count |
number |
|
renewalPeriod |
number |
|
rules |
RegionSetting
Anropsfrekvensen begränsar Cognitive Services-kontot.
Name | Typ | Description |
---|---|---|
customsubdomain |
string |
Mappar regionen till den regionala anpassade underdomänen. |
name |
string |
Namnet på regionen. |
value |
number |
Ett värde för prioritet eller viktade routningsmetoder. |
RequestMatchPattern
Name | Typ | Description |
---|---|---|
method |
string |
|
path |
string |
ResourceIdentityType
Identitetstypen.
Name | Typ | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RoutingMethods
Routningsmetoder för flera regioner.
Name | Typ | Description |
---|---|---|
Performance |
string |
|
Priority |
string |
|
Weighted |
string |
Sku
Resursmodelldefinitionen som representerar SKU
Name | Typ | Description |
---|---|---|
capacity |
integer |
Om SKU:n har stöd för utskalning/inskalning bör kapacitetsheltalet inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas. |
family |
string |
Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här. |
name |
string |
Namnet på SKU:n. Ex - P3. Det är vanligtvis en bokstav+nummerkod |
size |
string |
SKU-storleken. När namnfältet är kombinationen av nivå och något annat värde är detta den fristående koden. |
tier |
Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT. |
SkuCapability
SkuCapability anger funktionen för en viss funktion.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på SkuCapability. |
value |
string |
Värdet för SkuCapability. |
SkuChangeInfo
SKU:ns ändringsinformation för kontot.
Name | Typ | Description |
---|---|---|
countOfDowngrades |
number |
Hämtar antalet nedgraderingar. |
countOfUpgradesAfterDowngrades |
number |
Hämtar antalet uppgraderingar efter nedgraderingar. |
lastChangeDate |
string |
Hämtar senaste ändringsdatum. |
SkuTier
Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT.
Name | Typ | Description |
---|---|---|
Basic |
string |
|
Enterprise |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
ThrottlingRule
Name | Typ | Description |
---|---|---|
count |
number |
|
dynamicThrottlingEnabled |
boolean |
|
key |
string |
|
matchPatterns | ||
minCount |
number |
|
renewalPeriod |
number |
UserAssignedIdentity
Användartilldelad hanterad identitet.
Name | Typ | Description |
---|---|---|
clientId |
string |
Klientapp-ID som är associerat med den här identiteten. |
principalId |
string |
Huvud-ID för Azure Active Directory som är associerat med den här identiteten. |
UserOwnedStorage
Användarägd lagring för Cognitive Services-kontot.
Name | Typ | Description |
---|---|---|
identityClientId |
string |
|
resourceId |
string |
Fullständigt resurs-ID för en Microsoft.Storage-resurs. |
VirtualNetworkRule
En regel som styr tillgängligheten från ett specifikt virtuellt nätverk.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt resurs-ID för ett vnet-undernät, till exempel "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". |
ignoreMissingVnetServiceEndpoint |
boolean |
Ignorera den tjänstslutpunkt för virtuellt nätverk som saknas eller inte. |
state |
string |
Hämtar tillståndet för regeln för virtuellt nätverk. |