Product - Get
Mendapatkan detail produk yang ditentukan oleh pengidentifikasinya.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2022-08-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
product
|
path | True |
string |
Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini. |
resource
|
path | True |
string |
Nama grup sumber daya. Nama tidak peka huruf besar/kecil. |
service
|
path | True |
string |
Nama layanan API Management. Regex pattern: |
subscription
|
path | True |
string |
ID langganan target. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Isi respons berisi entitas Produk yang ditentukan. Headers ETag: string |
|
Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
ApiManagementGetProduct
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited?api-version=2022-08-01
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited",
"type": "Microsoft.ApiManagement/service/products",
"name": "unlimited",
"properties": {
"displayName": "Unlimited",
"description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
"subscriptionRequired": true,
"approvalRequired": true,
"subscriptionsLimit": 1,
"state": "published"
}
}
Definisi
Nama | Deskripsi |
---|---|
Error |
Kontrak Bidang Kesalahan. |
Error |
Respons Kesalahan. |
Product |
Detail produk. |
Product |
apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan. |
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. |
ProductContract
Detail produk.
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.approvalRequired |
boolean |
apakah persetujuan langganan diperlukan. Jika false, langganan baru akan disetujui secara otomatis memungkinkan pengembang untuk memanggil API produk segera setelah berlangganan. Jika true, administrator harus menyetujui langganan secara manual sebelum pengembang dapat menggunakan API produk apa pun. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false. |
properties.description |
string |
Deskripsi produk. Mungkin menyertakan tag pemformatan HTML. |
properties.displayName |
string |
Nama produk. |
properties.state |
apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan. |
|
properties.subscriptionRequired |
boolean |
Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini. Jika true, produk disebut sebagai "dilindungi" dan kunci langganan yang valid diperlukan agar permintaan ke API yang disertakan dalam produk berhasil. Jika false, produk disebut sebagai "buka" dan permintaan ke API yang disertakan dalam produk dapat dibuat tanpa kunci langganan. Jika properti dihilangkan saat membuat produk baru, nilainya diasumsikan benar. |
properties.subscriptionsLimit |
integer |
Apakah jumlah langganan yang dapat dimiliki pengguna ke produk ini secara bersamaan. Atur ke null atau hilangkan untuk mengizinkan langganan per pengguna tanpa batas. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false. |
properties.terms |
string |
Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan. |
type |
string |
Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts" |
ProductState
apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan.
Nama | Jenis | Deskripsi |
---|---|---|
notPublished |
string |
|
published |
string |