Sdílet prostřednictvím


User Subscription - List

Vypíše kolekci předplatných zadaného uživatele.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName
path True

string

Název služby API Management.

Vzor regulárního výrazu: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID cílového předplatného.

userId
path True

string

Identifikátor uživatele. Musí být v aktuální instanci služby API Management jedinečná.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

$filter
query

string

| Pole | Využití | Podporované operátory | Podporované funkce |
|-------------|------------------------|-----------------------------------|
|name | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s |
|displayName | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s |
|stateComment | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s |
|ownerId | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s |
|rozsah | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s |
|userId | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s |
|id produktu | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná s, končí |

$skip
query

integer

int32

Počet záznamů, které se mají přeskočit

$top
query

integer

int32

Počet vrácených záznamů.

Odpovědi

Name Typ Description
200 OK

SubscriptionCollection

Vypíše kolekci entit předplatného.

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

ApiManagementListUserSubscriptions

Ukázkový požadavek

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

Ukázková odpověď

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3",
      "type": "Microsoft.ApiManagement/service/users/subscriptions",
      "name": "57681850a40f7eb6c49f6ae3",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7",
        "displayName": "57681850a40f7eb6c49f6ae5",
        "state": "active",
        "createdDate": "2016-06-20T16:22:39.547Z",
        "startDate": "2016-06-20T00:00:00Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b",
      "type": "Microsoft.ApiManagement/service/users/subscriptions",
      "name": "57681850a40f7eb6c49f6b2b",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7",
        "displayName": "57681850a40f7eb6c49f6b2d",
        "state": "active",
        "createdDate": "2016-06-20T16:22:41.103Z",
        "startDate": "2016-06-20T00:00:00Z"
      }
    }
  ],
  "nextLink": ""
}

Definice

Name Description
ErrorFieldContract

Chyba Kontrakt pole.

ErrorResponse

Odpověď na chybu.

SubscriptionCollection

Reprezentace seznamu stránkovaných předplatných

SubscriptionContract

Podrobnosti o předplatném.

SubscriptionState

Stav předplatného. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

ErrorFieldContract

Chyba Kontrakt pole.

Name Typ Description
code

string

Kód chyby na úrovni vlastnosti.

message

string

Čitelné znázornění chyby na úrovni vlastností.

target

string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
error.code

string

Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

ErrorFieldContract[]

Seznam neplatných polí se odešle v žádosti v případě chyby ověření.

error.message

string

Znázornění chyby čitelné pro člověka

SubscriptionCollection

Reprezentace seznamu stránkovaných předplatných

Name Typ Description
count

integer

Celkový počet záznamů na všech stránkách.

nextLink

string

Odkaz na další stránku, pokud existuje.

value

SubscriptionContract[]

Hodnoty stránky.

SubscriptionContract

Podrobnosti o předplatném.

Name Typ Description
id

string

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Název prostředku

properties.allowTracing

boolean

Určuje, jestli je povolené trasování.

properties.createdDate

string

Datum vytvoření předplatného. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.

properties.displayName

string

Název předplatného nebo null, pokud předplatné nemá žádný název.

properties.endDate

string

Datum zrušení nebo vypršení platnosti předplatného Toto nastavení je jenom pro účely auditu a předplatné se nezruší automaticky. Životní cyklus předplatného je možné spravovat pomocí state vlastnosti . Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.

properties.expirationDate

string

Datum vypršení platnosti předplatného. Nastavení je jenom pro účely auditu a předplatné automaticky nevypršelo. Životní cyklus předplatného je možné spravovat pomocí state vlastnosti . Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.

properties.notificationDate

string

Nadcházející datum oznámení o vypršení platnosti předplatného Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.

properties.ownerId

string

Identifikátor prostředku uživatele vlastníka předplatného. Hodnota je platná relativní adresa URL ve formátu /users/{userId}, kde {userId} je identifikátor uživatele.

properties.primaryKey

string

Primární klíč předplatného. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets.

properties.scope

string

Rozsah, jako je /products/{productId} nebo /apis nebo /apis/{apiId}.

properties.secondaryKey

string

Sekundární klíč předplatného. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets.

properties.startDate

string

Datum aktivace předplatného. Toto nastavení je jenom pro účely auditu a předplatné se neaktivuje automaticky. Životní cyklus předplatného je možné spravovat pomocí state vlastnosti . Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.

properties.state

SubscriptionState

Stav předplatného. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

properties.stateComment

string

Volitelný komentář k předplatnému přidaný správcem, když se stav změní na odmítnuto.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SubscriptionState

Stav předplatného. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

Name Typ Description
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string