通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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>