Remove-AzureRmApiManagement

NAME Remove-AzureRmApiManagement



SYNOPSIS

Removes an API Management service.





SYNTAX

Remove-AzureRmApiManagement [-DefaultProfile <IAzureContextContainer>] -Name <String> [-PassThru] -ResourceGroupName <String> [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Remove-AzureRmApiManagement cmdlet removes an Azure API Management service.





PARAMETERS

-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



-Name <String>

Specifies the name of the API Management deployment that this cmdlet removes.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Indicates that this cmdlet returns a value of $True if the operation succeeds.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the of resource group under which the API Management deployment exists.



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

System.Boolean







NOTES









Example 1: Remove an API Management service



PS C:\\>Remove-AzureRmApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi"



This command removes the API Management service named ContosoApi.







RELATED LINKS

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

Backup-AzureRmApiManagement

Get-AzureRmApiManagement

New-AzureRmApiManagement

Restore-AzureRmApiManagement