Subscription - List

  • Referenz
Service:
API Management
API Version:
2022-08-01

Listet alle Abonnements der API Management-Dienstinstanz auf

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
 path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName
 path True

string

Der Name des API Management-Diensts.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
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.
$filter
 query

string

| Feld | Nutzung | Unterstützte Operatoren | Unterstützte Funktionen |
|-------------|-------------|-------------|-------------|
| Name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| Scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| Zustand | filter | eq | |
| Benutzer | expand | | | |
$skip
 query

integer

int32

Die Anzahl der zu überspringenden Datensätze.
$top
 query

integer

int32

Die Anzahl der zurückzugebenden Datensätze.

Antworten

Name Typ Beschreibung
200 OK

SubscriptionCollection

Eine Auflistung der Abonnemententitäten für den angegebenen API Management-Dienst instance.
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementListSubscriptions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5600b59475ff190048070001",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001",
        "state": "active",
        "createdDate": "2015-09-22T01:57:40.3Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "56eaed3dbaf08b06e46d27fe",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001",
        "displayName": "Starter",
        "state": "active",
        "createdDate": "2016-03-17T17:45:33.837Z",
        "startDate": "2016-03-17T00:00:00Z",
        "expirationDate": "2016-04-01T00:00:00Z",
        "notificationDate": "2016-03-20T00:00:00Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5931a769d8d14f0ad8ce13b8",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
        "displayName": "Unlimited",
        "state": "submitted",
        "createdDate": "2017-06-02T17:59:06.223Z"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definitionen

Name Beschreibung
ErrorFieldContract

Fehler Feldvertrag.
ErrorResponse

Fehlerantwort.
SubscriptionCollection

Darstellung der Liste "Ausgelagerte Abonnements".
SubscriptionContract

Abonnementdetails.
SubscriptionState

Abonnementstatus. Mögliche Status sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen: Das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.

ErrorFieldContract

Fehler Feldvertrag.

Name Typ Beschreibung
code

string

Fehlercode auf Eigenschaftsebene.
message

string

Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target

string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error.code

string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details

ErrorFieldContract[]

Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
error.message

string

Lesbare Darstellung des Fehlers.

SubscriptionCollection

Darstellung der Liste "Ausgelagerte Abonnements".

Name Typ Beschreibung
count

integer

Gesamtzahl der Datensätze auf allen Seiten.
nextLink

string

Link zur nächsten Seite, falls vorhanden.
value

SubscriptionContract[]

Seitenwerte.

SubscriptionContract

Abonnementdetails.

Name Typ Beschreibung
id

string

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

string

Der Name der Ressource
properties.allowTracing

boolean

Bestimmt, ob die Ablaufverfolgung aktiviert ist.
properties.createdDate

string

Erstellungsdatum des Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.displayName

string

Der Name des Abonnements oder NULL, wenn das Abonnement keinen Namen hat.
properties.endDate

string

Datum, an dem das Abonnement gekündigt oder abgelaufen ist. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch gekündigt. Der Abonnementlebenszyklus kann mithilfe der state -Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.expirationDate

string

Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der state -Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.notificationDate

string

Anstehendes Ablaufdatum des Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.ownerId

string

Die Benutzer-ID des Abonnementeigentümers. Der Wert ist eine gültige relative URL im Format "/users/{userId}", wobei {userId} eine Benutzer-ID ist.
properties.primaryKey

string

Primärschlüssel des Abonnements. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
properties.scope

string

Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.
properties.secondaryKey

string

Sekundärer Abonnementschlüssel. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
properties.startDate

string

Abonnementaktivierungsdatum. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch aktiviert. Der Abonnementlebenszyklus kann mithilfe der state -Eigenschaft verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.state

SubscriptionState

Abonnementstatus. Mögliche Status sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen: Das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.
properties.stateComment

string

Optionaler Abonnementkommentar, der von einem Administrator hinzugefügt wird, wenn der Status in "abgelehnt" geändert wird.
type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SubscriptionState

Abonnementstatus. Mögliche Status sind * aktiv – das Abonnement ist aktiv, * angehalten – das Abonnement ist blockiert, und der Abonnent kann keine APIs des Produkts aufrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler gestellt, aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator abgelehnt, * gekündigt – das Abonnement wurde vom Entwickler oder Administrator gekündigt, * abgelaufen: Das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.

Name Typ Beschreibung
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string