Udostępnij za pośrednictwem


User Subscription - List

Wyświetla listę kolekcji subskrypcji określonego użytkownika.

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 identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName
path True

string

Nazwa usługi API Management.

Wzorzec wyrażenia regularnego: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

userId
path True

string

Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

$filter
query

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|------------------------|-----------------------------------|
|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 |
|zakres | 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 |

$skip
query

integer

int32

Liczba rekordów do pominięcia.

$top
query

integer

int32

Liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

SubscriptionCollection

Wyświetla listę kolekcji jednostek subskrypcji.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementListUserSubscriptions

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ErrorFieldContract

Błąd Kontrakt pola.

ErrorResponse

Odpowiedź na błąd.

SubscriptionCollection

Reprezentacja listy stronicowanych subskrypcji.

SubscriptionContract

Szczegóły subskrypcji.

SubscriptionState

Stan subskrypcji. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało wykonane przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasło — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana.

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa Typ Opis
code

string

Kod błędu poziomu właściwości.

message

string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.

target

string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error.code

string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.

error.details

ErrorFieldContract[]

Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.

error.message

string

Czytelna dla człowieka reprezentacja błędu.

SubscriptionCollection

Reprezentacja listy stronicowanych subskrypcji.

Nazwa Typ Opis
count

integer

Łączna liczba rekordów na wszystkich stronach.

nextLink

string

Jeśli istnieje, łącze następnej strony.

value

SubscriptionContract[]

Wartości stron.

SubscriptionContract

Szczegóły subskrypcji.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.allowTracing

boolean

Określa, czy śledzenie jest włączone

properties.createdDate

string

Data utworzenia subskrypcji. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601.

properties.displayName

string

Nazwa subskrypcji lub wartość null, jeśli subskrypcja nie ma nazwy.

properties.endDate

string

Data anulowania lub wygaśnięcia subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie jest automatycznie anulowana. Cykl życia subskrypcji można zarządzać przy użyciu state właściwości . Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601.

properties.expirationDate

string

Data wygaśnięcia subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie wygasła automatycznie. Cykl życia subskrypcji można zarządzać przy użyciu state właściwości . Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601.

properties.notificationDate

string

Zbliżająca się data powiadomienia o wygaśnięciu subskrypcji. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601.

properties.ownerId

string

Identyfikator zasobu użytkownika właściciela subskrypcji. Wartość jest prawidłowym względnym adresem URL w formacie /users/{userId}, gdzie {userId} jest identyfikatorem użytkownika.

properties.primaryKey

string

Klucz podstawowy subskrypcji. Ta właściwość nie zostanie wypełniona operacjami "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.

properties.scope

string

Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}.

properties.secondaryKey

string

Klucz pomocniczy subskrypcji. Ta właściwość nie zostanie wypełniona operacjami "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.

properties.startDate

string

Data aktywacji subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie jest aktywowana automatycznie. Cykl życia subskrypcji można zarządzać przy użyciu state właściwości . Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601.

properties.state

SubscriptionState

Stan subskrypcji. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało wykonane przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasło — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana.

properties.stateComment

string

Opcjonalny komentarz subskrypcji dodany przez administratora po zmianie stanu na "odrzucony".

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SubscriptionState

Stan subskrypcji. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało wykonane przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasło — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana.

Nazwa Typ Opis
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string