Partilhar via

Set-AzApiManagementUser

  • Referência
Módulo:
Az.ApiManagement

Define os detalhes do usuário.

Syntax

Set-AzApiManagementUser
   -Context <PsApiManagementContext>
   -UserId <String>
   [-FirstName <String>]
   [-LastName <String>]
   [-Email <String>]
   [-Password <SecureString>]
   [-State <PsApiManagementUserState>]
   [-Note <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet Set-AzApiManagementUser define os detalhes do usuário.

Exemplos

Exemplo 1: Alterar a palavra-passe, o endereço de e-mail e o estado de um utilizador

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force
Set-AzApiManagementUser -Context $apimContext -UserId "0123456789" -Email "patti.fuller@contoso.com" -Password $securePassword -State "Blocked"

Este comando define uma nova senha de usuário e endereço de e-mail e bloqueia o usuário.

Exemplo 2

Define os detalhes do usuário. (gerado automaticamente)

Set-AzApiManagementUser -Context <PsApiManagementContext> -Email 'patti.fuller@contoso.com' -FirstName 'Patti' -LastName 'Fuller' -Password <SecureString> -State Active -UserId '0123456789'

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Especifica um objeto PsApiManagementContext . Este parâmetro é obrigatório.

Tipo:PsApiManagementContext
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Email

Especifica o endereço de e-mail do usuário. Este parâmetro é opcional.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-FirstName

Especifica o nome do usuário. Este parâmetro deve ter de 1 a 100 caracteres.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-LastName

Especifica o sobrenome do usuário. Este parâmetro deve ter de 1 a 100 caracteres.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-Note

Especifica uma nota sobre o usuário. Este parâmetro é opcional. O valor padrão desse parâmetro é $null.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Passthru

Tipo:SwitchParameter
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-Password

Especifica a senha do usuário. Este parâmetro é opcional.

Tipo:SecureString
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-State

Especifica o estado do usuário. Este parâmetro é opcional. O valor padrão é Ative.

Tipo:PsApiManagementUserState
valores aceites:Active, Blocked, Deleted, Pending
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-UserId

Especifica o ID do usuário. Este parâmetro é obrigatório.

Tipo:String
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PsApiManagementContext

String

SecureString

PsApiManagementUserState

SwitchParameter

Saídas

PsApiManagementUser