Remove-AzApiManagementUser

  • Referenz
Modul:
Az.ApiManagement

Löscht einen vorhandenen Benutzer.

Syntax

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

Beschreibung

Das Cmdlet Remove-AzApiManagementUser löscht einen vorhandenen Benutzer.

Beispiele

Beispiel 1: Löschen eines Benutzers

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

Mit diesem Befehl wird ein vorhandener Benutzer gelöscht.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-Context

Gibt ein PsApiManagementContext -Objekt an. Dieser Parameter ist erforderlich.

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

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

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

-DeleteSubscriptions

Gibt an, ob Abonnements für das Produkt gelöscht werden sollen. Wenn dieser Parameter nicht angegeben ist und ein Abonnement vorhanden ist, löst dieses Cmdlet eine Ausnahme aus. Dieser Parameter ist optional.

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

-PassThru

Gibt an, dass dieses Cmdlet einen Wert von $Ture zurückgibt, wenn es erfolgreich ist, oder einen Wert von $False andernfalls.

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

-UserId

Gibt die ID des zu entfernenden Benutzers an.

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

PsApiManagementContext

String

SwitchParameter

Ausgaben

Boolean