Workspace Subscription - Create Or Update

Layanan:: API Management

Versi API:: 2024-05-01

Membuat atau memperbarui langganan pengguna tertentu ke produk yang ditentukan.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}?api-version=2024-05-01

Dengan parameter opsional:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}?notify={notify}&api-version=2024-05-01&appType={appType}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nama layanan API Management.
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.
appType	query		AppType	Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal penerbit warisan.
notify	query		boolean	Beri tahu perubahan dalam Status Langganan. Jika false, jangan kirim pemberitahuan email apa pun untuk perubahan status langganan Jika true, kirim pemberitahuan email tentang perubahan 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 minLength: 1 maxLength: 100	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 minLength: 1 maxLength: 256	Kunci langganan utama. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
properties.secondaryKey		string minLength: 1 maxLength: 256	Kunci langganan sekunder. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
properties.state		SubscriptionState	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	SubscriptionContract	Pengguna sudah berlangganan produk. Header ETag: string
201 Created	SubscriptionContract	Pengguna berhasil berlangganan produk. Header ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Nama

Jenis

Deskripsi

200 OK

SubscriptionContract

Pengguna sudah berlangganan produk.

Header

ETag: string

201 Created

SubscriptionContract

Pengguna berhasil berlangganan produk.

Header

ETag: string

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

ApiManagementCreateWorkspaceSubscription

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub?api-version=2024-05-01

{
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Respon sampel

Kode status:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/workspaces.subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Kode status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/workspaces.subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Definisi

Nama	Deskripsi
AppType	Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
SubscriptionContract	Detail langganan.
SubscriptionCreateParameters	Detail pembuatan 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.

AppType

Enumeration

Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan.

Nilai	Deskripsi
portal	Permintaan pembuatan pengguna dikirim oleh portal pengembang warisan.
developerPortal	Permintaan pembuatan pengguna dikirim oleh portal pengembang baru.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

SubscriptionContract

Objek

Detail langganan.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya
properties.allowTracing	boolean	Menentukan apakah pelacakan diaktifkan
properties.createdDate	string (date-time)	Tanggal pembuatan langganan. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.
properties.displayName	string minLength: 0 maxLength: 100	Nama langganan, atau null jika langganan tidak memiliki nama.
properties.endDate	string (date-time)	Tanggal saat langganan dibatalkan atau kedaluwarsa. Pengaturannya hanya untuk tujuan audit dan langganan tidak dibatalkan secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan properti `state`. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.
properties.expirationDate	string (date-time)	Tanggal kedaluwarsa langganan. Pengaturannya hanya untuk tujuan audit dan langganan tidak secara otomatis kedaluwarsa. Siklus hidup langganan dapat dikelola dengan menggunakan properti `state`. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.
properties.notificationDate	string (date-time)	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 pemilik langganan. Nilainya adalah URL relatif yang valid dalam format /users/{userId} di mana {userId} adalah pengidentifikasi pengguna.
properties.primaryKey	string minLength: 1 maxLength: 256	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 minLength: 1 maxLength: 256	Kunci sekunder langganan. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.
properties.startDate	string (date-time)	Tanggal aktivasi langganan. Pengaturannya hanya untuk tujuan audit dan langganan tidak diaktifkan secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan properti `state`. 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 ke 'ditolak'.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Objek

Detail pembuatan langganan.

Nama	Jenis	Deskripsi
properties.allowTracing	boolean	Menentukan apakah pelacakan dapat diaktifkan
properties.displayName	string minLength: 1 maxLength: 100	Nama langganan.
properties.ownerId	string	Pengguna (jalur id pengguna) yang langganannya sedang dibuat dalam formulir /users/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	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 minLength: 1 maxLength: 256	Kunci langganan sekunder. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
properties.state	SubscriptionState	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

Enumeration

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.

Nilai	Deskripsi
suspended
active
expired
submitted
rejected
cancelled

Bagikan melalui

Workspace Subscription - Create Or Update

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

ApiManagementCreateWorkspaceSubscription

Permintaan sampel

Respon sampel

Definisi

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionCreateParameters

SubscriptionState