Bagikan melalui


User Subscription - List

Mencantumkan koleksi langganan pengguna tertentu.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
resourceGroupName
path True

string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.

serviceName
path True

string

Nama layanan API Management.

Pola regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID langganan target.

userId
path True

string

Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

$filter
query

string

| Bidang | Penggunaan | Operator yang didukung | Fungsi yang didukung |
|-------------|------------------------|-----------------------------------|
|nama | 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 |
|cakupan | 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

Jumlah rekaman yang akan dilewati.

$top
query

integer

int32

Jumlah rekaman yang akan dikembalikan.

Respons

Nama Jenis Deskripsi
200 OK

SubscriptionCollection

Mencantumkan kumpulan entitas Langganan.

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

ApiManagementListUserSubscriptions

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

SubscriptionCollection

Representasi daftar Langganan Halaman.

SubscriptionContract

Detail langganan.

SubscriptionState

Status langganan. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan tingkat properti.

message

string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target

string

Nama properti.

ErrorResponse

Respons Kesalahan.

Nama Jenis Deskripsi
error.code

string

Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.

error.details

ErrorFieldContract[]

Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.

error.message

string

Representasi kesalahan yang dapat dibaca manusia.

SubscriptionCollection

Representasi daftar Langganan Halaman.

Nama Jenis Deskripsi
count

integer

Jumlah total jumlah rekaman di semua halaman.

nextLink

string

Tautan halaman berikutnya jika ada.

value

SubscriptionContract[]

Nilai halaman.

SubscriptionContract

Detail langganan.

Nama Jenis Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nama sumber daya.

properties.allowTracing

boolean

Menentukan apakah pelacakan diaktifkan

properties.createdDate

string

Tanggal pembuatan langganan. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

properties.displayName

string

Nama langganan, atau null jika langganan tidak memiliki nama.

properties.endDate

string

Tanggal saat langganan dibatalkan atau kedaluwarsa. Pengaturan ini hanya untuk tujuan audit dan langganan tidak dibatalkan secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan state properti . Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

properties.expirationDate

string

Tanggal kedaluwarsa langganan. Pengaturan ini hanya untuk tujuan audit dan langganan tidak kedaluwarsa secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan state properti . Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

properties.notificationDate

string

Tanggal pemberitahuan kedaluwarsa langganan mendatang. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

properties.ownerId

string

Pengidentifikasi sumber daya pengguna dari pemilik langganan. Nilai adalah URL relatif yang valid dalam format /users/{userId} di mana {userId} adalah pengidentifikasi pengguna.

properties.primaryKey

string

Kunci primer langganan. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.

properties.scope

string

Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}.

properties.secondaryKey

string

Kunci sekunder langganan. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.

properties.startDate

string

Tanggal aktivasi langganan. Pengaturan ini hanya untuk tujuan audit dan langganan tidak diaktifkan secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan state properti . Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.

properties.state

SubscriptionState

Status langganan. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.

properties.stateComment

string

Komentar langganan opsional ditambahkan oleh administrator saat status diubah menjadi 'ditolak'.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SubscriptionState

Status langganan. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.

Nama Jenis Deskripsi
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string