Delen via


Accounts - Get

Retourneert een Cognitive Services-account dat is opgegeven door de parameters.

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

URI-parameters

Name In Vereist Type Description
accountName
path True

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

De naam van het Cognitive Services-account.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

subscriptionId
path True

string

minLength: 1

De id van het doelabonnement.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

Account

De resourceprovider moet 200 (OK) retourneren om aan te geven dat de bewerking is voltooid. Raadpleeg de beschrijving van de hoofdtekst van de aanvraag in de sectie PUT-resource voor een gedetailleerde uitleg van elk veld in de antwoordtekst. De enige GET-specifieke eigenschappen zijn 'name', 'type' en 'id'. Veldbeschrijving vereist. Snaar. De API-set voor dit API-account. Het kan · één API, bijvoorbeeld: Face-API, Vision-API, Speech-API. een bundel API's: Face + Speech, Vision + Emotion, enzovoort sku.name Vereist. De prijscategorie/het abonnement van deze API. Kan zijn: F0 - Gratis B0 - Basic S0 - Standard P0 - Premium

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. Als de resource niet bestaat, moet 404 (NotFound) worden geretourneerd.

Voorbeelden

Get Account

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AbusePenalty

De misbruikstraf.

AbusePenaltyAction

De actie van AbusePenalty.

Account

Het Cognitive Services-account is een Azure-resource die het ingerichte account vertegenwoordigt, het type, de locatie en de SKU.

AccountProperties

Eigenschappen van Het Cognitive Services-account.

ApiProperties

De API-eigenschappen voor speciale API's.

ByPassSelection

Instelling voor vertrouwde services.

CallRateLimit

Het Gespreksfrequentielimiet voor het Cognitive Services-account.

CommitmentPlanAssociation

De toezeggingsplankoppeling.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Encryption

Eigenschappen voor het configureren van versleuteling

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

Identity

Identiteit voor de resource.

IpRule

Een regel voor de toegankelijkheid van een specifiek IP-adres of IP-bereik.

keySource

De mogelijke waarde van keySource voor versleuteling opsommen

KeyVaultProperties

Eigenschappen voor het configureren van keyVault-eigenschappen

MultiRegionSettings

Het Cognitive Services-account met meerdere regio's.

NetworkRuleAction

De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomt. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.

NetworkRuleSet

Een set regels voor de toegankelijkheid van het netwerk.

PrivateEndpoint

De privé-eindpuntresource.

PrivateEndpointConnection

De privé-eindpuntverbindingsresource.

PrivateEndpointConnectionProperties

Eigenschappen van de PrivateEndpointConnectProperties.

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

ProvisioningState

Hiermee wordt de status van het Cognitive Services-account opgehaald op het moment dat de bewerking werd aangeroepen.

PublicNetworkAccess

Of openbare eindpunttoegang wel of niet is toegestaan voor dit account.

QuotaLimit
RaiMonitorConfig

Configuratie van Cognitive Services Rai Monitor.

RegionSetting

Het Gespreksfrequentielimiet voor het Cognitive Services-account.

RequestMatchPattern
ResourceIdentityType

Het identiteitstype.

RoutingMethods

Routeringsmethoden voor meerdere regio's.

Sku

De definitie van het resourcemodel die de SKU vertegenwoordigt

SkuCapability

SkuCapability geeft de mogelijkheid van een bepaalde functie aan.

SkuChangeInfo

SKU-wijzigingsgegevens van account.

SkuTier

Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

ThrottlingRule
UserAssignedIdentity

Door de gebruiker toegewezen beheerde identiteit.

UserOwnedAmlWorkspace

De AML-werkruimte van de gebruiker voor het Cognitive Services-account.

UserOwnedStorage

De opslag die eigendom is van de gebruiker voor het Cognitive Services-account.

VirtualNetworkRule

Een regel voor de toegankelijkheid van een specifiek virtueel netwerk.

AbusePenalty

De misbruikstraf.

Name Type Description
action

AbusePenaltyAction

De actie van AbusePenalty.

expiration

string (date-time)

De datum/tijd waarop de AbusePenalty verloopt.

rateLimitPercentage

number

Het percentage van de frequentielimiet.

AbusePenaltyAction

De actie van AbusePenalty.

Waarde Description
Block
Throttle

Account

Het Cognitive Services-account is een Azure-resource die het ingerichte account vertegenwoordigt, het type, de locatie en de SKU.

Name Type Description
etag

string

Resource-Etag.

id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identiteit voor de resource.

kind

string

Het type resource.

location

string

De geografische locatie waar de resource zich bevindt

name

string

De naam van de resource

properties

AccountProperties

Eigenschappen van Het Cognitive Services-account.

sku

Sku

De definitie van het resourcemodel die de SKU vertegenwoordigt

systemData

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

tags

object

Resourcetags.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

AccountProperties

Eigenschappen van Het Cognitive Services-account.

Name Type Description
abusePenalty

AbusePenalty

De misbruikstraf.

allowedFqdnList

string[]

amlWorkspace

UserOwnedAmlWorkspace

De eigenschappen van de AML-werkruimte van de gebruiker.

apiProperties

ApiProperties

De API-eigenschappen voor speciale API's.

callRateLimit

CallRateLimit

Het Gespreksfrequentielimiet voor het Cognitive Services-account.

capabilities

SkuCapability[]

Hiermee haalt u de mogelijkheden van het Cognitive Services-account op. Elk item geeft de mogelijkheid van een specifieke functie aan. De waarden zijn alleen-lezen en alleen ter referentie.

commitmentPlanAssociations

CommitmentPlanAssociation[]

De toezeggingsplankoppelingen van het Cognitive Services-account.

customSubDomainName

string

Optionele subdomeinnaam die wordt gebruikt voor verificatie op basis van tokens.

dateCreated

string

Hiermee haalt u de datum op waarop het Cognitive Services-account is gemaakt.

deletionDate

string

De verwijderingsdatum, alleen beschikbaar voor verwijderd account.

disableLocalAuth

boolean

dynamicThrottlingEnabled

boolean

De vlag om dynamische beperking in te schakelen.

encryption

Encryption

De versleutelingseigenschappen voor deze resource.

endpoint

string

Eindpunt van het gemaakte account.

endpoints

object

internalId

string

De interne id (afgeschaft, gebruik deze eigenschap niet).

isMigrated

boolean

Als de resource wordt gemigreerd vanaf een bestaande sleutel.

locations

MultiRegionSettings

De instellingen voor meerdere regio's van het Cognitive Services-account.

migrationToken

string

Token voor resourcemigratie.

networkAcls

NetworkRuleSet

Een verzameling regels voor de toegankelijkheid van specifieke netwerklocaties.

privateEndpointConnections

PrivateEndpointConnection[]

De privé-eindpuntverbinding die is gekoppeld aan het Cognitive Services-account.

provisioningState

ProvisioningState

Hiermee wordt de status van het Cognitive Services-account opgehaald op het moment dat de bewerking werd aangeroepen.

publicNetworkAccess

PublicNetworkAccess

Of openbare eindpunttoegang wel of niet is toegestaan voor dit account.

quotaLimit

QuotaLimit

raiMonitorConfig

RaiMonitorConfig

Configuratie van Cognitive Services Rai Monitor.

restore

boolean

restrictOutboundNetworkAccess

boolean

scheduledPurgeDate

string

De geplande opschoondatum, alleen beschikbaar voor een verwijderd account.

skuChangeInfo

SkuChangeInfo

SKU-wijzigingsgegevens van account.

userOwnedStorage

UserOwnedStorage[]

De opslagaccounts voor deze resource.

ApiProperties

De API-eigenschappen voor speciale API's.

Name Type Description
aadClientId

string

maxLength: 500

(Alleen Metrics Advisor) De Azure AD-client-id (toepassings-id).

aadTenantId

string

maxLength: 500

(Alleen Metrics Advisor) De Azure AD-tenant-id.

eventHubConnectionString

string

maxLength: 1000
pattern: ^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$

(Alleen persoonlijke instellingen) De vlag om statistieken van Bing Search in te schakelen.

qnaAzureSearchEndpointId

string

(Alleen QnAMaker) De Azure Search-eindpunt-id van QnAMaker.

qnaAzureSearchEndpointKey

string

(Alleen QnAMaker) De Azure Search-eindpuntsleutel van QnAMaker.

qnaRuntimeEndpoint

string

(Alleen QnAMaker) Het runtime-eindpunt van QnAMaker.

statisticsEnabled

boolean

(Alleen Bing Zoeken) De vlag om statistieken van Bing Search in te schakelen.

storageAccountConnectionString

string

maxLength: 1000
pattern: ^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$

(Alleen persoonlijke instellingen) De verbindingsreeks voor het opslagaccount.

superUser

string

maxLength: 500

(Alleen Metrics Advisor) De supergebruiker van Metrics Advisor.

websiteName

string

maxLength: 500

(Alleen Metrics Advisor) De websitenaam van Metrics Advisor.

ByPassSelection

Instelling voor vertrouwde services.

Waarde Description
AzureServices
None

CallRateLimit

Het Gespreksfrequentielimiet voor het Cognitive Services-account.

Name Type Description
count

number

De tellingswaarde van de gespreksfrequentielimiet.

renewalPeriod

number

De verlengingsperiode in seconden van de oproepsnelheidslimiet.

rules

ThrottlingRule[]

CommitmentPlanAssociation

De toezeggingsplankoppeling.

Name Type Description
commitmentPlanId

string

De Azure-resource-id van het toezeggingsplan.

commitmentPlanLocation

string

De locatie van het toezeggingsplan.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
Application
Key
ManagedIdentity
User

Encryption

Eigenschappen voor het configureren van versleuteling

Name Type Default value Description
keySource

keySource

Microsoft.KeyVault

De mogelijke waarde van keySource voor versleuteling opsommen

keyVaultProperties

KeyVaultProperties

Eigenschappen van KeyVault

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

Identity

Identiteit voor de resource.

Name Type Description
principalId

string

De principal-id van de resource-id.

tenantId

string

De tenant-id van de resource.

type

ResourceIdentityType

Het identiteitstype.

userAssignedIdentities

<string,  UserAssignedIdentity>

De lijst met door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De referenties voor de woordenlijst van de gebruikersidentiteit zijn ARM-resource-id's in de vorm: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Een regel voor de toegankelijkheid van een specifiek IP-adres of IP-bereik.

Name Type Description
value

string

Een IPv4-adresbereik in CIDR-notatie, zoals '124.56.78.91' (eenvoudig IP-adres) of '124.56.78.0/24' (alle adressen die beginnen met 124.56.78).

keySource

De mogelijke waarde van keySource voor versleuteling opsommen

Waarde Description
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Eigenschappen voor het configureren van keyVault-eigenschappen

Name Type Description
identityClientId

string

keyName

string

Naam van de sleutel uit KeyVault

keyVaultUri

string

URI van KeyVault

keyVersion

string

Versie van de sleutel van KeyVault

MultiRegionSettings

Het Cognitive Services-account met meerdere regio's.

Name Type Description
regions

RegionSetting[]

Het Gespreksfrequentielimiet voor het Cognitive Services-account.

routingMethod

RoutingMethods

Routeringsmethoden voor meerdere regio's.

NetworkRuleAction

De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomt. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.

Waarde Description
Allow
Deny

NetworkRuleSet

Een set regels voor de toegankelijkheid van het netwerk.

Name Type Description
bypass

ByPassSelection

Instelling voor vertrouwde services.

defaultAction

NetworkRuleAction

De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomt. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.

ipRules

IpRule[]

De lijst met IP-adresregels.

virtualNetworkRules

VirtualNetworkRule[]

De lijst met regels voor virtuele netwerken.

PrivateEndpoint

De privé-eindpuntresource.

Name Type Description
id

string

De ARM-id voor privé-eindpunt

PrivateEndpointConnection

De privé-eindpuntverbindingsresource.

Name Type Description
etag

string

Resource-Etag.

id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

De locatie van de privé-eindpuntverbinding

name

string

De naam van de resource

properties

PrivateEndpointConnectionProperties

Resource-eigenschappen.

systemData

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProperties

Eigenschappen van de PrivateEndpointConnectProperties.

Name Type Description
groupIds

string[]

De resourcegroep-id's van de private link.

privateEndpoint

PrivateEndpoint

De resource van het privé-eindpunt.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

provisioningState

PrivateEndpointConnectionProvisioningState

De inrichtingsstatus van de privé-eindpuntverbindingsresource.

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

Waarde Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Waarde Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

Name Type Description
actionsRequired

string

Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.

description

string

De reden voor goedkeuring/afwijzing van de verbinding.

status

PrivateEndpointServiceConnectionStatus

Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

ProvisioningState

Hiermee wordt de status van het Cognitive Services-account opgehaald op het moment dat de bewerking werd aangeroepen.

Waarde Description
Accepted
Creating
Deleting
Failed
Moving
ResolvingDNS
Succeeded

PublicNetworkAccess

Of openbare eindpunttoegang wel of niet is toegestaan voor dit account.

Waarde Description
Disabled
Enabled

QuotaLimit

Name Type Description
count

number

renewalPeriod

number

rules

ThrottlingRule[]

RaiMonitorConfig

Configuratie van Cognitive Services Rai Monitor.

Name Type Description
adxStorageResourceId

string

De opslagresource-id.

identityClientId

string

De id van de identiteitsclient voor toegang tot de opslag.

RegionSetting

Het Gespreksfrequentielimiet voor het Cognitive Services-account.

Name Type Description
customsubdomain

string

Hiermee wordt de regio toegewezen aan het regionale aangepaste subdomein.

name

string

Naam van de regio.

value

number

Een waarde voor prioriteits- of gewogen routeringsmethoden.

RequestMatchPattern

Name Type Description
method

string

path

string

ResourceIdentityType

Het identiteitstype.

Waarde Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RoutingMethods

Routeringsmethoden voor meerdere regio's.

Waarde Description
Performance
Priority
Weighted

Sku

De definitie van het resourcemodel die de SKU vertegenwoordigt

Name Type Description
capacity

integer (int32)

Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, kan dit worden weggelaten.

family

string

Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd.

name

string

De naam van de SKU. Ex - P3. Dit is meestal een letter+cijfercode

size

string

De SKU-grootte. Wanneer het naamveld de combinatie van de laag en een andere waarde is, is dit de zelfstandige code.

tier

SkuTier

Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

SkuCapability

SkuCapability geeft de mogelijkheid van een bepaalde functie aan.

Name Type Description
name

string

De naam van de SKUCapability.

value

string

De waarde van de SKUCapability.

SkuChangeInfo

SKU-wijzigingsgegevens van account.

Name Type Description
countOfDowngrades

number

Hiermee haalt u het aantal downgrades op.

countOfUpgradesAfterDowngrades

number

Hiermee haalt u het aantal upgrades na downgrades op.

lastChangeDate

string

Hiermee haalt u de laatste wijzigingsdatum op.

SkuTier

Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

Waarde Description
Basic
Enterprise
Free
Premium
Standard

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

ThrottlingRule

Name Type Description
count

number

dynamicThrottlingEnabled

boolean

key

string

matchPatterns

RequestMatchPattern[]

minCount

number

renewalPeriod

number

UserAssignedIdentity

Door de gebruiker toegewezen beheerde identiteit.

Name Type Description
clientId

string

Client-app-id die is gekoppeld aan deze identiteit.

principalId

string

De principal-id van Azure Active Directory die is gekoppeld aan deze identiteit.

UserOwnedAmlWorkspace

De AML-werkruimte van de gebruiker voor het Cognitive Services-account.

Name Type Description
identityClientId

string

Id van de id van een AML-werkruimteresource.

resourceId

string

Volledige resource-id van een AML-werkruimteresource.

UserOwnedStorage

De opslag die eigendom is van de gebruiker voor het Cognitive Services-account.

Name Type Description
identityClientId

string

resourceId

string

Volledige resource-id van een Microsoft.Storage-resource.

VirtualNetworkRule

Een regel voor de toegankelijkheid van een specifiek virtueel netwerk.

Name Type Description
id

string

Volledige resource-id van een vnet-subnet, zoals '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.

ignoreMissingVnetServiceEndpoint

boolean

Ontbrekend vnet-service-eindpunt negeren of niet.

state

string

Hiermee haalt u de status van de regel voor het virtuele netwerk op.