ProductContract interface

Paket:

@azure/arm-apimanagement

Detail produk.

Memperluas

ProxyResource

Properti

approvalRequired	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.
description	Deskripsi Produk. Dapat mencakup tag pemformatan HTML.
displayName	Nama produk.
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.
subscriptionRequired	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 "terbuka" dan permintaan ke API yang disertakan dalam produk dapat dibuat tanpa kunci langganan. Jika properti dihilangkan saat membuat produk baru, nilainya diasumsikan benar.
subscriptionsLimit	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.
terms	Ketentuan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses langganan.

Properti yang Diwariskan

id	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
name	Nama CATATAN sumber daya: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
type	Jenis sumber daya. Misalnya CATATAN "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts": Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

Detail Properti

approvalRequired

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.

approvalRequired?: boolean

Nilai Properti

boolean

description

Deskripsi Produk. Dapat mencakup tag pemformatan HTML.

description?: string

Nilai Properti

string

displayName

Nama produk.

displayName?: string

Nilai Properti

string

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.

state?: ProductState

Nilai Properti

ProductState

subscriptionRequired

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 "terbuka" dan permintaan ke API yang disertakan dalam produk dapat dibuat tanpa kunci langganan. Jika properti dihilangkan saat membuat produk baru, nilainya diasumsikan benar.

subscriptionRequired?: boolean

Nilai Properti

boolean

subscriptionsLimit

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.

subscriptionsLimit?: number

Nilai Properti

number

terms

Ketentuan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses langganan.

terms?: string

Nilai Properti

string

Detail Properti yang Diwariskan

id

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

id?: string

Nilai Properti

string

Diwarisi dari ProxyResource.id

name

Nama CATATAN sumber daya: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

name?: string

Nilai Properti

string

Diwarisi dari ProxyResource.name

type

Jenis sumber daya. Misalnya CATATAN "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts": Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

type?: string

Nilai Properti

string

Diwarisi dariProxyResource.type