Web Apps - List Web Jobs

Service:

App Service

API Version:

2024-04-01

Description for List webjobs for an app, or a deployment slot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs?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).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	WebJobCollection	OK
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.
WebJob	Web Job Information.
WebJobCollection	Collection of Kudu web job information elements.
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.

WebJob

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.run_command	string	Run command.
properties.settings	object	Job settings.
properties.url	string	Job URL.
properties.using_sdk	boolean	Using SDK?
properties.web_job_type	WebJobType	Job type.
type	string	Resource type.

WebJobCollection

Collection of Kudu web job information elements.

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

WebJobType

Job type.

Name	Type	Description
Continuous	string
Triggered	string