Edit

Share via

Add-AzureWebRole

  • Reference
Module:
Azure

Adds a web 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-AzureWebRole
   [-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-AzureWebRole cmdlet adds a web worker role.

Examples

Example 1: Add a default role

PS C:\> Add-AzureWebRole

This command add web role that has the default configuration of Webrole1 as the name and a single instance.

Example 2: Add a role with a name

PS C:\> Add-AzureWebRole -Name "MyWebRole"

This command adds a single web role named MyWebRole to the current application.

Example 3: Add a role with a name and instance count

PS C:\> Add-AzureWebRole -Name "MyWebRole" -Instance 2

This command adds a web role named MyWebRole to the current application. The cmdlet has a role instance count of 2.

Example 4: Add a role with a name and template

PS C:\> Add-AzureWebRole -Name "MyWebRole" -TemplateFolder ".\MyWebTemplateFolder"

This command adds a single web role named MyWebRole to the current application. The command specifies a folder named MyWebTemplateFolder as a scaffolding template.

Parameters

-Instances

Specifies the number of instances.

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 web role.

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 template folder.

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