Accounts - List

Gibt alle Ressourcen eines bestimmten Typs zurück, der zu einem Abonnement gehört.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts?api-version=2021-04-30

URI-Parameter

Name In Required Type Description
subscriptionId
path True
  • string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True
  • string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Type Description
200 OK

Der Ressourcenanbieter sollte 200 (OK) zurückgeben, um anzugeben, dass der Vorgang erfolgreich abgeschlossen wurde. Verwenden Sie für andere Fehler (z. B. interne Fehler) den entsprechenden HTTP-Fehlercode. Im Feld nextLink wird erwartet, dass es auf die URL verweist, die der Client zum Abrufen der nächsten Seite (pro serverseitigem Paging) verwenden soll. Dies entspricht den OData-Richtlinien für seitenseitige Antworten. Wenn ein Ressourcenanbieter das Paging nicht unterstützt, sollte er denselben Text zurückgeben, aber nextLink aus Gründen der zukünftigen Kompatibilität leer lassen. Eine ausführliche Erläuterung der einzelnen Felder im Antworttext finden Sie in der Beschreibung des Anforderungstexts im Abschnitt PUT-Ressource.

Other Status Codes

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist

Beispiele

List Accounts by Subscription

Sample Request

GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.CognitiveServices/accounts?api-version=2021-04-30

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch",
      "name": "bingSearch",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "global",
      "sku": {
        "name": "S1"
      },
      "kind": "Bing.Search",
      "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"",
      "properties": {
        "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd",
      "name": "CrisProd",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "CRIS",
      "tags": {
        "can't delete it successfully": "v-yunjin"
      },
      "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308",
      "name": "rayrptest0308",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "Face",
      "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02",
      "name": "raytest02",
      "type": "Microsoft.CognitiveServices/accounts",
      "location": "westus",
      "sku": {
        "name": "S0"
      },
      "kind": "Emotion",
      "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"",
      "properties": {
        "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitionen

Account

Cognitive Services Konto ist eine Azure-Ressource, die das bereitgestellte Konto darstellt: Typ, Standort und SKU.

AccountListResult

Die Liste der Cognitive Services-Kontovorgangsantworten.

AccountProperties

Eigenschaften Cognitive Services Kontos.

ApiProperties

Die API-Eigenschaften für spezielle APIs.

CallRateLimit

Das Aufrufratenlimit Cognitive Services Kontos.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Encryption

Eigenschaften zum Konfigurieren der Verschlüsselung

ErrorAdditionalInfo

Zusätzliche Informationen zu Ressourcenverwaltungsfehlern.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

Identity

Identität für die Ressource.

IpRule

Eine Regel, die den Zugriff von einer bestimmten IP-Adresse oder einem bestimmten IP-Adressbereich aus regeln soll.

keySource

Aufzählen des möglichen Werts von keySource für die Verschlüsselung

KeyVaultProperties

Eigenschaften zum Konfigurieren von KeyVault-Eigenschaften

NetworkRuleAction

Die Standardaktion, wenn keine Regel von ipRules und von virtualNetworkRules übereinstimmen. Dies wird nur verwendet, nachdem die Bypass-Eigenschaft ausgewertet wurde.

NetworkRuleSet

Eine Reihe von Regeln, die den Netzwerkzugriff regeln.

PrivateEndpoint

Die Ressource des privaten Endpunkts.

PrivateEndpointConnection

Die Private Endpoint Connection-Ressource.

PrivateEndpointConnectionProperties

Eigenschaften von PrivateEndpointConnectProperties.

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

PrivateEndpointServiceConnectionStatus

Der Verbindungsstatus des privaten Endpunkts.

PrivateLinkServiceConnectionState

Eine Auflistung von Informationen über den Zustand der Verbindung zwischen dem Dienstanbieter und dem Consumer.

ProvisioningState

Ruft den Status des Cognitive Services-Kontos zum Zeitpunkt des Aufrufs des Vorgangs ab.

PublicNetworkAccess

Gibt an, ob der Zugriff auf öffentliche Endpunkte für dieses Konto zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss "Enabled" oder "Disabled" sein.

QuotaLimit
RequestMatchPattern
ResourceIdentityType

Der Identitätstyp.

Sku

Die Ressourcenmodelldefinition, die die SKU darstellt

SkuCapability

SkuCapability gibt die Funktion eines bestimmten Features an.

SkuChangeInfo

SKU-Änderungsinformationen des Kontos.

SkuTier

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehr als eine Ebene verfügt, aber für einen PUT nicht erforderlich ist.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

ThrottlingRule
UserAssignedIdentity

Vom Benutzer zugewiesene verwaltete Identität.

UserOwnedStorage

Der benutzereigene Speicher für Cognitive Services Konto.

VirtualNetworkRule

Eine Regel, die den Zugriff von einem bestimmten virtuellen Netzwerk aus regeln soll.

Account

Cognitive Services Konto ist eine Azure-Ressource, die das bereitgestellte Konto darstellt: Typ, Standort und SKU.

Name Type Description
etag
  • string

Ressourcen-ETag.

id
  • string

Vollqualifizierte Ressourcen-ID für die Ressource. z.B. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identität für die Ressource.

kind
  • string

Die Art der Ressource.

location
  • string

Der geografische Standort, an dem sich die Ressource befindet

name
  • string

Der Name der Ressource

properties

Eigenschaften Cognitive Services Kontos.

sku

Die Ressourcenmodelldefinition, die die SKU darstellt

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

tags
  • object

Ressourcentags.

type
  • string

Der Typ der Ressource. Beispiel: "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AccountListResult

Die Liste der Cognitive Services-Kontovorgangsantworten.

Name Type Description
nextLink
  • string

Der Link, über den die nächste Seite der Konten angezeigt wird.

value

Ruft die Liste der Cognitive Services Konten und deren Eigenschaften ab.

AccountProperties

Eigenschaften Cognitive Services Kontos.

Name Type Description
allowedFqdnList
  • string[]
apiProperties

Die API-Eigenschaften für spezielle APIs.

callRateLimit

Das Aufrufratenlimit Cognitive Services Kontos.

capabilities

Ruft die Funktionen des Cognitive Services-Kontos ab. Jedes Element gibt die Funktion eines bestimmten Features an. Die Werte sind schreibgeschützt und dienen nur als Referenz.

customSubDomainName
  • string

Optionaler Unterdomänenname, der für die tokenbasierte Authentifizierung verwendet wird.

dateCreated
  • string

Ruft das Datum der Erstellung des Cognitive Services-Kontos ab.

disableLocalAuth
  • boolean
encryption

Die Verschlüsselungseigenschaften für diese Ressource.

endpoint
  • string

Endpunkt des erstellten Kontos.

endpoints
  • object
internalId
  • string

Der interne Bezeichner (veraltet, verwenden Sie diese Eigenschaft nicht).

isMigrated
  • boolean

Wenn die Ressource von einem vorhandenen Schlüssel migriert wird.

migrationToken
  • string

Ressourcenmigrationstoken.

networkAcls

Eine Sammlung von Regeln, die die Barrierefreiheit von bestimmten Netzwerkstandorten regeln.

privateEndpointConnections

Die private Endpunktverbindung, die dem Cognitive Services-Konto zugeordnet ist.

provisioningState

Ruft den Status des Cognitive Services-Kontos zum Zeitpunkt des Aufrufs des Vorgangs ab.

publicNetworkAccess

Gibt an, ob der Zugriff auf öffentliche Endpunkte für dieses Konto zulässig ist. Der Wert ist optional. Wenn er übergeben wird, muss er "Enabled" oder "Disabled" sein.

quotaLimit
restore
  • boolean
restrictOutboundNetworkAccess
  • boolean
skuChangeInfo

SKU-Änderungsinformationen des Kontos.

userOwnedStorage

Die Speicherkonten für diese Ressource.

ApiProperties

Die API-Eigenschaften für spezielle APIs.

Name Type Description
aadClientId
  • string

(nur Metrics Advisor) Die Azure AD Client-ID (Anwendungs-ID).

aadTenantId
  • string

(nur Metrics Advisor) Die Azure AD Mandanten-ID.

eventHubConnectionString
  • string

(Nur Personalisierung) Das Flag zum Aktivieren von Statistiken Bing-Suche.

qnaAzureSearchEndpointId
  • string

(Nur QnAMaker) Die Azure Search-Endpunkt-ID von QnAMaker.

qnaAzureSearchEndpointKey
  • string

(Nur QnAMaker) Der Azure Search-Endpunktschlüssel von QnAMaker.

qnaRuntimeEndpoint
  • string

(Nur QnAMaker) Der Laufzeitendpunkt von QnAMaker.

statisticsEnabled
  • boolean

(nur Bing-Suche) Das Flag zum Aktivieren von Statistiken Bing-Suche.

storageAccountConnectionString
  • string

(Nur Personalisierung) Die Verbindungszeichenfolge des Speicherkontos.

superUser
  • string

(nur Metrics Advisor) Der Superbenutzer von Metrics Advisor.

websiteName
  • string

(nur Metrics Advisor) Der Websitename des Metrics Advisor.

CallRateLimit

Das Aufrufratenlimit Cognitive Services Kontos.

Name Type Description
count
  • number

Der Count-Wert von Call Rate Limit.

renewalPeriod
  • number

Der Verlängerungszeitraum des Aufrufratenlimits in Sekunden.

rules

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Encryption

Eigenschaften zum Konfigurieren der Verschlüsselung

Name Type Description
keySource

Aufzählen des möglichen Werts von keySource für die Verschlüsselung

keyVaultProperties

Eigenschaften von KeyVault

ErrorAdditionalInfo

Zusätzliche Informationen zu Ressourcenverwaltungsfehlern.

Name Type Description
info
  • object

Die zusätzlichen Informationen.

type
  • string

Der zusätzliche Infotyp.

ErrorDetail

Die Fehlerdetails.

Name Type Description
additionalInfo

Die zusätzlichen Fehlerinformationen.

code
  • string

Der Fehlercode.

details

Die Fehlerdetails.

message
  • string

Die Fehlermeldung.

target
  • string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Type Description
error

Das Fehlerobjekt.

Identity

Identität für die Ressource.

Name Type Description
principalId
  • string

Die Prinzipal-ID der Ressourcenidentität.

tenantId
  • string

Die Mandanten-ID der Ressource.

type

Der Identitätstyp.

userAssignedIdentities

Die Liste der benutzer zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Schlüsselverweise des Benutzeridentitätswörterbuchs sind ARM-Ressourcen-IDs im Folgenden: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

IpRule

Eine Regel, die den Zugriff von einer bestimmten IP-Adresse oder einem bestimmten IP-Adressbereich aus regeln soll.

Name Type Description
value
  • string

Ein IPv4-Adressbereich in CIDR-Notation, z.B. "124.56.78.91" (einfache IP-Adresse) oder "124.56.78.0/24" (alle Adressen, die mit 124.56.78 beginnen).

keySource

Aufzählen des möglichen Werts von keySource für die Verschlüsselung

Name Type Description
Microsoft.CognitiveServices
  • string
Microsoft.KeyVault
  • string

KeyVaultProperties

Eigenschaften zum Konfigurieren von KeyVault-Eigenschaften

Name Type Description
identityClientId
  • string
keyName
  • string

Name des Schlüssels aus KeyVault

keyVaultUri
  • string

URI von KeyVault

keyVersion
  • string

Version des Schlüssels aus KeyVault

NetworkRuleAction

Die Standardaktion, wenn keine Regel von ipRules und von virtualNetworkRules übereinstimmen. Dies wird nur verwendet, nachdem die Bypass-Eigenschaft ausgewertet wurde.

Name Type Description
Allow
  • string
Deny
  • string

NetworkRuleSet

Eine Reihe von Regeln, die den Netzwerkzugriff regeln.

Name Type Description
defaultAction

Die Standardaktion, wenn keine Regel aus ipRules und virtualNetworkRules übereinstimmt. Dies wird nur verwendet, nachdem die Bypass-Eigenschaft ausgewertet wurde.

ipRules

Die Liste der IP-Adressregeln.

virtualNetworkRules

Die Liste der Regeln für virtuelle Netzwerke.

PrivateEndpoint

Die Ressource des privaten Endpunkts.

Name Type Description
id
  • string

Der ARM-Bezeichner für den privaten Endpunkt

PrivateEndpointConnection

Die Private Endpoint Connection-Ressource.

Name Type Description
etag
  • string

Ressourcen-ETag.

id
  • string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

Der Speicherort der Verbindung mit dem privaten Endpunkt.

name
  • string

Der Name der Ressource

properties

Ressourceneigenschaften.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

type
  • string

Der Typ der Ressource. Beispiel: "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Eigenschaften von PrivateEndpointConnectProperties.

Name Type Description
groupIds
  • string[]

Die ID der Private Link-Ressourcengruppe.

privateEndpoint

Die Ressource des privaten Endpunkts.

privateLinkServiceConnectionState

Eine Auflistung von Informationen über den Zustand der Verbindung zwischen dem Dienstanbieter und dem Consumer.

provisioningState

Der Bereitstellungsstatus der Verbindungsressource des privaten Endpunkts.

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string

PrivateEndpointServiceConnectionStatus

Der Verbindungsstatus des privaten Endpunkts.

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

Eine Auflistung von Informationen über den Zustand der Verbindung zwischen dem Dienstanbieter und dem Consumer.

Name Type Description
actionsRequired
  • string

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

description
  • string

Der Grund für die Genehmigung/Ablehnung der Verbindung.

status

Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

ProvisioningState

Ruft den Status des Cognitive Services-Kontos zum Zeitpunkt des Aufrufs des Vorgangs ab.

Name Type Description
Accepted
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Moving
  • string
ResolvingDNS
  • string
Succeeded
  • string

PublicNetworkAccess

Gibt an, ob der Zugriff auf öffentliche Endpunkte für dieses Konto zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss "Enabled" oder "Disabled" sein.

Name Type Description
Disabled
  • string
Enabled
  • string

QuotaLimit

Name Type Description
count
  • number
renewalPeriod
  • number
rules

RequestMatchPattern

Name Type Description
method
  • string
path
  • string

ResourceIdentityType

Der Identitätstyp.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

Sku

Die Ressourcenmodelldefinition, die die SKU darstellt

Name Type Description
capacity
  • integer

Wenn die SKU das auf- und einskaliert unterstützt, sollte die ganzzahlige Kapazitätszahl eingeschlossen werden. Wenn das aufskalierte/einskalierte Ressourcen nicht möglich ist, wird dies möglicherweise ausgelassen.

family
  • string

Wenn der Dienst über unterschiedliche Hardwaregenerationen für dieselbe SKU verfügt, kann dies hier erfasst werden.

name
  • string

Der Name der SKU. Z. B. P3. In der Regel handelt es sich um einen Buchstaben- und Zahlencode.

size
  • string

Die SKU-Größe. Wenn das Namensfeld die Kombination aus Tarif und einem anderen Wert ist, wäre dies der eigenständige Code.

tier

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehr als eine Ebene verfügt, aber für einen PUT nicht erforderlich ist.

SkuCapability

SkuCapability gibt die Funktion eines bestimmten Features an.

Name Type Description
name
  • string

Der Name der SkuCapability.

value
  • string

Der Wert von SkuCapability.

SkuChangeInfo

SKU-Änderungsinformationen des Kontos.

Name Type Description
countOfDowngrades
  • number

Ruft die Anzahl der Downgrades ab.

countOfUpgradesAfterDowngrades
  • number

Ruft die Anzahl der Upgrades nach Downgrades ab.

lastChangeDate
  • string

Ruft das Datum der letzten Änderung ab.

SkuTier

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst über mehr als eine Ebene verfügt, aber für einen PUT nicht erforderlich ist.

Name Type Description
Basic
  • string
Enterprise
  • string
Free
  • string
Premium
  • string
Standard
  • string

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Type Description
createdAt
  • string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy
  • string

Die Identität, die die Ressource erstellt hat.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt
  • string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy
  • string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

ThrottlingRule

Name Type Description
count
  • number
dynamicThrottlingEnabled
  • boolean
key
  • string
matchPatterns
minCount
  • number
renewalPeriod
  • number

UserAssignedIdentity

Vom Benutzer zugewiesene verwaltete Identität.

Name Type Description
clientId
  • string

Dieser Identität zugeordnete Client-App-ID.

principalId
  • string

Azure Active Directory Dieser Identität zugeordnete Prinzipal-ID.

UserOwnedStorage

Der benutzereigene Speicher für Cognitive Services Konto.

Name Type Description
identityClientId
  • string
resourceId
  • string

Vollständige Ressourcen-ID einer Microsoft.Storage-Ressource.

VirtualNetworkRule

Eine Regel, die den Zugriff von einem bestimmten virtuellen Netzwerk aus regeln soll.

Name Type Description
id
  • string

Vollständige Ressourcen-ID eines VNET-Subnetzes, z.B. "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

ignoreMissingVnetServiceEndpoint
  • boolean

Fehlenden VNET-Dienstendpunkt ignorieren oder nicht.

state
  • string

Ruft den Status der VNT-Regel ab.