Condividi tramite

Set-AzApiManagementUser

  • Riferimento
Modulo:
Az.ApiManagement

Imposta i dettagli dell'utente.

Sintassi

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

Descrizione

Il cmdlet Set-AzApiManagementUser imposta i dettagli utente.

Esempio

Esempio 1: Modificare la password, l'indirizzo di posta elettronica e lo stato di un utente

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

Questo comando imposta una nuova password utente e un nuovo indirizzo di posta elettronica e blocca l'utente.

Esempio 2

Imposta i dettagli dell'utente. (generato automaticamente)

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

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Alias:cf
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Context

Specifica un oggetto PsApiManagementContext . Questo parametro è obbligatorio.

Tipo:PsApiManagementContext
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Email

Specifica l'indirizzo di posta elettronica dell'utente. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-FirstName

Specifica il nome dell'utente. Questo parametro deve essere lungo da 1 a 100 caratteri.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-LastName

Specifica il cognome dell'utente. Questo parametro deve essere lungo da 1 a 100 caratteri.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Note

Specifica una nota sull'utente. Questo parametro è facoltativo. Il valore predefinito di questo parametro è $null.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-PassThru

passthru

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Password

Specifica la password utente. Questo parametro è facoltativo.

Tipo:SecureString
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-State

Specifica lo stato utente. Questo parametro è facoltativo. Il valore predefinito è Attivo.

Tipo:PsApiManagementUserState
Valori accettati:Active, Blocked, Deleted, Pending
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-UserId

Specifica l'ID utente. Questo parametro è obbligatorio.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-WhatIf

Mostra cosa accadrebbe se il cmdlet viene eseguito. Il cmdlet non viene eseguito.

Tipo:SwitchParameter
Alias:wi
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

PsApiManagementContext

String

SecureString

PsApiManagementUserState

SwitchParameter

Output

PsApiManagementUser