共用方式為

Set-AzApiManagementUser

  • 參考
模組:
Az.ApiManagement

設定使用者詳細數據。

語法

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

Set-AzApiManagementUser Cmdlet 會設定使用者詳細數據。

範例

範例 1：變更使用者的密碼、電子郵件地址和狀態

$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"

此命令會設定新的使用者密碼和電子郵件位址，並封鎖使用者。

範例 2

設定使用者詳細數據。 （ 自動產生 ）

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

參數

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

類型:SwitchParameter
別名:cf
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Context

指定 PsApiManagementContext 物件。 這是必要參數。

類型:PsApiManagementContext
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:IAzureContextContainer
別名:AzContext, AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Email

指定使用者的電子郵件位址。 這個參數是選擇性的。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-FirstName

指定使用者的名字。 此參數長度必須為1到100個字元。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-LastName

指定使用者的姓氏。 此參數長度必須為1到100個字元。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Note

指定使用者的相關附註。 這個參數是選擇性的。 此參數的預設值為 $null。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-PassThru

passthru

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Password

指定用戶密碼。 這個參數是選擇性的。

類型:SecureString
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-State

指定用戶狀態。 這個參數是選擇性的。 預設值為 [使用中]。

類型:PsApiManagementUserState
接受的值:Active, Blocked, Deleted, Pending
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-UserId

指定使用者識別碼。 這是必要參數。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。

類型:SwitchParameter
別名:wi
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

輸入

PsApiManagementContext

String

SecureString

PsApiManagementUserState

SwitchParameter

輸出

PsApiManagementUser