IdentityProvider interface
Interface que representa um IdentityProvider.
Métodos
Detalhes de Método
createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)
Cria ou Atualizações a configuração IdentityProvider.
function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- identityProviderName
-
string
Identificador do Tipo de Fornecedor de Identidade.
- parameters
- IdentityProviderCreateContract
Criar parâmetros.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)
Elimina a configuração do fornecedor de identidade especificada.
function delete(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- identityProviderName
-
string
Identificador do Tipo de Fornecedor de Identidade.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, IdentityProviderGetOptionalParams)
Obtém os detalhes de configuração do Fornecedor de identidade configurado na instância de serviço especificada.
function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- identityProviderName
-
string
Identificador do Tipo de Fornecedor de Identidade.
Os parâmetros de opções.
Devoluções
Promise<IdentityProviderGetResponse>
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do identityProvider especificado pelo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- identityProviderName
-
string
Identificador do Tipo de Fornecedor de Identidade.
Os parâmetros de opções.
Devoluções
Promise<IdentityProviderGetEntityTagHeaders>
listByService(string, string, IdentityProviderListByServiceOptionalParams)
Lista uma coleção do Fornecedor de Identidade configurada na instância de serviço especificada.
function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
Os parâmetros de opções.
Devoluções
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)
Obtém os detalhes do segredo do cliente do Fornecedor de Identidade.
function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- identityProviderName
-
string
Identificador do Tipo de Fornecedor de Identidade.
Os parâmetros de opções.
Devoluções
Promise<IdentityProviderListSecretsResponse>
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)
Atualizações uma configuração IdentityProvider existente.
function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- identityProviderName
-
string
Identificador do Tipo de Fornecedor de Identidade.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- IdentityProviderUpdateParameters
Atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<IdentityProviderUpdateResponse>