Add-AzureWorkerRole
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
Default (Default)
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 -TemplateFolder .\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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | i |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | n |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TemplateFolder
Specifies the scaffolding template folder to be used to create the worker role.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.