Add-AzureWorkerRole

  • Reference
Module:
Azure

Creates required files and configuration for a custom worker role.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Add-AzureWorkerRole
   [-TemplateFolder <String>]
   [-Name <String>]
   [-Instances <Int32>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

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 Add-AzureWorkerRole cmdlet creates required files and configuration, sometimes referred to as scaffolding, for a custom worker role.

Examples

Example 1: Create a single instance worker role

PS C:\> Add-AzureWorkerRole -Name MyWorkerRole

This example adds scaffolding for a single worker role named MyWorkerRole to the current application.

Example 2: Create a multiple instance worker role

PS C:\> Add-AzureWorkerRole MyWorkerRole -I 2

This example adds scaffolding for a new worker role named MyWorkerRole to the current application, with a role instance count of 2.

Example 3: Create worker role with custom scaffolding

PS C:\> Add-AzureWorkerRole MyWorkerRole -TemplateFoldr .\MyWorkerRoleTemplate

This example creates a worker role with custom scaffolding.

Parameters

-Instances

Specifies the number of role instances for this worker role. The default is 1.

Type:Int32
Aliases:i
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the worker role. This value determines the folder name that contains the scaffolding for the custom application that will be hosted in the worker role. The default is WorkerRolenumber, where number is the number of worker roles in the service.

Type:String
Aliases:n
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateFolder

Specifies the scaffolding template folder to be used to create the worker role.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False