共用方式為

Subscription interface

  • 參考
套件:
@azure/arm-apimanagement

代表訂閱的介面。

方法

createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)

建立或更新指定之使用者的訂閱至指定的產品。
delete(string, string, string, string, SubscriptionDeleteOptionalParams)

刪除指定的訂用帳戶。
get(string, string, string, SubscriptionGetOptionalParams)

取得指定的訂閱實體。
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)

取得其標識碼所指定的 apimanagement 訂用帳戶實體狀態 （Etag） 版本。
list(string, string, SubscriptionListOptionalParams)

列出 API 管理服務實例的所有訂用帳戶。
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)

取得指定的訂用帳戶金鑰。
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)

重新產生 API 管理服務實例現有訂用帳戶的主要金鑰。
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)

重新產生 API 管理服務實例現有訂用帳戶的次要金鑰。
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)

更新其識別碼所指定的訂用帳戶詳細數據。

方法詳細資料

createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)

建立或更新指定之使用者的訂閱至指定的產品。

function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

sid

string

訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。

parameters
SubscriptionCreateParameters

建立參數。

options
SubscriptionCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<SubscriptionCreateOrUpdateResponse>

delete(string, string, string, string, SubscriptionDeleteOptionalParams)

刪除指定的訂用帳戶。

function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

sid

string

訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。

ifMatch

string

實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。

options
SubscriptionDeleteOptionalParams

選項參數。

傳回

Promise<void>

get(string, string, string, SubscriptionGetOptionalParams)

取得指定的訂閱實體。

function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

sid

string

訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。

options
SubscriptionGetOptionalParams

選項參數。

傳回

Promise<SubscriptionGetResponse>

getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)

取得其標識碼所指定的 apimanagement 訂用帳戶實體狀態 （Etag） 版本。

function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

sid

string

訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。

options
SubscriptionGetEntityTagOptionalParams

選項參數。

傳回

Promise<SubscriptionGetEntityTagHeaders>

list(string, string, SubscriptionListOptionalParams)

列出 API 管理服務實例的所有訂用帳戶。

function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

options
SubscriptionListOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>

listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)

取得指定的訂用帳戶金鑰。

function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

sid

string

訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。

options
SubscriptionListSecretsOptionalParams

選項參數。

傳回

Promise<SubscriptionListSecretsResponse>

regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)

重新產生 API 管理服務實例現有訂用帳戶的主要金鑰。

function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

sid

string

訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。

options
SubscriptionRegeneratePrimaryKeyOptionalParams

選項參數。

傳回

Promise<void>

regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)

重新產生 API 管理服務實例現有訂用帳戶的次要金鑰。

function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

sid

string

訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。

options
SubscriptionRegenerateSecondaryKeyOptionalParams

選項參數。

傳回

Promise<void>

update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)

更新其識別碼所指定的訂用帳戶詳細數據。

function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

sid

string

訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。

ifMatch

string

實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。

parameters
SubscriptionUpdateParameters

更新參數。

options
SubscriptionUpdateOptionalParams

選項參數。

傳回

Promise<SubscriptionUpdateResponse>