Subscription - Create Or Update
Membuat atau memperbarui langganan pengguna tertentu ke produk tertentu.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2022-08-01
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2022-08-01&appType={appType}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
resource
|
path | True |
string |
Nama grup sumber daya. Nama tidak peka huruf besar/kecil. |
service
|
path | True |
string |
Nama layanan API Management. Pola regex: |
sid
|
path | True |
string |
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk dalam API Management. Pola regex: |
subscription
|
path | True |
string |
ID langganan target. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
app
|
query |
Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal penerbit warisan. |
||
notify
|
query |
boolean |
Beri tahu perubahan dalam Status Langganan.
|
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
If-Match |
string |
ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
properties.displayName | True |
string |
Nama langganan. |
properties.scope | True |
string |
Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}. |
properties.allowTracing |
boolean |
Menentukan apakah pelacakan dapat diaktifkan |
|
properties.ownerId |
string |
Pengguna (jalur id pengguna) yang langganannya sedang dibuat dalam formulir /users/{userId} |
|
properties.primaryKey |
string |
Kunci langganan utama. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis. |
|
properties.secondaryKey |
string |
Kunci langganan sekunder. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis. |
|
properties.state |
Status langganan awal. Jika tidak ada nilai yang ditentukan, langganan dibuat dengan status Dikirim. 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. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Pengguna sudah berlangganan produk. Header ETag: string |
|
201 Created |
Pengguna berhasil berlangganan produk. Header ETag: string |
|
Other Status Codes |
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
ApiManagementCreateSubscription
Permintaan sampel
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2022-08-01
{
"properties": {
"ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
"scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
"displayName": "testsub"
}
}
Respon sampel
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
"type": "Microsoft.ApiManagement/service/subscriptions",
"name": "testsub",
"properties": {
"ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
"scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
"displayName": "testsub",
"state": "submitted",
"createdDate": "2017-06-02T23:34:03.1055076Z"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
"type": "Microsoft.ApiManagement/service/subscriptions",
"name": "testsub",
"properties": {
"ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
"scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
"displayName": "testsub",
"state": "submitted",
"createdDate": "2017-06-02T23:34:03.1055076Z"
}
}
Definisi
Nama | Deskripsi |
---|---|
App |
Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal penerbit warisan. |
Error |
Kontrak Bidang Kesalahan. |
Error |
Respons Kesalahan. |
Subscription |
Detail langganan. |
Subscription |
Detail pembuatan langganan. |
Subscription |
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. |
AppType
Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal penerbit warisan.
Nama | Jenis | Deskripsi |
---|---|---|
developerPortal |
string |
Permintaan pembuatan pengguna dikirim oleh portal pengembang baru. |
portal |
string |
Permintaan pembuatan pengguna dikirim oleh portal pengembang warisan. |
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 |
Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi. |
|
error.message |
string |
Representasi kesalahan yang dapat dibaca manusia. |
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: |
properties.displayName |
string |
Nama langganan, atau null jika langganan tidak memiliki nama. |
properties.endDate |
string |
Tanggal saat langganan dibatalkan atau kedaluwarsa. Pengaturannya hanya untuk tujuan audit dan langganan tidak dibatalkan secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan |
properties.expirationDate |
string |
Tanggal kedaluwarsa langganan. Pengaturannya hanya untuk tujuan audit dan langganan tidak kedaluwarsa secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan |
properties.notificationDate |
string |
Tanggal pemberitahuan kedaluwarsa langganan mendatang. Tanggal sesuai dengan format berikut: |
properties.ownerId |
string |
Pengidentifikasi sumber daya pengguna pemilik langganan. Nilai adalah URL relatif yang valid dalam format /users/{userId} di mana {userId} adalah pengidentifikasi pengguna. |
properties.primaryKey |
string |
Kunci utama 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 hanya untuk tujuan audit dan langganan tidak diaktifkan secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan |
properties.state |
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" |
SubscriptionCreateParameters
Detail pembuatan langganan.
Nama | Jenis | Deskripsi |
---|---|---|
properties.allowTracing |
boolean |
Menentukan apakah pelacakan dapat diaktifkan |
properties.displayName |
string |
Nama langganan. |
properties.ownerId |
string |
Pengguna (jalur id pengguna) yang langganannya sedang dibuat dalam formulir /users/{userId} |
properties.primaryKey |
string |
Kunci langganan utama. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis. |
properties.scope |
string |
Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}. |
properties.secondaryKey |
string |
Kunci langganan sekunder. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis. |
properties.state |
Status langganan awal. Jika tidak ada nilai yang ditentukan, langganan dibuat dengan status Dikirim. 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. |
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 |