Compartilhar via


User interface

Interface que representa um usuário.

Métodos

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

Cria ou atualiza um usuário.

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

Exclui um usuário específico.

generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)

Recupera uma URL de redirecionamento que contém um token de autenticação para assinar um determinado usuário no portal do desenvolvedor.

get(string, string, string, UserGetOptionalParams)

Obtém os detalhes do usuário especificado por seu identificador.

getEntityTag(string, string, string, UserGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do usuário especificado por seu identificador.

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

Obtém o Token de Autorização de Acesso Compartilhado para o Usuário.

listByService(string, string, UserListByServiceOptionalParams)

Lista uma coleção de usuários registrados na instância de serviço especificada.

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

Atualiza os detalhes do usuário especificado por seu identificador.

Detalhes do método

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

Cria ou atualiza um usuário.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

userId

string

Identificador de usuário. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

parameters
UserCreateParameters

Criar ou atualizar parâmetros.

options
UserCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

Exclui um usuário específico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

userId

string

Identificador de usuário. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

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
UserDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)

Recupera uma URL de redirecionamento que contém um token de autenticação para assinar um determinado usuário no portal do desenvolvedor.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

userId

string

Identificador de usuário. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

options
UserGenerateSsoUrlOptionalParams

Os parâmetros de opções.

Retornos

get(string, string, string, UserGetOptionalParams)

Obtém os detalhes do usuário especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

userId

string

Identificador de usuário. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

options
UserGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<UserGetResponse>

getEntityTag(string, string, string, UserGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do usuário especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

userId

string

Identificador de usuário. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

options
UserGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

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

Obtém o Token de Autorização de Acesso Compartilhado para o Usuário.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

userId

string

Identificador de usuário. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

parameters
UserTokenParameters

Criar parâmetros de Token de Autorização.

options
UserGetSharedAccessTokenOptionalParams

Os parâmetros de opções.

Retornos

Promise<UserTokenResult>

listByService(string, string, UserListByServiceOptionalParams)

Lista uma coleção de usuários registrados na instância de serviço especificada.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

options
UserListByServiceOptionalParams

Os parâmetros de opções.

Retornos

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

Atualiza os detalhes do usuário especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

userId

string

Identificador de usuário. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

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
UserUpdateParameters

Atualizar parâmetros.

options
UserUpdateOptionalParams

Os parâmetros de opções.

Retornos