Edit

Share via

Start-AzureWebsiteJob

  • Reference
Module:
Azure

Starts a web job for a website.

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

Start-AzureWebsiteJob
     -JobName <String>
     -JobType <WebJobType>
     [-PassThru]
     [-Name <String>]
     [-Slot <String>]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]

Description

The Start-AzureWebsiteJob cmdlet starts a web job for a website.

Examples

Example 1: Start a web job for a website

PS C:\> Start-AzureWebsiteJob -Name MyWebsite -JobName MyWebJob -JobType Continuous

Starts a web job called MyWebJob for MyWebSite.

Parameters

-JobName

The web job name.

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

-JobType

The web job type. Can be triggered or continuous.

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

-Name

The name of the Azure website.

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

-PassThru

Returns a boolean value indicating that the job started successfully. By default, this cmdlet does not return any output.

Type:SwitchParameter
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

-Slot

The slot name of the Azure website.

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