WorkspaceSubscription interface
Antarmuka yang mewakili WorkspaceSubscription.
Metode
Detail Metode
createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)
Membuat atau memperbarui langganan pengguna tertentu ke produk tertentu.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
- parameters
- SubscriptionCreateParameters
Buat parameter.
Parameter opsi.
Mengembalikan
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)
Menghapus langganan yang ditentukan.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- 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.
Parameter opsi.
Mengembalikan
Promise<void>
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)
Mendapatkan entitas Langganan yang ditentukan.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
Parameter opsi.
Mengembalikan
Promise<WorkspaceSubscriptionGetResponse>
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)
Mendapatkan versi status entitas (Etag) dari langganan apimanagement yang ditentukan oleh pengidentifikasinya.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
Parameter opsi.
Mengembalikan
list(string, string, string, WorkspaceSubscriptionListOptionalParams)
Mencantumkan semua langganan ruang kerja dalam instans layanan API Management.
function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
Parameter opsi.
Mengembalikan
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)
Mendapatkan kunci Berlangganan yang ditentukan.
function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
Parameter opsi.
Mengembalikan
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)
Meregenerasi kunci utama langganan ruang kerja yang ada dalam instans layanan API Management.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- sid
-
string
Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk di API Management.
Parameter opsi.
Mengembalikan
Promise<void>
regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)
Meregenerasi kunci sekunder dari langganan ruang kerja yang ada dalam instans layanan API Management.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- 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, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)
Memperbarui detail langganan yang ditentukan oleh pengidentifikasinya.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>
Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- 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.
Parameter opsi.
Mengembalikan
Promise<WorkspaceSubscriptionUpdateResponse>