New-AzureRoleTemplate

  • Reference
Module:
Azure

Creates web and worker role templates.

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

New-AzureRoleTemplate
   [-Web]
   [-Output <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
New-AzureRoleTemplate
   [-Worker]
   [-Output <String>]
   [-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 New-AzureRoleTemplate cmdlet creates web and worker role templates.

Examples

Example 1: Create a web role template

PS C:\> New-AzureRoleTemplate -Web

This example creates a new web role template in a folder named WebRoleTemplate in the current directory.

Example 2: Create a worker role template

PS C:\> New-AzureRoleTemplate -Worker

This example creates a new worker role template in a folder named WebRoleTemplate in the current directory.

Example 3: Create a role template in a custom directory

PS C:\> New-AzureRoleTemplate -Web -Output C:\MyWebRoleTemplate

This example creates a new web role template in directory named MyWebRoleTemplate, instead of in the current directory.

Parameters

-Output

Specifies the output path of generated template.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

-Web

Specifies that you want to create a web role template.

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

-Worker

Specifies that you want to create a worker role template.

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