Accounts - Get
Returnerar ett Cognitive Services-konto som anges av parametrarna.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}?api-version=2024-10-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
account
|
path | True |
string minLength: 2maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ |
Namnet på Cognitive Services-kontot. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string minLength: 1 |
ID för målprenumerationen. |
api-version
|
query | True |
string minLength: 1 |
DEN API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Resursprovidern bör returnera 200 (OK) för att indikera att åtgärden har slutförts. En detaljerad förklaring av varje fält i svarstexten finns i beskrivningen av begärandetexten i avsnittet PUT-resurs. De enda GET-specifika egenskaperna är "name", "type" och "id". Fältbeskrivningstyp krävs. Sträng. API-uppsättningen för det här API-kontot. Det kan vara · ett enda API, till exempel Ansikts-API, Vision API, Speech API. en samling API:er: Face + Speech, Vision + Emotion osv. sku.name Krävs. Prisnivån/planen för det här API:et. Kan vara: F0 - Gratis B0 - Basic S0 - Standard P0 - Premium |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. Om resursen inte finns ska 404 (NotFound) returneras. |
Exempel
Get Account
Exempelbegäran
Exempelsvar
{
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount",
"name": "myAccount",
"type": "Microsoft.CognitiveServices/accounts",
"location": "westus",
"sku": {
"name": "F0"
},
"kind": "Emotion",
"tags": {
"Owner": "felixwa",
"ExpiredDate": "2017/09/01"
},
"etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"",
"properties": {
"endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
"provisioningState": "Succeeded"
}
}
Definitioner
Name | Description |
---|---|
Abuse |
Missbruksstraffet. |
Abuse |
Handling av missbruksstraff. |
Account |
Cognitive Services-kontot är en Azure-resurs som representerar det etablerade kontot, det är typ, plats och SKU. |
Account |
Egenskaper för Cognitive Services-kontot. |
Api |
API-egenskaperna för särskilda API:er. |
By |
Inställning för betrodda tjänster. |
Call |
Anropsfrekvensbegränsningen för 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 från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats. |
Network |
En uppsättning regler för nätverkstillgänglighet. |
Private |
Den privata slutpunktsresursen. |
Private |
Den privata slutpunktsanslutningsresursen. |
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änstkonsumenten 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 |
|
Rai |
Cognitive Services Rai Monitor-konfiguration. |
Region |
Anropsfrekvensbegränsningen för 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-ä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 |
Den användarägda AML-arbetsytan för Cognitive Services-kontot. |
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 |
Handling av missbruksstraff. |
|
expiration |
string (date-time) |
Datetime av förfallotid av missbrukstraffet. |
rateLimitPercentage |
number |
Procentandelen av hastighetsgränsen. |
AbusePenaltyAction
Handling av missbruksstraff.
Värde | Description |
---|---|
Block | |
Throttle |
Account
Cognitive Services-kontot är en Azure-resurs som representerar det etablerade kontot, det är typ, plats och SKU.
Name | Typ | Description |
---|---|---|
etag |
string |
Resurs-Etag. |
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Identitet för resursen. |
|
kind |
string |
Resurstypen. |
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[] |
|
amlWorkspace |
Egenskaperna för användarägda AML-arbetsytor. |
|
apiProperties |
API-egenskaperna för särskilda API:er. |
|
callRateLimit |
Anropsfrekvensbegränsningen för 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 |
Åtagandeplanens associationer 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 | ||
raiMonitorConfig |
Cognitive Services Rai Monitor-konfiguration. |
|
restore |
boolean |
|
restrictOutboundNetworkAccess |
boolean |
|
scheduledPurgeDate |
string |
Det schemalagda rensningsdatumet, endast tillgängligt för borttaget konto. |
skuChangeInfo |
SKU-ä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 maxLength: 500 |
(Endast Metrics Advisor) Azure AD-klient-ID (program-ID). |
aadTenantId |
string maxLength: 500 |
(Endast Metrics Advisor) Klient-ID:t för Azure AD. |
eventHubConnectionString |
string maxLength: 1000pattern: ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$ |
(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 maxLength: 1000pattern: ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$ |
(Endast anpassning) Anslutningssträngen för lagringskontot. |
superUser |
string maxLength: 500 |
(Endast Metrics Advisor) Superanvändaren av Metrics Advisor. |
websiteName |
string maxLength: 500 |
(Endast Metrics Advisor) Webbplatsnamnet för Metrics Advisor. |
ByPassSelection
Inställning för betrodda tjänster.
Värde | Description |
---|---|
AzureServices | |
None |
CallRateLimit
Anropsfrekvensbegränsningen för Cognitive Services-kontot.
Name | Typ | Description |
---|---|---|
count |
number |
Antalsvärden för anropsfrekvensgräns. |
renewalPeriod |
number |
Förnyelseperioden i sekunder av gränsen för samtalsfrekvens. |
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.
Värde | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
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 |
Ytterligare informationstyp. |
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 |
Resursens klientorganisations-ID. |
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 formuläret: '/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
Värde | Description |
---|---|
Microsoft.CognitiveServices | |
Microsoft.KeyVault |
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 |
Anropsfrekvensbegränsningen för Cognitive Services-kontot. |
|
routingMethod |
Routningsmetoder för flera regioner. |
NetworkRuleAction
Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats.
Värde | Description |
---|---|
Allow | |
Deny |
NetworkRuleSet
En uppsättning regler för nätverkstillgänglighet.
Name | Typ | Description |
---|---|---|
bypass |
Inställning för betrodda tjänster. |
|
defaultAction |
Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen 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
Den privata slutpunktsanslutningsresursen.
Name | Typ | Description |
---|---|---|
etag |
string |
Resurs-Etag. |
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /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[] |
Resursgrupps-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änstkonsumenten och leverantören. |
|
provisioningState |
Etableringstillståndet för den privata slutpunktsanslutningsresursen. |
PrivateEndpointConnectionProvisioningState
Det aktuella etableringstillståndet.
Värde | Description |
---|---|
Creating | |
Deleting | |
Failed | |
Succeeded |
PrivateEndpointServiceConnectionStatus
Anslutningsstatus för privat slutpunkt.
Värde | Description |
---|---|
Approved | |
Pending | |
Rejected |
PrivateLinkServiceConnectionState
En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten. |
description |
string |
Orsak 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.
Värde | Description |
---|---|
Accepted | |
Creating | |
Deleting | |
Failed | |
Moving | |
ResolvingDNS | |
Succeeded |
PublicNetworkAccess
Om offentlig slutpunktsåtkomst tillåts för det här kontot eller inte.
Värde | Description |
---|---|
Disabled | |
Enabled |
QuotaLimit
Name | Typ | Description |
---|---|---|
count |
number |
|
renewalPeriod |
number |
|
rules |
RaiMonitorConfig
Cognitive Services Rai Monitor-konfiguration.
Name | Typ | Description |
---|---|---|
adxStorageResourceId |
string |
Lagringsresurs-ID:t. |
identityClientId |
string |
Identitetsklient-ID:t för åtkomst till lagringen. |
RegionSetting
Anropsfrekvensbegränsningen för 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 prioritets- eller viktade routningsmetoder. |
RequestMatchPattern
Name | Typ | Description |
---|---|---|
method |
string |
|
path |
string |
ResourceIdentityType
Identitetstypen.
Värde | Description |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
RoutingMethods
Routningsmetoder för flera regioner.
Värde | Description |
---|---|
Performance | |
Priority | |
Weighted |
Sku
Resursmodelldefinitionen som representerar SKU
Name | Typ | Description |
---|---|---|
capacity |
integer (int32) |
Om SKU:n stöder utskalning/in bör kapacitets heltal 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-ä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.
Värde | Description |
---|---|
Basic | |
Enterprise | |
Free | |
Premium | |
Standard |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string (date-time) |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string (date-time) |
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. |
UserOwnedAmlWorkspace
Den användarägda AML-arbetsytan för Cognitive Services-kontot.
Name | Typ | Description |
---|---|---|
identityClientId |
string |
Identitetsklient-ID för en AML-arbetsyteresurs. |
resourceId |
string |
Fullständigt resurs-ID för en AML-arbetsyteresurs. |
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 att vnet-tjänstens slutpunkt saknas eller inte. |
state |
string |
Hämtar tillståndet för regeln för virtuellt nätverk. |