通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Remove-AzApiManagementUser

  • 参考
模块:
Az.ApiManagement

删除现有用户。

语法

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

说明

Remove-AzApiManagementUser cmdlet 删除现有用户。

示例

示例 1：删除用户

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

此命令将删除现有用户。

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Context

指定 PsApiManagementContext 对象。 此参数是必需的。

类型:PsApiManagementContext
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DeleteSubscriptions

指示是否删除产品的订阅。 如果未指定此参数并且存在订阅，则此 cmdlet 将引发异常。 此参数是可选的。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-PassThru

指示此 cmdlet 返回一个值为 $Ture（如果成功）或$False的值，否则返回一个值。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-UserId

指定要删除的用户的 ID。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

输入

PsApiManagementContext

String

SwitchParameter

输出

Boolean