Web Apps - Get Triggered Web Job

Service:

App Service

API Version:

2024-04-01

Description for Gets a triggered web job by its ID for an app, or a deployment slot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Site name.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
webJobName	path	True	string	Name of Web Job.
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	TriggeredWebJob	Found continuous web job.
404 Not Found		Triggered web job does not exist.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
TriggeredJobRun	Triggered Web Job Run Information.
TriggeredWebJob	Triggered Web Job Information.
TriggeredWebJobStatus	Job status.
WebJobType	Job type.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

TriggeredJobRun

Triggered Web Job Run Information.

Name	Type	Description
duration	string	Job duration.
end_time	string	End time.
error_url	string	Error URL.
job_name	string	Job name.
output_url	string	Output URL.
start_time	string	Start time.
status	TriggeredWebJobStatus	Job status.
trigger	string	Job trigger.
url	string	Job URL.
web_job_id	string	Job ID.
web_job_name	string	Job name.

TriggeredWebJob

Triggered Web Job Information.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.error	string	Error information.
properties.extra_info_url	string	Extra Info URL.
properties.history_url	string	History URL.
properties.latest_run	TriggeredJobRun	Latest job run information.
properties.publicNetworkAccess	string	Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.
properties.run_command	string	Run command.
properties.scheduler_logs_url	string	Scheduler Logs URL.
properties.settings	object	Job settings.
properties.storageAccountRequired	boolean	Checks if Customer provided storage account is required
properties.url	string	Job URL.
properties.using_sdk	boolean	Using SDK?
properties.web_job_type	WebJobType	Job type.
type	string	Resource type.

TriggeredWebJobStatus

Job status.

Name	Type	Description
Error	string
Failed	string
Success	string

WebJobType

Job type.

Name	Type	Description
Continuous	string
Triggered	string