AuthorizationServer interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa un authorizationServer.

Métodos

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)	Crea un nuevo servidor de autorización o actualiza un servidor de autorización existente.
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)	Elimina una instancia específica del servidor de autorización.
get(string, string, string, AuthorizationServerGetOptionalParams)	Obtiene los detalles del servidor de autorización especificado por su identificador.
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)	Obtiene la versión de estado de entidad (Etag) del authorizationServer especificado por su identificador.
listByService(string, string, AuthorizationServerListByServiceOptionalParams)	Enumera una colección de servidores de autorización definidos dentro de una instancia de servicio.
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)	Obtiene los detalles del secreto de cliente del servidor de autorización.
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)	Actualiza los detalles del servidor de autorización especificado por su identificador.

Detalles del método

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)

Crea un nuevo servidor de autorización o actualiza un servidor de autorización existente.

function createOrUpdate(resourceGroupName: string, serviceName: string, authsid: string, parameters: AuthorizationServerContract, options?: AuthorizationServerCreateOrUpdateOptionalParams): Promise<AuthorizationServerCreateOrUpdateResponse>

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.

authsid

string

Identificador del servidor de autorización.

parameters

AuthorizationServerContract

Crear o actualizar parámetros.

options

AuthorizationServerCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<AuthorizationServerCreateOrUpdateResponse>

delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)

Elimina una instancia específica del servidor de autorización.

function delete(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, options?: AuthorizationServerDeleteOptionalParams): 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.

authsid

string

Identificador del servidor de autorización.

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

AuthorizationServerDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, string, AuthorizationServerGetOptionalParams)

Obtiene los detalles del servidor de autorización especificado por su identificador.

function get(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetOptionalParams): Promise<AuthorizationServerGetResponse>

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.

authsid

string

Identificador del servidor de autorización.

options

AuthorizationServerGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<AuthorizationServerGetResponse>

getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetEntityTagOptionalParams): Promise<AuthorizationServerGetEntityTagHeaders>

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.

authsid

string

Identificador del servidor de autorización.

options

AuthorizationServerGetEntityTagOptionalParams

Parámetros de opciones.

Devoluciones

Promise<AuthorizationServerGetEntityTagHeaders>

listByService(string, string, AuthorizationServerListByServiceOptionalParams)

Enumera una colección de servidores de autorización definidos dentro de una instancia de servicio.

function listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationServerListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], 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.

options

AuthorizationServerListByServiceOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)

Obtiene los detalles del secreto de cliente del servidor de autorización.

function listSecrets(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerListSecretsOptionalParams): Promise<AuthorizationServerListSecretsResponse>

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.

authsid

string

Identificador del servidor de autorización.

options

AuthorizationServerListSecretsOptionalParams

Parámetros de opciones.

Devoluciones

Promise<AuthorizationServerListSecretsResponse>

update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)

Actualiza los detalles del servidor de autorización especificado por su identificador.

function update(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, parameters: AuthorizationServerUpdateContract, options?: AuthorizationServerUpdateOptionalParams): Promise<AuthorizationServerUpdateResponse>

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.

authsid

string

Identificador del servidor de autorización.

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

AuthorizationServerUpdateContract

Configuración del servidor OAuth2 Actualizar parámetros.

options

AuthorizationServerUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<AuthorizationServerUpdateResponse>