Remove-AzureRmApiManagementSubscription

NAME Remove-AzureRmApiManagementSubscription



SYNOPSIS

Deletes an existing subscription.





SYNTAX

Remove-AzureRmApiManagementSubscription -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-PassThru] -SubscriptionId

<String> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-AzureRmApiManagementSubscription cmdlet deletes an existing subscription.





PARAMETERS

-Context <PsApiManagementContext>

Specifies a PsApiManagementContext object.



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



-PassThru [<SwitchParameter>]

Indicates that this cmdlet returns a value of $True, 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



-SubscriptionId <String>

Specifies the subscription ID.



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 subscription



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Remove-AzureRmApiManagementSubscription -Context $apimContext -SubscriptionId "0123456789" -Force



This command deletes an existing subscription.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... bscription

Get-AzureRmApiManagementSubscription

New-AzureRmApiManagementSubscription

Set-AzureRmApiManagementSubscription