User Subscription - List

Belirtilen kullanıcının abonelik koleksiyonunu listeler.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions?api-version=2020-06-01-preview
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=2020-06-01-preview

URI Parametreleri

Name In Required Type Description
resourceGroupName
path True
  • string

Kaynak grubunun adı.

serviceName
path True
  • string

API Management hizmetinin adı.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Aboneliğinizi benzersiz bir şekilde Microsoft Azure bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir bölümünü oluşturur.

userId
path True
  • string

Kullanıcı tanımlayıcısı. Geçerli hizmet örneğinde benzersiz API Management olmalıdır.

api-version
query True
  • string

İstemci isteğiyle kullanılacak API'nin sürümü.

$filter
query
  • string

| Alan | Kullanım | Desteklenen işleçler | Desteklenen işlevler |
|-------------|------------------------|-----------------------------------|
|name | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|displayName | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|stateComment | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|ownerId | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|scope | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|userId | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|productId | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query
  • integer
int32

Atlan kayıt sayısı.

$top
query
  • integer
int32

Döndürülecek kayıt sayısı.

Yanıtlar

Name Type Description
200 OK

Abonelik varlıkları koleksiyonunu listeler.

Other Status Codes

İşlem neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation kullanıcı hesabınıza kimliğine bürünme

Örnekler

ApiManagementListUserSubscriptions

Sample Request

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

Sample Response

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

Tanımlar

ErrorFieldContract

Hata Alanı sözleşmesi.

ErrorResponse

Hata Yanıtı.

SubscriptionCollection

Sayfalı Abonelikler listesi gösterimi.

SubscriptionContract

Abonelik ayrıntıları.

SubscriptionState

Abonelik durumu. Olası eyaletler * etkin – abonelik etkin, * askıya alındı – abonelik engellendi ve abone ürünün herhangi bir API'lerini çağıramaz, * gönderildi ; abonelik isteği geliştirici tarafından henüz onaylanmadı veya reddedildi, * reddedildi - abonelik isteği yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi , * süresi doldu – abonelik sona erme tarihine ulaştı ve devre dışı bırakıldı.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name Type Description
code
  • string

Özellik düzeyi hata kodu.

message
  • string

Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.

target
  • string

Özellik adı.

ErrorResponse

Hata Yanıtı.

Name Type Description
error.code
  • string

Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum olarak görev alır.

error.details

Doğrulama hatası durumunda istekte göndermekte olan geçersiz alanların listesi.

error.message
  • string

Hatanın insanlar tarafından okunabilir temsili.

SubscriptionCollection

Sayfalı Abonelikler listesi gösterimi.

Name Type Description
count
  • integer

Tüm sayfalarda toplam kayıt sayısı.

nextLink
  • string

Varsa sonraki sayfa bağlantısı.

value

Sayfa değerleri.

SubscriptionContract

Abonelik ayrıntıları.

Name Type Description
id
  • string

Kaynak Kimliği.

name
  • string

Kaynak adı.

properties.allowTracing
  • boolean

İzlemenin etkin olup olmadığını belirler

properties.createdDate
  • string

Abonelik oluşturma tarihi. Tarih, yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtilen biçimdedir.

properties.displayName
  • string

Aboneliğin adı veya aboneliğin adı yoksa null.

properties.endDate
  • string

Aboneliğin iptal edildiği veya süresinin dol olduğu tarih. Ayar yalnızca denetim amaçlıdır ve abonelik otomatik olarak iptal edilmez. Abonelik yaşam döngüsü özelliği kullanılarak state yönetilebilir. Tarih, yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtilen biçimdedir.

properties.expirationDate
  • string

Abonelik sona erme tarihi. Ayar yalnızca denetim amaçlıdır ve aboneliğin süresi otomatik olarak dolmaz. Abonelik yaşam döngüsü özelliği kullanılarak state yönetilebilir. Tarih, yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtilen biçimdedir.

properties.notificationDate
  • string

Yaklaşan abonelik süre sonu bildirim tarihi. Tarih, yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtilen biçimdedir.

properties.ownerId
  • string

Abonelik sahibinin kullanıcı kaynak tanımlayıcısı. Değer, /users/{userId} biçiminde geçerli bir göreli URL'dir ve burada {userId} bir kullanıcı tanımlayıcısıdır.

properties.primaryKey
  • string

Abonelik birincil anahtarı. Bu özellik 'GET' işlemleriyle doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın.

properties.scope
  • string

/products/{productId} veya /apis veya /apis/{apiId} gibi kapsam.

properties.secondaryKey
  • string

Abonelik ikincil anahtarı. Bu özellik 'GET' işlemleriyle doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın.

properties.startDate
  • string

Abonelik etkinleştirme tarihi. Bu ayar yalnızca denetim amaçlıdır ve abonelik otomatik olarak etkinleştirilmez. Abonelik yaşam döngüsü özelliği kullanılarak state yönetilebilir. Tarih, yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtilen biçimdedir.

properties.state

Abonelik durumu. Olası eyaletler * etkin – abonelik etkin, * askıya alındı – abonelik engellendi ve abone ürünün herhangi bir API'lerini çağıramaz, * gönderildi ; abonelik isteği geliştirici tarafından henüz onaylanmadı veya reddedildi, * reddedildi - abonelik isteği yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi , * süresi doldu – abonelik sona erme tarihine ulaştı ve devre dışı bırakıldı.

properties.stateComment
  • string

Durum 'reddedildi' olarak değiştiriliyor olduğunda yönetici tarafından eklenen isteğe bağlı abonelik açıklaması.

type
  • string

Kaynak için API Management türü.

SubscriptionState

Abonelik durumu. Olası eyaletler * etkin – abonelik etkin, * askıya alındı – abonelik engellendi ve abone ürünün herhangi bir API'lerini çağıramaz, * gönderildi ; abonelik isteği geliştirici tarafından henüz onaylanmadı veya reddedildi, * reddedildi - abonelik isteği yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi , * süresi doldu – abonelik sona erme tarihine ulaştı ve devre dışı bırakıldı.

Name Type Description
active
  • string
cancelled
  • string
expired
  • string
rejected
  • string
submitted
  • string
suspended
  • string