Megosztás a következőn keresztül:


User Subscription - List

A megadott felhasználó előfizetéseinek gyűjteményét sorolja fel.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.

serviceName
path True

string

A API Management szolgáltatás neve.

Reguláris kifejezési minta: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

A cél-előfizetés azonosítója.

userId
path True

string

Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

api-version
query True

string

A művelethez használandó API-verzió.

$filter
query

string

| Mező | Használat | Támogatott operátorok | Támogatott függvények |
|-------------|------------------------|-----------------------------------|
|name | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwithwith |
|displayName | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwithwith |
|stateComment | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwithwith |
|ownerId | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwithwith |
|hatókör | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwithwith |
|userId | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwithwith |
|productId | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query

integer

int32

Kihagyandó rekordok száma.

$top
query

integer

int32

A visszaadandó rekordok száma.

Válaszok

Name Típus Description
200 OK

SubscriptionCollection

Az előfizetési entitások gyűjteményét sorolja fel.

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

ApiManagementListUserSubscriptions

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
ErrorFieldContract

Hibamező-szerződés.

ErrorResponse

Hibaválasz.

SubscriptionCollection

Lapozott előfizetések listája.

SubscriptionContract

Előfizetés részletei.

SubscriptionState

Előfizetés állapota. Lehetséges állapotok : * aktív – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék API-jait, * elküldve – az előfizetési kérelmet a fejlesztő küldte, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda elutasította, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválva lett.

ErrorFieldContract

Hibamező-szerződés.

Name Típus Description
code

string

Tulajdonságszintű hibakód.

message

string

A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.

target

string

Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name Típus Description
error.code

string

Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.

error.details

ErrorFieldContract[]

Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája.

error.message

string

A hiba emberi olvasásra alkalmas ábrázolása.

SubscriptionCollection

Lapozott előfizetések listája.

Name Típus Description
count

integer

A rekordok teljes száma az összes oldalon.

nextLink

string

Ha van ilyen, a következő oldal hivatkozása.

value

SubscriptionContract[]

Oldalértékek.

SubscriptionContract

Előfizetés részletei.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Az erőforrás neve

properties.allowTracing

boolean

Meghatározza, hogy engedélyezve van-e a nyomkövetés

properties.createdDate

string

Előfizetés létrehozásának dátuma. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

properties.displayName

string

Az előfizetés neve, vagy null, ha az előfizetésnek nincs neve.

properties.endDate

string

Az előfizetés lemondásának vagy lejártának dátuma. A beállítás csak naplózási célokra szolgál, és az előfizetés nem törlődik automatikusan. Az előfizetés életciklusa a state tulajdonság használatával kezelhető. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

properties.expirationDate

string

Előfizetés lejárati dátuma. A beállítás csak naplózási célokra szolgál, és az előfizetés nem járt le automatikusan. Az előfizetés életciklusa a state tulajdonság használatával kezelhető. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

properties.notificationDate

string

Az előfizetés lejáratának közelgő értesítési dátuma. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

properties.ownerId

string

Az előfizetés tulajdonosának felhasználói erőforrás-azonosítója. Az érték egy érvényes relatív URL-cím /users/{userId} formátumban, ahol a(z) {userId} egy felhasználói azonosító.

properties.primaryKey

string

Előfizetés elsődleges kulcsa. Ez a tulajdonság nem lesz kitöltve a GET műveletekkel! Az érték lekéréséhez használja a "/listSecrets" POST kérést.

properties.scope

string

Hatókör, például /products/{productId} vagy /apis vagy /apis/{apiId}.

properties.secondaryKey

string

Előfizetés másodlagos kulcsa. Ez a tulajdonság nem lesz kitöltve a GET műveletekkel! Az érték lekéréséhez használja a "/listSecrets" POST kérést.

properties.startDate

string

Előfizetés aktiválásának dátuma. A beállítás csak naplózási célokra szolgál, és az előfizetés nem aktiválódik automatikusan. Az előfizetés életciklusa a state tulajdonság használatával kezelhető. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

properties.state

SubscriptionState

Előfizetés állapota. Lehetséges állapotok : * aktív – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék API-jait, * elküldve – az előfizetési kérelmet a fejlesztő küldte, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda elutasította, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválva lett.

properties.stateComment

string

Nem kötelező, hogy a rendszergazda megjegyzést fűzzön hozzá az előfizetéshez, amikor az állapot "elutasítva" állapotra módosul.

type

string

Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SubscriptionState

Előfizetés állapota. Lehetséges állapotok : * aktív – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék API-jait, * elküldve – az előfizetési kérelmet a fejlesztő küldte, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda elutasította, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválva lett.

Name Típus Description
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string