IdentityProvider interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa un identityProvider.

Métodos

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)	Crea o actualiza la configuración del proveedor de identidades
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)	Elimina la configuración del proveedor de identidades especificado.
get(string, string, string, IdentityProviderGetOptionalParams)	Obtiene los detalles de configuración del proveedor de identidades configurado en la instancia de servicio especificada.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)	Obtiene la versión del estado de entidad (Etag) del identityProvider especificado por su identificador.
listByService(string, string, IdentityProviderListByServiceOptionalParams)	Enumera una colección de los proveedores de identidades configurados en la instancia de servicio especificada
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)	Obtiene los detalles del secreto de cliente del proveedor de identidades.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)	Novedades una configuración de IdentityProvider existente.

Detalles del método

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

Crea o actualiza la configuración del proveedor de identidades

function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

identityProviderName

string

Identificador del tipo de proveedor de identidades.

parameters

IdentityProviderCreateContract

Crear parámetros.

options

IdentityProviderCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<IdentityProviderCreateOrUpdateResponse>

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

Elimina la configuración del proveedor de identidades especificado.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

identityProviderName

string

Identificador del tipo de proveedor de identidades.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

options

IdentityProviderDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Obtiene los detalles de configuración del proveedor de identidades configurado en la instancia de servicio especificada.

function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

identityProviderName

string

Identificador del tipo de proveedor de identidades.

options

IdentityProviderGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Obtiene la versión del estado de entidad (Etag) del identityProvider especificado por su identificador.

function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

identityProviderName

string

Identificador del tipo de proveedor de identidades.

options

IdentityProviderGetEntityTagOptionalParams

Parámetros de opciones.

Devoluciones

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Enumera una colección de los proveedores de identidades configurados en la instancia de servicio especificada

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

IdentityProviderListByServiceOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Obtiene los detalles del secreto de cliente del proveedor de identidades.

function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

identityProviderName

string

Identificador del tipo de proveedor de identidades.

options

IdentityProviderListSecretsOptionalParams

Parámetros de opciones.

Devoluciones

Promise<IdentityProviderListSecretsResponse>

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

Novedades una configuración de IdentityProvider existente.

function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

identityProviderName

string

Identificador del tipo de proveedor de identidades.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

parameters

IdentityProviderUpdateParameters

Actualizar parámetros.

options

IdentityProviderUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<IdentityProviderUpdateResponse>