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
 

Set-AzureDeployment

Set-AzureDeployment

microsoft.windowsazure.commands.servicemanagement.dll

Synopsis

Sets status, upgrade mode, and configuration settings of a Microsoft Azure deployment.

Syntax

Set-AzureDeployment [-Upgrade] [-ServiceName] [-Package] [-Configuration] [-Slot] [-Mode] [-Label] [-RoleName] [-Force] [-ExtensionConfiguration] [<CommonParameters>]

Set-AzureDeployment [-Config] [-ServiceName] [-Configuration] [-Slot] [-ExtensionConfiguration] [<CommonParameters>]

Set-AzureDeployment [-Status] [-ServiceName] [-Slot] [-NewStatus] [<CommonParameters>]

Detailed Description

The Set-AzureDeployment cmdlet sets the status, configuration settings, or upgrade mode of a Microsoft Azure deployment. With the -Status parameter, you can change the status of the deployment to either "Running" or "Suspended". With the -Config parameter, you can update the .cscfg file, and with the -Upgrade parameter, you set the upgrade mode and update configuration files. Use the Set-AzureWalkUpgradeDomain cmdlet to actually initiate the upgrade.

Parameters

-Upgrade <SwitchParameter>

When specified, requests an upgrade to the Microsoft Azure deployment.

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ServiceName <String>

Specifies the Microsoft Azure service name of the deployment.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Package <String>

Specifies the full path to the upgrade package (.cspkg) file.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Configuration <String>

Specifies the path to the new configuration (.cscfg) file when performing an upgrade or configuration change.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Slot <String>

Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Mode <String>

Specifies the mode of upgrade. Supported values are: "Auto", "Manual", and "Simultaneous".

Aliases

None

Required?

false

Position

5

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Label <String>

Specifies a new label for the upgraded deployment.

Aliases

None

Required?

false

Position

6

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RoleName <String>

Specifies the name of the role to upgrade.

Aliases

None

Required?

false

Position

7

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

When specified, sets the upgrade to a forced upgrade.

Aliases

None

Required?

false

Position

8

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ExtensionConfiguration <ExtensionConfigurationInput[]>

When specified, requests an upgrade to the Microsoft Azure deployment.

Aliases

None

Required?

false

Position

9

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Config <SwitchParameter>

When specified, modifies the .cscfg file for the deployment.

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Status <SwitchParameter>

When specified, requests a status change for the Microsoft Azure deployment.

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NewStatus <String>

Specifies the target status for the deployment. Supported values are "Running" or "Suspended".

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

PS C:\> Set-AzureDeployment -Status -ServiceName "MySvc1" -Slot "Production" -NewStatus "Running"

-------------------------- EXAMPLE 2 --------------------------

Description

PS C:\> Set-AzureDeployment -Config -ServiceName "MySvc1" -Slot "Staging" -Configuration "C:\Temp\MyServiceConfig.Cloud.csfg"

-------------------------- EXAMPLE 3 --------------------------

Description

PS C:\> Set-AzureDeployment -Upgrade -ServiceName "MySvc1" -Mode Auto -Package "C:\Temp\MyApp.cspkg" -Configuration "C:\Temp\MyServiceConfig.Cloud.csfg"

-------------------------- EXAMPLE 4 --------------------------

Description

PS C:\> Set-AzureDeployment –ServiceName –Mode Automatic $svc -Package $pkg -Configuration $cnfg -Slot Production -ExtensionConfiguration $wadConfig

Get-AzureDeployment
Move-AzureDeployment
New-AzureDeployment
Remove-AzureDeployment