IdentityProvider interface
Interfaz que representa un IdentityProvider.
Métodos
Detalles del método
createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)
Crea o actualiza la configuración de IdentityProvider.
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 no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- identityProviderName
-
string
Identificador de tipo de proveedor de identidades.
- parameters
- IdentityProviderCreateContract
Cree parámetros.
Parámetros de opciones.
Devoluciones
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)
Elimina la configuración del proveedor de identidades especificada.
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 no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- identityProviderName
-
string
Identificador de 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.
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 no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- identityProviderName
-
string
Identificador de tipo de proveedor de identidades.
Parámetros de opciones.
Devoluciones
Promise<IdentityProviderGetResponse>
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)
Obtiene la versión de 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 no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- identityProviderName
-
string
Identificador de tipo de proveedor de identidades.
Parámetros de opciones.
Devoluciones
Promise<IdentityProviderGetEntityTagHeaders>
listByService(string, string, IdentityProviderListByServiceOptionalParams)
Enumera una colección de proveedor de identidades configurado 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 no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
Parámetros de opciones.
Devoluciones
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 no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- identityProviderName
-
string
Identificador de tipo de proveedor de identidades.
Parámetros de opciones.
Devoluciones
Promise<IdentityProviderListSecretsResponse>
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)
Actualiza 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 no distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- identityProviderName
-
string
Identificador de 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
Actualice los parámetros.
Parámetros de opciones.
Devoluciones
Promise<IdentityProviderUpdateResponse>