< Back
Remove-AzureRmApiManagementUser
Post
NAME Remove-AzureRmApiManagementUser
SYNOPSIS
Deletes an existing user.
SYNTAX
Remove-AzureRmApiManagementUser -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-DeleteSubscriptions] [-PassThru]
-UserId <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmApiManagementUser cmdlet deletes an existing user.
PARAMETERS
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DeleteSubscriptions [<SwitchParameter>]
Indicates whether to delete subscriptions to the product. If this parameter is not specified and a subscription exists, this cmdlet throws an
exception. This parameter is optional.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a value of $Ture, if it succeeds, or a value of $False, otherwise.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UserId <String>
Specifies the ID of the user to remove.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Boolean
NOTES
Example 1: Delete a user
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Remove-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -Force
This command deletes an existing user.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... gementuser
Get-AzureRmApiManagementUser
New-AzureRmApiManagementUser
Set-AzureRmApiManagementUser
SYNOPSIS
Deletes an existing user.
SYNTAX
Remove-AzureRmApiManagementUser -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-DeleteSubscriptions] [-PassThru]
-UserId <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmApiManagementUser cmdlet deletes an existing user.
PARAMETERS
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DeleteSubscriptions [<SwitchParameter>]
Indicates whether to delete subscriptions to the product. If this parameter is not specified and a subscription exists, this cmdlet throws an
exception. This parameter is optional.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a value of $Ture, if it succeeds, or a value of $False, otherwise.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UserId <String>
Specifies the ID of the user to remove.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Boolean
NOTES
Example 1: Delete a user
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Remove-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -Force
This command deletes an existing user.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... gementuser
Get-AzureRmApiManagementUser
New-AzureRmApiManagementUser
Set-AzureRmApiManagementUser