你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
IdentityProvider interface
表示 IdentityProvider 的接口。
方法
| create |
创建或更新 IdentityProvider 配置。 |
| delete(string, string, string, string, Identity |
删除指定的标识提供者配置。 |
| get(string, string, string, Identity |
获取在指定服务实例中配置的标识提供者的配置详细信息。 |
| get |
获取实体状态 (Etag) 由其标识符指定的 identityProvider 版本。 |
| list |
列出在指定服务实例中配置的标识提供者集合。 |
| list |
获取标识提供者的客户端机密详细信息。 |
| update(string, string, string, string, Identity |
汇报现有的 IdentityProvider 配置。 |
方法详细信息
createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)
创建或更新 IdentityProvider 配置。
function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- identityProviderName
-
string
标识提供者类型标识符。
- parameters
- IdentityProviderCreateContract
创建参数。
选项参数。
返回
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)
删除指定的标识提供者配置。
function delete(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- identityProviderName
-
string
标识提供者类型标识符。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
选项参数。
返回
Promise<void>
get(string, string, string, IdentityProviderGetOptionalParams)
获取在指定服务实例中配置的标识提供者的配置详细信息。
function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- identityProviderName
-
string
标识提供者类型标识符。
选项参数。
返回
Promise<IdentityProviderGetResponse>
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)
获取实体状态 (Etag) 由其标识符指定的 identityProvider 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- identityProviderName
-
string
标识提供者类型标识符。
选项参数。
返回
Promise<IdentityProviderGetEntityTagHeaders>
listByService(string, string, IdentityProviderListByServiceOptionalParams)
列出在指定服务实例中配置的标识提供者集合。
function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)
获取标识提供者的客户端机密详细信息。
function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- identityProviderName
-
string
标识提供者类型标识符。
选项参数。
返回
Promise<IdentityProviderListSecretsResponse>
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)
汇报现有的 IdentityProvider 配置。
function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- identityProviderName
-
string
标识提供者类型标识符。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
- parameters
- IdentityProviderUpdateParameters
更新参数。
选项参数。
返回
Promise<IdentityProviderUpdateResponse>