Add-AzureWorkerRole
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Add-AzureWorkerRole
Creates required files and configuration (sometimes referred to as scaffolding) for a custom worker role.
Parameter Set: Default
Add-AzureWorkerRole [[-Name] <String> ] [[-Instances] <Int32> ] [[-TemplateFolder] <String> ] [ <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 Add-AzureWorkerRole cmdlet creates required files and configuration (sometimes referred to as scaffolding) for a custom worker role.
-Instances<Int32>
Specifies the number of role instances for this worker role. The default is 1.
Aliases |
i |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
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.
Aliases |
n |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TemplateFolder<String>
Specifies the scaffolding template folder to be used to create the worker role.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
Create a single instance worker role
This example adds scaffolding for a single worker role named MyWorkerRole to the current application.
PS C:\> Add-AzureWorkerRole -Name MyWorkerRole
Create a multiple instance worker role
This example adds scaffolding for a new worker role named MyWorkerRole to the current application, with a role instance count of 2.
PS C:\> Add-AzureWorkerRole MyWorkerRole -I 2
Create worker role with custom scaffolding
This example creates a worker role with custom scaffolding.
PS C:\> Add-AzureWorkerRole MyWorkerRole -TemplateFoldr .\MyWorkerRoleTemplate