通过

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

AuthorizationServer interface

包:
@azure/arm-apimanagement

表示 AuthorizationServer 的接口。

方法

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)

创建新的授权服务器或更新现有授权服务器。
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)

删除特定的授权服务器实例。
get(string, string, string, AuthorizationServerGetOptionalParams)

获取由其标识符指定的授权服务器的详细信息。
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)

获取由其标识符指定的 authorizationServer 的实体状态 （Etag） 版本。
listByService(string, string, AuthorizationServerListByServiceOptionalParams)

列出服务实例中定义的授权服务器的集合。
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)

获取授权服务器的客户端机密详细信息。
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)

更新由其标识符指定的授权服务器的详细信息。

方法详细信息

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)

创建新的授权服务器或更新现有授权服务器。

function createOrUpdate(resourceGroupName: string, serviceName: string, authsid: string, parameters: AuthorizationServerContract, options?: AuthorizationServerCreateOrUpdateOptionalParams): Promise<AuthorizationServerCreateOrUpdateResponse>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

authsid

string

授权服务器的标识符。

parameters
AuthorizationServerContract

创建或更新参数。

options
AuthorizationServerCreateOrUpdateOptionalParams

选项参数。

返回

Promise<AuthorizationServerCreateOrUpdateResponse>

delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)

删除特定的授权服务器实例。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

authsid

string

授权服务器的标识符。

ifMatch

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

options
AuthorizationServerDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, AuthorizationServerGetOptionalParams)

获取由其标识符指定的授权服务器的详细信息。

function get(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetOptionalParams): Promise<AuthorizationServerGetResponse>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

authsid

string

授权服务器的标识符。

options
AuthorizationServerGetOptionalParams

选项参数。

返回

Promise<AuthorizationServerGetResponse>

getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)

获取由其标识符指定的 authorizationServer 的实体状态 （Etag） 版本。

function getEntityTag(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetEntityTagOptionalParams): Promise<AuthorizationServerGetEntityTagHeaders>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

authsid

string

授权服务器的标识符。

options
AuthorizationServerGetEntityTagOptionalParams

选项参数。

返回

Promise<AuthorizationServerGetEntityTagHeaders>

listByService(string, string, AuthorizationServerListByServiceOptionalParams)

列出服务实例中定义的授权服务器的集合。

function listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationServerListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

options
AuthorizationServerListByServiceOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)

获取授权服务器的客户端机密详细信息。

function listSecrets(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerListSecretsOptionalParams): Promise<AuthorizationServerListSecretsResponse>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

authsid

string

授权服务器的标识符。

options
AuthorizationServerListSecretsOptionalParams

选项参数。

返回

Promise<AuthorizationServerListSecretsResponse>

update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)

更新由其标识符指定的授权服务器的详细信息。

function update(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, parameters: AuthorizationServerUpdateContract, options?: AuthorizationServerUpdateOptionalParams): Promise<AuthorizationServerUpdateResponse>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

authsid

string

授权服务器的标识符。

ifMatch

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

parameters
AuthorizationServerUpdateContract

OAuth2 服务器设置更新参数。

options
AuthorizationServerUpdateOptionalParams

选项参数。

返回

Promise<AuthorizationServerUpdateResponse>