Share via


Remove-AzureDeployment

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Remove-AzureDeployment

Deletes the specified deployment of an Azure service.

Syntax

Parameter Set: Default
Remove-AzureDeployment [-ServiceName] <String> [-Slot] <String> [-Force] [ <CommonParameters>]

Detailed Description

This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.

The Remove-AzureDeployment cmdlet deletes the specified deployment of an Azure cloud service. The deployment should be in the suspended state.

Parameters

-Force

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServiceName<String>

Specifies the name of the service whose deployment will be deleted.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Slot<String>

Specifies the deployment environment from which the deployment of the specified Azure service will be deleted. Choices are Staging or Production. If no slot is specified, the production environment is assumed.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • ManagementOperationContext

Examples

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

This command removes the deployment of the Azure service "myservice" from the production environment.

C:\PS>Remove-AzureDeployment -ServiceName "myservice" 

Get-AzureDeployment

Move-AzureDeployment

New-AzureDeployment

Set-AzureDeployment