Subscription interface
Antarmuka yang mewakili Langganan.
Metode
Detail Metode
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Membuat atau memperbarui langganan pengguna tertentu ke produk yang ditentukan.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
- parameters
- SubscriptionCreateParameters
Buat parameter.
Parameter opsi.
Mengembalikan
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Menghapus langganan yang ditentukan.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
- ifMatch
-
string
ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.
- options
- SubscriptionDeleteOptionalParams
Parameter opsi.
Mengembalikan
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Mendapatkan entitas Langganan yang ditentukan.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
- options
- SubscriptionGetOptionalParams
Parameter opsi.
Mengembalikan
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Mendapatkan versi status entitas (Etag) dari langganan apimanagement yang ditentukan oleh pengidentifikasinya.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
Parameter opsi.
Mengembalikan
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Mencantumkan semua langganan instans layanan API Management.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- options
- SubscriptionListOptionalParams
Parameter opsi.
Mengembalikan
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Mendapatkan kunci Langganan yang ditentukan.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
Parameter opsi.
Mengembalikan
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Meregenerasi kunci utama langganan instans layanan API Management yang ada.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
Parameter opsi.
Mengembalikan
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Meregenerasi kunci sekunder dari langganan instans layanan API Management yang ada.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
Parameter opsi.
Mengembalikan
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Memperbarui detail langganan yang ditentukan oleh pengidentifikasinya.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
- serviceName
-
string
Nama layanan API Management.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
- ifMatch
-
string
ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.
- parameters
- SubscriptionUpdateParameters
Perbarui parameter.
- options
- SubscriptionUpdateOptionalParams
Parameter opsi.
Mengembalikan
Promise<SubscriptionUpdateResponse>