通过

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

OpenIdConnectProvider interface

包:
@azure/arm-apimanagement

表示 OpenIdConnectProvider 的接口。

方法

createOrUpdate(string, string, string, OpenidConnectProviderContract, OpenIdConnectProviderCreateOrUpdateOptionalParams)

创建或更新 OpenID Connect 提供程序。
delete(string, string, string, string, OpenIdConnectProviderDeleteOptionalParams)

删除 API 管理服务实例的特定 OpenID Connect 提供程序。
get(string, string, string, OpenIdConnectProviderGetOptionalParams)

获取没有机密的特定 OpenID Connect 提供程序。
getEntityTag(string, string, string, OpenIdConnectProviderGetEntityTagOptionalParams)

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

所有 OpenId Connect 提供程序的列表。
listSecrets(string, string, string, OpenIdConnectProviderListSecretsOptionalParams)

获取 OpenID Connect 提供程序的客户端机密详细信息。
update(string, string, string, string, OpenidConnectProviderUpdateContract, OpenIdConnectProviderUpdateOptionalParams)

更新特定的 OpenID Connect 提供程序。

方法详细信息

createOrUpdate(string, string, string, OpenidConnectProviderContract, OpenIdConnectProviderCreateOrUpdateOptionalParams)

创建或更新 OpenID Connect 提供程序。

function createOrUpdate(resourceGroupName: string, serviceName: string, opid: string, parameters: OpenidConnectProviderContract, options?: OpenIdConnectProviderCreateOrUpdateOptionalParams): Promise<OpenIdConnectProviderCreateOrUpdateResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

opid

string

OpenID Connect 提供程序的标识符。

parameters
OpenidConnectProviderContract

创建参数。

options
OpenIdConnectProviderCreateOrUpdateOptionalParams

选项参数。

返回

Promise<OpenIdConnectProviderCreateOrUpdateResponse>

delete(string, string, string, string, OpenIdConnectProviderDeleteOptionalParams)

删除 API 管理服务实例的特定 OpenID Connect 提供程序。

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

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

opid

string

OpenID Connect 提供程序的标识符。

ifMatch

string

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

options
OpenIdConnectProviderDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, OpenIdConnectProviderGetOptionalParams)

获取没有机密的特定 OpenID Connect 提供程序。

function get(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderGetOptionalParams): Promise<OpenIdConnectProviderGetResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

opid

string

OpenID Connect 提供程序的标识符。

options
OpenIdConnectProviderGetOptionalParams

选项参数。

返回

Promise<OpenIdConnectProviderGetResponse>

getEntityTag(string, string, string, OpenIdConnectProviderGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderGetEntityTagOptionalParams): Promise<OpenIdConnectProviderGetEntityTagHeaders>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

opid

string

OpenID Connect 提供程序的标识符。

options
OpenIdConnectProviderGetEntityTagOptionalParams

选项参数。

返回

Promise<OpenIdConnectProviderGetEntityTagHeaders>

listByService(string, string, OpenIdConnectProviderListByServiceOptionalParams)

所有 OpenId Connect 提供程序的列表。

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

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

options
OpenIdConnectProviderListByServiceOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<OpenidConnectProviderContract, OpenidConnectProviderContract[], PageSettings>

listSecrets(string, string, string, OpenIdConnectProviderListSecretsOptionalParams)

获取 OpenID Connect 提供程序的客户端机密详细信息。

function listSecrets(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderListSecretsOptionalParams): Promise<OpenIdConnectProviderListSecretsResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

opid

string

OpenID Connect 提供程序的标识符。

options
OpenIdConnectProviderListSecretsOptionalParams

选项参数。

返回

Promise<OpenIdConnectProviderListSecretsResponse>

update(string, string, string, string, OpenidConnectProviderUpdateContract, OpenIdConnectProviderUpdateOptionalParams)

更新特定的 OpenID Connect 提供程序。

function update(resourceGroupName: string, serviceName: string, opid: string, ifMatch: string, parameters: OpenidConnectProviderUpdateContract, options?: OpenIdConnectProviderUpdateOptionalParams): Promise<OpenIdConnectProviderUpdateResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

opid

string

OpenID Connect 提供程序的标识符。

ifMatch

string

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

parameters
OpenidConnectProviderUpdateContract

更新参数。

options
OpenIdConnectProviderUpdateOptionalParams

选项参数。

返回

Promise<OpenIdConnectProviderUpdateResponse>