User interface
Interface que representa um Utilizador.
Métodos
Detalhes de Método
beginDelete(string, string, string, string, UserDeleteOptionalParams)
Exclui usuário específico.
function beginDelete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>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 do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- options
- UserDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>
beginDeleteAndWait(string, string, string, string, UserDeleteOptionalParams)
Exclui usuário específico.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<UserDeleteHeaders>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 do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- options
- UserDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserDeleteHeaders>
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 do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- parameters
- UserCreateParameters
Crie ou atualize parâmetros.
- options
- UserCreateOrUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserCreateOrUpdateResponse>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Recupera uma URL de redirecionamento contendo 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 do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- options
- UserGenerateSsoUrlOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GenerateSsoUrlResult>
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 do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- options
- UserGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Obtém a versão do 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 do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- options
- UserGetEntityTagOptionalParams
Os parâmetros de opções.
Devoluções
Promise<UserGetEntityTagHeaders>
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 do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- parameters
- UserTokenParameters
Crie parâmetros do Token de Autorização.
Os parâmetros de opções.
Devoluções
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.
Devoluções
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 do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do 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.
Devoluções
Promise<UserUpdateResponse>