User interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa un usuario.

Métodos

createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)	Crea o actualiza un usuario.
delete(string, string, string, string, UserDeleteOptionalParams)	Elimina un usuario específico.
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)	Recupera una dirección URL de redireccionamiento que contiene un token de autenticación para firmar un usuario determinado en el portal para desarrolladores.
get(string, string, string, UserGetOptionalParams)	Obtiene los detalles del usuario especificado por su identificador.
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)	Obtiene la versión de estado de entidad (Etag) del usuario especificado por su identificador.
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)	Obtiene el token de autorización de acceso compartido para el usuario.
listByService(string, string, UserListByServiceOptionalParams)	Enumera una colección de usuarios registrados en la instancia de servicio especificada.
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)	Actualiza los detalles del usuario especificado por su identificador.

Detalles del método

createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)

Crea o actualiza un usuario.

function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>

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.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

parameters

UserCreateParameters

Crear o actualizar parámetros.

options

UserCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<UserCreateOrUpdateResponse>

delete(string, string, string, string, UserDeleteOptionalParams)

Elimina un usuario específico.

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

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

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

UserDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)

Recupera una dirección URL de redireccionamiento que contiene un token de autenticación para firmar un usuario determinado en el portal para desarrolladores.

function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>

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.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

options

UserGenerateSsoUrlOptionalParams

Parámetros de opciones.

Devoluciones

Promise<GenerateSsoUrlResult>

get(string, string, string, UserGetOptionalParams)

Obtiene los detalles del usuario especificado por su identificador.

function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>

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.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

options

UserGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<UserGetResponse>

getEntityTag(string, string, string, UserGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>

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.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

options

UserGetEntityTagOptionalParams

Parámetros de opciones.

Devoluciones

Promise<UserGetEntityTagHeaders>

getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)

Obtiene el token de autorización de acceso compartido para el usuario.

function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>

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.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

parameters

UserTokenParameters

Cree parámetros de token de autorización.

options

UserGetSharedAccessTokenOptionalParams

Parámetros de opciones.

Devoluciones

Promise<UserTokenResult>

listByService(string, string, UserListByServiceOptionalParams)

Enumera una colección de usuarios registrados en la instancia de servicio especificada.

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

UserListByServiceOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>

update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)

Actualiza los detalles del usuario especificado por su identificador.

function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>

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.

userId

string

Identificador de usuario. Debe ser único en la instancia actual del servicio API Management.

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

UserUpdateParameters

Actualice los parámetros.

options

UserUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<UserUpdateResponse>