Web Apps - List Triggered Web Job History Slot

Service:

App Service

API Version:

2023-01-01

Description for List a triggered web job's history for an app, or a deployment slot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history?api-version=2023-01-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\._\(\)]+[^\.]$
slot	path	True	string	Name of the deployment slot. If a slot is not specified, the API uses the production slot.
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	TriggeredJobHistoryCollection	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.
TriggeredJobHistory	Triggered Web Job History. List of Triggered Web Job Run Information elements.
TriggeredJobHistoryCollection	Collection of Kudu continuous web job information elements.
TriggeredJobRun	Triggered Web Job Run Information.
TriggeredWebJobStatus	Job status.

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.

TriggeredJobHistory

Triggered Web Job History. List of Triggered Web Job Run Information elements.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.runs	TriggeredJobRun[]	List of triggered web job runs.
type	string	Resource type.

TriggeredJobHistoryCollection

Collection of Kudu continuous web job information elements.

Name	Type	Description
nextLink	string	Link to next page of resources.
value	TriggeredJobHistory[]	Collection of resources.

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.

TriggeredWebJobStatus

Job status.

Name	Type	Description
Error	string
Failed	string
Success	string