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>]

Описание

Командлет Set-AzApiManagementUser задает сведения о пользователе.

Примеры

Пример 1. Изменение пароля пользователя, адреса электронной почты и состояния

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

Эта команда задает новый пароль пользователя и адрес электронной почты и блокирует пользователя.

Пример 2

Задает сведения о пользователе. (автоматическое создание)

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

Параметры

-Confirm

Запрос подтверждения перед выполнением командлета.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Указывает объект PsApiManagementContext . Этот параметр является обязательным.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Email

Указывает адрес электронной почты пользователя. Это необязательный параметр.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-FirstName

Указывает имя пользователя. Этот параметр должен содержать от 1 до 100 символов.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LastName

Указывает фамилию пользователя. Этот параметр должен содержать от 1 до 100 символов.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Note

Указывает примечание о пользователе. Это необязательный параметр. Значение по умолчанию этого параметра — $null.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

passthru

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Password

Указывает пароль пользователя. Это необязательный параметр.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-State

Указывает состояние пользователя. Это необязательный параметр. Значение по умолчанию — "Активный".

Type:PsApiManagementUserState
Accepted values:Active, Blocked, Deleted, Pending
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserId

Указывает идентификатор пользователя. Этот параметр является обязательным.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Входные данные

PsApiManagementContext

String

SecureString

PsApiManagementUserState

SwitchParameter

Выходные данные

PsApiManagementUser