Subscription - List

Referentie

Service:: API Management

API-versie:: 2024-05-01

Een lijst met alle abonnementen van het API Management-service-exemplaar.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions?api-version=2024-05-01

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	\| Veld \| Gebruik \| Ondersteunde operators \| Ondersteunde functies \| \|-------------\|-------------\|-------------\|-------------\| \| naam \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| displayName \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| stateComment \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| ownerId \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| bereik \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| userId \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| productId \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| status \| filter \| eq \| \| \| gebruiker \| uitvouwen \| \| \|
$skip	query		integer (int32) minimum: 0	Het aantal records dat moet worden overgeslagen.
$top	query		integer (int32) minimum: 1	Aantal records dat moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	SubscriptionCollection	Een verzameling van de abonnementsentiteiten voor het opgegeven API Management-service-exemplaar.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementListSubscriptions

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions?api-version=2024-05-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5600b59475ff190048070001",
      "properties": {
        "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001",
        "state": "active",
        "createdDate": "2015-09-22T01:57:40.3Z"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "56eaed3dbaf08b06e46d27fe",
      "properties": {
        "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5931a769d8d14f0ad8ce13b8",
      "properties": {
        "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
        "displayName": "Unlimited",
        "state": "submitted",
        "createdDate": "2017-06-02T17:59:06.223Z"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
SubscriptionCollection	Weergave van gepaginade abonnementenlijst.
SubscriptionContract	Abonnementsgegevens.
SubscriptionState	Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

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

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

SubscriptionCollection

Object

Weergave van gepaginade abonnementenlijst.

Name	Type	Description
count	integer (int64)	Totaal aantal records voor alle pagina's.
nextLink	string	Koppeling naar volgende pagina indien aanwezig.
value	SubscriptionContract[]	Paginawaarden.

SubscriptionContract

Object

Abonnementsgegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.allowTracing	boolean	Bepaalt of tracering is ingeschakeld
properties.createdDate	string (date-time)	De aanmaakdatum van het abonnement. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.displayName	string minLength: 0 maxLength: 100	De naam van het abonnement of null als het abonnement geen naam heeft.
properties.endDate	string (date-time)	Datum waarop het abonnement is geannuleerd of verlopen. De instelling is alleen bedoeld voor controledoeleinden en het abonnement wordt niet automatisch geannuleerd. De levenscyclus van het abonnement kan worden beheerd met behulp van de eigenschap `state`. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.expirationDate	string (date-time)	Vervaldatum van abonnement. De instelling is alleen bedoeld voor controledoeleinden en het abonnement is niet automatisch verlopen. De levenscyclus van het abonnement kan worden beheerd met behulp van de eigenschap `state`. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.notificationDate	string (date-time)	Vervaldatum van het geplande abonnement. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.ownerId	string	De gebruikersresource-id van de eigenaar van het abonnement. De waarde is een geldige relatieve URL in de indeling /users/{userId} waarbij {userId} een gebruikers-id is.
properties.primaryKey	string minLength: 1 maxLength: 256	Primaire abonnementssleutel. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.
properties.scope	string	Bereik zoals /products/{productId} of /apis of /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Secundaire abonnementssleutel. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.
properties.startDate	string (date-time)	Activeringsdatum van abonnement. De instelling is alleen bedoeld voor controledoeleinden en het abonnement wordt niet automatisch geactiveerd. De levenscyclus van het abonnement kan worden beheerd met behulp van de eigenschap `state`. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.state	SubscriptionState	Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.
properties.stateComment	string	Optionele abonnementscommentaar toegevoegd door een beheerder wanneer de status wordt gewijzigd in geweigerd.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SubscriptionState

Inventarisatie

Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.

Waarde	Description
active
cancelled
expired
rejected
submitted
suspended

Delen via

Subscription - List

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementListSubscriptions

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionCollection

SubscriptionContract

SubscriptionState

Aanvullende resources