Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-AzureApiManagement

Remove-AzureApiManagement

microsoft.azure.commands.apimanagement.dll

Synopsis

Removes existing API Management.

Syntax

Remove-AzureApiManagement [-ResourceGroupName] [-Name] [-PassThru] [-Force] [-Profile] [<CommonParameters>]

Detailed Description

Remove-AzureApiManagement cmdlet removes existing API Management service.

Parameters

-ResourceGroupName <String>

Name of resource group under which API Management service exists.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Name of API Management service.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Writes true to the pipeline if operation succeeds.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Do not confirm on the removal of the API Management service.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <AzureProfile>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

Remove API Management service.

PS C:\> Remove-AzureApiManagement –ResourceGroupName ContosoGroup –Name ContosoApi