Edit

AzureCloudPowerShellDeployment@2 - Azure Cloud Service deployment v2 task

  • Article

Deploy an Azure Cloud Service.

Syntax

# Azure Cloud Service deployment v2
# Deploy an Azure Cloud Service.
- task: AzureCloudPowerShellDeployment@2
  inputs:
    ARMConnectedServiceName: # string. Required. Azure subscription (ARM). 
    ResourceGroupName: # string. Required. Resource group. 
    ARMStorageAccount: # string. Required. Storage account (ARM). 
    ServiceName: # string. Required. Service name. 
    ServiceLocation: # string. Required. Service location. 
    CsCfg: # string. Required. CsCfg. 
    CsDef: # string. Required. CsDef. 
    CsPkg: # string. Required. CsPkg. 
    #KeyVault: # string. Azure KeyVault. 
    #DeploymentLabel: '$(Build.BuildNumber)' # string. Deployment label. Default: $(Build.BuildNumber).
    #AppendDateTimeToLabel: false # boolean. Append current date and time. Default: false.
    #UpgradeMode: 'Auto' # string. Update mode for the cloud service. Default: Auto.
    #AllowUpgrade: true # boolean. Allow upgrade. Default: true.
    #VerifyRoleInstanceStatus: false # boolean. Verify role instance status. Default: false.
  # Advanced Options For Creating New Service
    #DiagnosticStorageAccountKeys: # string. Diagnostic storage account keys.

Inputs

ARMConnectedServiceName - Azure subscription (ARM)
string. Required.

Azure Resource Manager subscription.


ResourceGroupName - Resource group
string. Required.

Enter or Select the Azure Resource Group that contains the Azure App Service specified above.


ARMStorageAccount - Storage account (ARM)
string. Required.

A pre-existing ARM storage account.


ServiceName - Service name
string. Required.

An existing cloud service name.


ServiceLocation - Service location
string. Required.

A region for new service deployment. Options include: East US, East US 2, Central US, South Central US, West US, North Europe, West Europe, and others.


CsCfg - CsCfg
string. Required.

The CsCfg path in the default artifact directory.


CsDef - CsDef
string. Required.

Path of CsDef under the default artifact directory.


CsPkg - CsPkg
string. Required.

Path to the CsPkg in the default artifact directory.


KeyVault - Azure KeyVault
string.

Choose a pre-existing Azure KeyVault with certificates.


DeploymentLabel - Deployment label
string. Default value: $(Build.BuildNumber).

Specifies the label name for the new deployment. If not specified, defaults to a Globally Unique Identifier (GUID).


AppendDateTimeToLabel - Append current date and time
boolean. Default value: false.

Appends current date and time to the deployment label.


UpgradeMode - Update mode for the cloud service
string. Default value: Auto.

Auto, Manual or Simultaneous.


AllowUpgrade - Allow upgrade
boolean. Default value: true.

Allows an upgrade to the Microsoft Azure deployment.


VerifyRoleInstanceStatus - Verify role instance status
boolean. Default value: false.

Causes the task to wait until role instances are in the ready state.


DiagnosticStorageAccountKeys - Diagnostic storage account keys
string.

Format storage key string as Role:Storagekey. The diagnostics storage account name for each role is retrieved from the diagnostic config file (.wadcfgx).

  • If the .wadcfgx file for a role is not found: The diagnostic extension isn't set for that role.
  • If the storage account name is not found in the .wadcfgx file: The default storage account is used for storing diagnostic results, and storage key parameters from the deployment task is ignored.

If there is sensitive information in the diagnostic results for your environment, save the storage_account_key as a secret variable. For example:

  • WebRole: WebRole_storage_account_key
  • WorkerRole: WorkerRole_stoarge_account_key

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Requirements

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent
Demands Self-hosted agents must have capabilities that match the following demands to run jobs that use this task: azureps
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 1.103.0 or greater
Task category Deploy