New-AzureDeployment
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
New-AzureDeployment
Creates a new deployment from a service comprising web roles and worker roles.
Parameter Set: PaaS
New-AzureDeployment [-ServiceName] <String> [-Package] <String> [-Configuration] <String> [-Slot] <String> [[-Label] <String> ] [[-Name] <String> ] [-DoNotStart] [-ExtensionConfiguration <ExtensionConfigurationInput[]> ] [-TreatWarningsAsError] [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
The New-AzureDeployment cmdlet creates a new deployment based on package files (.cspkg) and a service configuration files (.cscfg). Use the New-AzureVM cmdlet to create a new deployment based on Windows Azure virtual machines.
There should not be an existing deployment with the same name nor in the same deployment environment when executing this command. If there is, the command will fail.
-Configuration<String>
Specifies the path and file name of a service configuration file (.cscfg).
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DoNotStart
Specifies that the new deployment will not be started when it is created.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ExtensionConfiguration<ExtensionConfigurationInput[]>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Label<String>
Specifies the label name for the new deployment. If not specified, a Globally Unique Identifier (GUID) is used.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
The same as Name |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the deployment name. If not specified, a Global Unique Identifier is used.
Aliases |
DeploymentName |
Required? |
false |
Position? |
6 |
Default Value |
Guid |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Package<String>
Specifies the path or URI to a .cspkg blob in a storage within the same subscription/project.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceName<String>
Specifies Windows Azure service name for the deployment.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Slot<String>
Specifies the environment where the deployment is created. Acceptable values are Staging or Production. If not specified, Production is used.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
Production |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-TreatWarningsAsError
Causes warning messages to be treated as errors, resulting in the deployment failing on warnings.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
-------------- Example 1 --------------
This example creates a new deployment based on a package location and a configuration path.
PS C:\> New-AzureDeployment -ServiceName "myservice" -Slot "Production" -Package "https://mystorage.blob.core.windows.net/mycontainer/MyPackage.cspkg" -Configuration "c:\packages\mypackage.cscfg" -Label "MyDeployment"