Поделиться через

Remove-AzApiManagementUser

  • Ссылка
Модуль:
Az.ApiManagement

Удаляет существующего пользователя.

Синтаксис

Remove-AzApiManagementUser
      -Context <PsApiManagementContext>
      -UserId <String>
      [-DeleteSubscriptions]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Описание

Командлет Remove-AzApiManagementUser удаляет существующего пользователя.

Примеры

Пример 1. Удаление пользователя

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementUser -Context $apimContext -UserId "0123456789"

Эта команда удаляет существующего пользователя.

Параметры

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Context

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

Тип:PsApiManagementContext
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-DefaultProfile

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

Тип:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DeleteSubscriptions

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-PassThru

Указывает, что этот командлет возвращает значение $Ture, если оно успешно или значение $False, в противном случае.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-UserId

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

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-WhatIf

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

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

PsApiManagementContext

String

SwitchParameter

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

Boolean