Sdílet prostřednictvím


Accounts - Get

Vrátí účet služeb Cognitive Services určený parametry.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
accountName
path True

string

Název účtu služeb Cognitive Services.

Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

Account

Poskytovatel prostředků by měl vrátit hodnotu 200 (OK), která označuje, že se operace úspěšně dokončila. Podrobné vysvětlení jednotlivých polí v textu odpovědi najdete v popisu textu požadavku v části prostředku PUT. Jediné vlastnosti specifické pro get jsou "name", "type" a "id". Vyžaduje se druh popisu pole. Řetězec. Nastavení rozhraní API pro tento účet rozhraní API Může to být · jedno rozhraní API, například: rozhraní API pro rozpoznávání tváře, rozhraní API pro zpracování obrazu, rozhraní API pro rozpoznávání řeči. sada rozhraní API: Tvář + řeč, Zrak + emoce atd. sku.name Povinné. Cenová úroveň nebo plán tohoto rozhraní API Může být: F0 - Free B0 - Basic S0 - Standard P0 - Premium

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala. Pokud prostředek neexistuje, měl by se vrátit kód 404 (Nenalezeno).

Příklady

Get Account

Ukázkový požadavek

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount?api-version=2023-05-01

Ukázková odpověď

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

Definice

Name Description
AbusePenalty

Trest za nevhodné chování.

AbusePenaltyAction

Akce AbusePenalty.

Account

Účet služeb Cognitive Services je prostředek Azure představující zřízený účet, jeho typ, umístění a skladovou položku.

AccountProperties

Vlastnosti účtu služeb Cognitive Services.

ApiProperties

Vlastnosti rozhraní API pro speciální rozhraní API.

CallRateLimit

Limit četnosti volání účtu služeb Cognitive Services.

CommitmentPlanAssociation

Přidružení plánu závazku.

createdByType

Typ identity, která vytvořila prostředek.

Encryption

Vlastnosti pro konfiguraci šifrování

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Odpověď na chybu

Identity

Identita prostředku.

IpRule

Pravidlo, které řídí přístupnost z konkrétní IP adresy nebo rozsahu IP adres.

keySource

Vytvoří výčet možné hodnoty keySource pro šifrování.

KeyVaultProperties

Vlastnosti pro konfiguraci vlastností služby keyVault

MultiRegionSettings

Nastavení účtu služeb Cognitive Services ve více oblastech.

NetworkRuleAction

Výchozí akce, když se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Použije se až po vyhodnocení vlastnosti bypass.

NetworkRuleSet

Sada pravidel, která řídí přístupnost sítě.

PrivateEndpoint

Prostředek privátního koncového bodu.

PrivateEndpointConnection

Prostředek připojení privátního koncového bodu.

PrivateEndpointConnectionProperties

Vlastnosti PrivateEndpointConnectProperties.

PrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.

ProvisioningState

Získá stav účtu služeb Cognitive Services v době, kdy byla operace volána.

PublicNetworkAccess

Určuje, jestli je pro tento účet povolený přístup z veřejného koncového bodu.

QuotaLimit
RegionSetting

Limit četnosti volání účtu služeb Cognitive Services.

RequestMatchPattern
ResourceIdentityType

Typ identity.

RoutingMethods

Metody směrování ve více oblastech.

Sku

Definice modelu prostředků představující skladovou položku

SkuCapability

SkuCapability označuje schopnost určité funkce.

SkuChangeInfo

Informace o změně skladové položky účtu

SkuTier

Toto pole musí poskytovatel prostředků implementovat, pokud má služba více než jednu úroveň, ale není vyžadováno u PUT.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

ThrottlingRule
UserAssignedIdentity

Spravovaná identita přiřazená uživatelem.

UserOwnedStorage

Úložiště vlastněné uživatelem pro účet služeb Cognitive Services.

VirtualNetworkRule

Pravidlo, které řídí přístupnost z konkrétní virtuální sítě.

AbusePenalty

Trest za nevhodné chování.

Name Typ Description
action

AbusePenaltyAction

Akce AbusePenalty.

expiration

string

Datum a čas vypršení platnosti AbusePenalty.

rateLimitPercentage

number

Procento limitu přenosové rychlosti.

AbusePenaltyAction

Akce AbusePenalty.

Name Typ Description
Block

string

Throttle

string

Account

Účet služeb Cognitive Services je prostředek Azure představující zřízený účet, jeho typ, umístění a skladovou položku.

Name Typ Description
etag

string

Značka prostředku Etag.

id

string

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identita prostředku.

kind

string

Druh prostředku.

location

string

Geografické umístění, ve kterém se nachází prostředek

name

string

Název prostředku

properties

AccountProperties

Vlastnosti účtu služeb Cognitive Services.

sku

Sku

Definice modelu prostředků představující skladovou položku

systemData

systemData

Metadata týkající se vytvoření a poslední změny prostředku

tags

object

Značky prostředků.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

AccountProperties

Vlastnosti účtu služeb Cognitive Services.

Name Typ Description
abusePenalty

AbusePenalty

Trest za zneužití.

allowedFqdnList

string[]

apiProperties

ApiProperties

Vlastnosti rozhraní API pro speciální rozhraní API

callRateLimit

CallRateLimit

Limit četnosti volání účtu služeb Cognitive Services.

capabilities

SkuCapability[]

Získá možnosti účtu služeb Cognitive Services. Každá položka označuje schopnosti konkrétní funkce. Hodnoty jsou jen pro čtení a pouze pro referenci.

commitmentPlanAssociations

CommitmentPlanAssociation[]

Přidružení plánu závazku účtu služeb Cognitive Services.

customSubDomainName

string

Volitelný název subdomény, který se používá pro ověřování na základě tokenů.

dateCreated

string

Získá datum vytvoření účtu služeb Cognitive Services.

deletionDate

string

Datum odstranění, které je k dispozici pouze pro odstraněný účet.

disableLocalAuth

boolean

dynamicThrottlingEnabled

boolean

Příznak pro povolení dynamického omezování.

encryption

Encryption

Vlastnosti šifrování pro tento prostředek.

endpoint

string

Koncový bod vytvořeného účtu.

endpoints

object

internalId

string

Interní identifikátor (zastaralý, tuto vlastnost nepoužívejte).

isMigrated

boolean

Pokud se prostředek migruje z existujícího klíče.

locations

MultiRegionSettings

Nastavení účtu služeb Cognitive Services ve více oblastech.

migrationToken

string

Token migrace prostředků.

networkAcls

NetworkRuleSet

Kolekce pravidel, která řídí přístupnost z konkrétních síťových umístění.

privateEndpointConnections

PrivateEndpointConnection[]

Připojení privátního koncového bodu přidruženého k účtu služeb Cognitive Services.

provisioningState

ProvisioningState

Získá stav účtu služeb Cognitive Services v době, kdy byla operace volána.

publicNetworkAccess

PublicNetworkAccess

Určuje, jestli je pro tento účet povolený přístup k veřejnému koncovému bodu.

quotaLimit

QuotaLimit

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

Plánované datum vymazání, které je k dispozici pouze pro odstraněný účet.

skuChangeInfo

SkuChangeInfo

Informace o změně skladové položky účtu

userOwnedStorage

UserOwnedStorage[]

Účty úložiště pro tento prostředek.

ApiProperties

Vlastnosti rozhraní API pro speciální rozhraní API.

Name Typ Description
aadClientId

string

(Pouze Poradce pro metriky) ID klienta Azure AD (ID aplikace).

aadTenantId

string

(Pouze Poradce pro metriky) ID tenanta Azure AD.

eventHubConnectionString

string

(Pouze přizpůsobení) Příznak pro povolení statistiky Vyhledávání Bingu.

qnaAzureSearchEndpointId

string

(Pouze QnAMaker) ID koncového bodu služby QnAMaker ve službě Azure Search.

qnaAzureSearchEndpointKey

string

(Pouze QnAMaker) Klíč koncového bodu služby QnAMaker služby Azure Search.

qnaRuntimeEndpoint

string

(Pouze QnAMaker) Koncový bod modulu runtime nástroje QnAMaker.

statisticsEnabled

boolean

(Pouze Vyhledávání Bingu) Příznak pro povolení statistiky Vyhledávání Bingu.

storageAccountConnectionString

string

(Pouze přizpůsobení) Účet úložiště připojovací řetězec.

superUser

string

(Pouze Poradce pro metriky) Superuživatel služby Metrics Advisor.

websiteName

string

(Pouze Poradce pro metriky) Název webu Poradce pro metriky.

CallRateLimit

Limit četnosti volání účtu služeb Cognitive Services.

Name Typ Description
count

number

Hodnota počtu v limitu četnosti volání.

renewalPeriod

number

Doba prodlužování platnosti limitu četnosti volání v sekundách.

rules

ThrottlingRule[]

CommitmentPlanAssociation

Přidružení plánu závazku.

Name Typ Description
commitmentPlanId

string

ID prostředku Azure plánu závazku.

commitmentPlanLocation

string

Umístění plánu závazku.

createdByType

Typ identity, která vytvořila prostředek.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

Encryption

Vlastnosti pro konfiguraci šifrování

Name Typ Default value Description
keySource

keySource

Microsoft.KeyVault

Vytvoří výčet možné hodnoty keySource pro šifrování.

keyVaultProperties

KeyVaultProperties

Vlastnosti služby KeyVault

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Typ další informace.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Odpověď na chybu

Name Typ Description
error

ErrorDetail

Objekt chyby.

Identity

Identita prostředku.

Name Typ Description
principalId

string

ID objektu zabezpečení identity prostředku.

tenantId

string

ID tenanta prostředku.

type

ResourceIdentityType

Typ identity.

userAssignedIdentities

<string,  UserAssignedIdentity>

Seznam identit přiřazených uživatelem přidružených k prostředku Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Pravidlo, které řídí přístupnost z konkrétní IP adresy nebo rozsahu IP adres.

Name Typ Description
value

string

Rozsah adres IPv4 v zápisu CIDR, například "124.56.78.91" (jednoduchá IP adresa) nebo "124.56.78.0/24" (všechny adresy, které začínají 124.56.78).

keySource

Vytvoří výčet možné hodnoty keySource pro šifrování.

Name Typ Description
Microsoft.CognitiveServices

string

Microsoft.KeyVault

string

KeyVaultProperties

Vlastnosti pro konfiguraci vlastností služby keyVault

Name Typ Description
identityClientId

string

keyName

string

Název klíče ze služby Key Vault

keyVaultUri

string

Identifikátor URI služby KeyVault

keyVersion

string

Verze klíče ze služby KeyVault

MultiRegionSettings

Nastavení účtu služeb Cognitive Services ve více oblastech.

Name Typ Description
regions

RegionSetting[]

Limit četnosti volání účtu služeb Cognitive Services.

routingMethod

RoutingMethods

Metody směrování ve více oblastech.

NetworkRuleAction

Výchozí akce, když se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Použije se až po vyhodnocení vlastnosti bypass.

Name Typ Description
Allow

string

Deny

string

NetworkRuleSet

Sada pravidel, která řídí přístupnost sítě.

Name Typ Description
defaultAction

NetworkRuleAction

Výchozí akce, pokud se žádné pravidlo z ipRules a z virtualNetworkRules neshoduje. Použije se pouze po vyhodnocení vlastnosti bypass.

ipRules

IpRule[]

Seznam pravidel IP adres.

virtualNetworkRules

VirtualNetworkRule[]

Seznam pravidel virtuální sítě.

PrivateEndpoint

Prostředek privátního koncového bodu.

Name Typ Description
id

string

Identifikátor ARM pro privátní koncový bod

PrivateEndpointConnection

Prostředek připojení privátního koncového bodu.

Name Typ Description
etag

string

Značka prostředku Etag.

id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}

location

string

Umístění připojení privátního koncového bodu

name

string

Název prostředku

properties

PrivateEndpointConnectionProperties

Vlastnosti prostředku.

systemData

systemData

Metadata týkající se vytvoření a poslední změny prostředku

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointConnectionProperties

Vlastnosti PrivateEndpointConnectProperties.

Name Typ Description
groupIds

string[]

ID skupin prostředků privátního propojení

privateEndpoint

PrivateEndpoint

Prostředek privátního koncového bodu.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.

provisioningState

PrivateEndpointConnectionProvisioningState

Stav zřizování prostředku připojení privátního koncového bodu.

PrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.

Name Typ Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

Name Typ Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.

Name Typ Description
actionsRequired

string

Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.

description

string

Důvod schválení nebo zamítnutí připojení.

status

PrivateEndpointServiceConnectionStatus

Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

ProvisioningState

Získá stav účtu služeb Cognitive Services v době, kdy byla operace volána.

Name Typ Description
Accepted

string

Creating

string

Deleting

string

Failed

string

Moving

string

ResolvingDNS

string

Succeeded

string

PublicNetworkAccess

Určuje, jestli je pro tento účet povolený přístup z veřejného koncového bodu.

Name Typ Description
Disabled

string

Enabled

string

QuotaLimit

Name Typ Description
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RegionSetting

Limit četnosti volání účtu služeb Cognitive Services.

Name Typ Description
customsubdomain

string

Mapuje oblast na vlastní subdoménu oblasti.

name

string

Název oblasti.

value

number

Hodnota pro metody směrování s prioritou nebo váženou hodnotou.

RequestMatchPattern

Name Typ Description
method

string

path

string

ResourceIdentityType

Typ identity.

Name Typ Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RoutingMethods

Metody směrování ve více oblastech.

Name Typ Description
Performance

string

Priority

string

Weighted

string

Sku

Definice modelu prostředků představující skladovou položku

Name Typ Description
capacity

integer

Pokud skladová položka podporuje horizontální navýšení/snížení kapacity, mělo by být zahrnuto celé číslo kapacity. Pokud u prostředku není možné provést horizontální navýšení nebo snížení kapacity, může být vynecháno.

family

string

Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete to tady zaznamenat.

name

string

Název skladové položky. Příklad – P3. Obvykle se jedná o písmeno+číselný kód.

size

string

Velikost skladové položky Pokud je pole název kombinací vrstvy a nějaké jiné hodnoty, bude to samostatný kód.

tier

SkuTier

Toto pole musí poskytovatel prostředků implementovat, pokud má služba více než jednu úroveň, ale není vyžadováno u PUT.

SkuCapability

SkuCapability označuje schopnost určité funkce.

Name Typ Description
name

string

Název SkuCapability.

value

string

Hodnota SkuCapability.

SkuChangeInfo

Informace o změně skladové položky účtu

Name Typ Description
countOfDowngrades

number

Získá počet downgradů.

countOfUpgradesAfterDowngrades

number

Získá počet upgradů po downgradu.

lastChangeDate

string

Získá datum poslední změny.

SkuTier

Toto pole musí poskytovatel prostředků implementovat, pokud má služba více než jednu úroveň, ale není vyžadováno u PUT.

Name Typ Description
Basic

string

Enterprise

string

Free

string

Premium

string

Standard

string

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která vytvořila prostředek.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

ThrottlingRule

Name Typ Description
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number

UserAssignedIdentity

Spravovaná identita přiřazená uživatelem.

Name Typ Description
clientId

string

ID klientské aplikace přidružené k této identitě

principalId

string

ID objektu zabezpečení Azure Active Directory přidružené k této identitě.

UserOwnedStorage

Úložiště vlastněné uživatelem pro účet služeb Cognitive Services.

Name Typ Description
identityClientId

string

resourceId

string

Úplné ID prostředku Microsoft.Storage.

VirtualNetworkRule

Pravidlo, které řídí přístupnost z konkrétní virtuální sítě.

Name Typ Description
id

string

Úplné ID prostředku podsítě virtuální sítě, například /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1.

ignoreMissingVnetServiceEndpoint

boolean

Chybějící koncový bod služby virtuální sítě můžete ignorovat nebo ne.

state

string

Získá stav pravidla virtuální sítě.