Compartilhar via

IdentityProvider interface

  • Referência
Pacote:
@azure/arm-apimanagement

Interface que representa um IdentityProvider.

Métodos

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração do IdentityProvider.
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)

Exclui a configuração do provedor de identidade especificado.
get(string, string, string, IdentityProviderGetOptionalParams)

Obtém os detalhes de configuração do Provedor de identidade configurado na instância de serviço especificada.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do identityProvider especificado por seu identificador.
listByService(string, string, IdentityProviderListByServiceOptionalParams)

Lista uma coleção de provedor de identidade configurada na instância de serviço especificada.
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Obtém os detalhes do segredo do cliente do Provedor de Identidade.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)

Atualizações uma configuração do IdentityProvider existente.

Detalhes do método

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração do 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 diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

identityProviderName

string

Identificador de tipo de provedor de identidade.

parameters
IdentityProviderCreateContract

Criar parâmetros.

options
IdentityProviderCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<IdentityProviderCreateOrUpdateResponse>

delete(string, string, string, string, IdentityProviderDeleteOptionalParams)

Exclui a configuração do provedor de identidade especificado.

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 diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

identityProviderName

string

Identificador de tipo de provedor de identidade.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

options
IdentityProviderDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Obtém os detalhes de configuração do Provedor 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 diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

identityProviderName

string

Identificador de tipo de provedor de identidade.

options
IdentityProviderGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do identityProvider especificado por seu 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 diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

identityProviderName

string

Identificador de tipo de provedor de identidade.

options
IdentityProviderGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Lista uma coleção de provedor 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 diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options
IdentityProviderListByServiceOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Obtém os detalhes do segredo do cliente do Provedor 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 diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

identityProviderName

string

Identificador de tipo de provedor de identidade.

options
IdentityProviderListSecretsOptionalParams

Os parâmetros de opções.

Retornos

Promise<IdentityProviderListSecretsResponse>

update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)

Atualizações uma configuração do 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 diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

identityProviderName

string

Identificador de tipo de provedor de identidade.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters
IdentityProviderUpdateParameters

Atualizar parâmetros.

options
IdentityProviderUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<IdentityProviderUpdateResponse>