Dela via

Subscription - List

  • Referens
Tjänst:
API Management
API-version:
2022-08-01

Visar en lista över alla prenumerationer för API Management tjänstinstans.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions?api-version=2022-08-01
Med valfria parametrar: 
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-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
 path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName
 path True

string

Namnet på API Management-tjänsten.

Reguljärt uttrycksmönster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ID för målprenumerationen.
api-version
 query True

string

Den API-version som ska användas för den här åtgärden.
$filter
 query

string

| Fält | Användning | Operatorer som stöds | Funktioner som stöds |
|-------------|-------------|-------------|-------------|
| namn | 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 |
| omfång | 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 |
| tillstånd | filter | eq | |
| användare | expandera | | | |
$skip
 query

integer

int32

Antal poster att hoppa över.
$top
 query

integer

int32

Antal poster som ska returneras.

Svar

Name Typ Description
200 OK

SubscriptionCollection

En samling prenumerationsentiteter för den angivna API Management tjänstinstansen.
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementListSubscriptions

Exempelbegäran

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

Exempelsvar

Statuskod:
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": ""
}

Definitioner

Name Description
ErrorFieldContract

Fel Fältkontrakt.
ErrorResponse

Felsvar.
SubscriptionCollection

Listrepresentation för sidade prenumerationer.
SubscriptionContract

Prenumerationsinformation.
SubscriptionState

Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått utgångsdatumet och inaktiverats.

ErrorFieldContract

Fel Fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.
message

string

Mänsklig läsbar representation av fel på egenskapsnivå.
target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
error.message

string

Mänsklig läsbar representation av felet.

SubscriptionCollection

Listrepresentation för sidade prenumerationer.

Name Typ Description
count

integer

Totalt antal poster på alla sidor.
nextLink

string

Om det finns någon länk till nästa sida.
value

SubscriptionContract[]

Sidvärden.

SubscriptionContract

Prenumerationsinformation.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Namnet på resursen
properties.allowTracing

boolean

Avgör om spårning är aktiverat
properties.createdDate

string

Skapandedatum för prenumeration. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.displayName

string

Namnet på prenumerationen eller null om prenumerationen inte har något namn.
properties.endDate

string

Datum då prenumerationen avbröts eller upphörde att gälla. Inställningen är endast i granskningssyfte och prenumerationen avbryts inte automatiskt. Prenumerationens livscykel kan hanteras med hjälp state av egenskapen . Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.expirationDate

string

Prenumerationens förfallodatum. Inställningen är endast i granskningssyfte och prenumerationen upphör inte att gälla automatiskt. Prenumerationens livscykel kan hanteras med hjälp state av egenskapen . Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.notificationDate

string

Förfallodatum för kommande prenumeration. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.ownerId

string

Användarens resurs-ID för prenumerationsägaren. Värdet är en giltig relativ URL i formatet /users/{userId} där {userId} är en användaridentifierare.
properties.primaryKey

string

Prenumerationens primärnyckel. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
properties.scope

string

Omfång som /products/{productId} eller /apis eller /apis/{apiId}.
properties.secondaryKey

string

Prenumerationens sekundära nyckel. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
properties.startDate

string

Aktiveringsdatum för prenumeration. Inställningen är endast i granskningssyfte och prenumerationen aktiveras inte automatiskt. Prenumerationens livscykel kan hanteras med hjälp state av egenskapen . Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.state

SubscriptionState

Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått utgångsdatumet och inaktiverats.
properties.stateComment

string

Valfri prenumerationskommentation som läggs till av en administratör när tillståndet ändras till "avvisad".
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SubscriptionState

Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått utgångsdatumet och inaktiverats.

Name Typ Description
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string