Edit

Start-AzWebAppTriggeredWebJob

  • Reference
Module:
Az.Websites

Run a triggered web job for an app.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Start-AzWebAppTriggeredWebJob
     -AppName <String>
     -Name <String>
     -ResourceGroupName <String>
     [-SubscriptionId <String>]
     [-DefaultProfile <PSObject>]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-AzWebAppTriggeredWebJob
     -InputObject <IWebsitesIdentity>
     [-DefaultProfile <PSObject>]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

Run a triggered web job for an app.

Examples

Example 1: Run a triggered web job for an app

PS C:\> Start-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01

This command runs a triggered web job for an app.

Example 2: Run a triggered web job for an app by pipeline

PS C:\> Get-AzWebAppTriggeredWebJob -ResourceGroupName webjob-rg-test -AppName appService-test01 -Name triggeredjob-01 | Start-AzWebAppTriggeredWebJob

This command runs a triggered web job for an app by pipeline.

Parameters

-AppName

Site name.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IWebsitesIdentity
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

Name of Web Job.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

Name of the resource group to which the resource belongs.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SubscriptionId

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IWebsitesIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IWebsitesIdentity>: Identity Parameter

  • [Authprovider <String>]: The auth provider for the users.
  • [DomainName <String>]: The custom domain name.
  • [EnvironmentName <String>]: The stage site identifier.
  • [FunctionAppName <String>]: Name of the function app registered with the static site build.
  • [Id <String>]: Resource identity path
  • [JobHistoryId <String>]: History ID.
  • [Location <String>]: Location where you plan to create the static site.
  • [Name <String>]: Name of the static site.
  • [PrivateEndpointConnectionName <String>]: Name of the private endpoint connection.
  • [ResourceGroupName <String>]: Name of the resource group to which the resource belongs.
  • [Slot <String>]: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
  • [SubscriptionId <String>]: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • [Userid <String>]: The user id of the user.
  • [WebJobName <String>]: Name of Web Job.