Share via

Web Apps - List Web Jobs

Service:
App Service
API Version:
2025-05-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=2025-05-01

URI Parameters

Name In Required Type Description
name
 path True

string

Site name.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

WebJobCollection

Azure operation completed successfully.
Other Status Codes

DefaultErrorResponse

An unexpected 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
createdByType

The type of identity that created the resource.
DefaultErrorResponse

App Service error response.
DefaultErrorResponseError

Error model.
DefaultErrorResponseErrorDetailsItem

Detailed errors.
systemData

Metadata pertaining to creation and last modification of the resource.
WebJob

Web Job Information.
WebJobCollection

Collection of Kudu web job information elements.
WebJobType

Job type.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

App Service error response.

Name Type Description
error

DefaultErrorResponseError

Error model.

DefaultErrorResponseError

Object

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.
details

DefaultErrorResponseErrorDetailsItem[]

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.

DefaultErrorResponseErrorDetailsItem

Object

Detailed errors.

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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.

WebJob

Object

Web Job Information.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

string

Kind of resource.
name

string

The name of the resource
properties.error

string

Error information.
properties.extra_info_url

string

Extra Info URL.
properties.run_command

string

Run command.
properties.settings

Job settings.
properties.url

string

Job URL.
properties.using_sdk

boolean

Using SDK?
properties.web_job_type

WebJobType

Job type.
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

WebJobCollection

Object

Collection of Kudu web job information elements.

Name Type Description
nextLink

string (uri)

The link to the next page of items
value

WebJob[]

The WebJob items on this page

WebJobType

Enumeration

Job type.

Value Description
Continuous
Triggered