Web Apps - List Instance Processes

Service:

App Service

API Version:

2024-04-01

Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.

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

URI Parameters

Name	In	Required	Type	Description
instanceId	path	True	string	ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
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	ProcessInfoCollection	Process terminated.
404 Not Found		Process with the specified ID is not running.
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.
ProcessInfo	Process Information.
ProcessInfoCollection	Collection of Kudu process information elements.
ProcessModuleInfo	Process Module Information.
ProcessThreadInfo	Process Thread Information.

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.

ProcessInfo

Process Information.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.children	string[]	Child process list.
properties.command_line	string	Command line.
properties.deployment_name	string	Deployment name.
properties.description	string	Description of process.
properties.environment_variables	object	List of environment variables.
properties.file_name	string	File name of this process.
properties.handle_count	integer	Handle count.
properties.href	string	HRef URI.
properties.identifier	integer	ARM Identifier for deployment.
properties.iis_profile_timeout_in_seconds	number	IIS Profile timeout (seconds).
properties.is_iis_profile_running	boolean	Is the IIS Profile running?
properties.is_profile_running	boolean	Is profile running?
properties.is_scm_site	boolean	Is this the SCM site?
properties.is_webjob	boolean	Is this a Web Job?
properties.minidump	string	Minidump URI.
properties.module_count	integer	Module count.
properties.modules	ProcessModuleInfo[]	List of modules.
properties.non_paged_system_memory	integer	Non-paged system memory.
properties.open_file_handles	string[]	List of open files.
properties.paged_memory	integer	Paged memory.
properties.paged_system_memory	integer	Paged system memory.
properties.parent	string	Parent process.
properties.peak_paged_memory	integer	Peak paged memory.
properties.peak_virtual_memory	integer	Peak virtual memory usage.
properties.peak_working_set	integer	Peak working set.
properties.private_memory	integer	Private memory size.
properties.privileged_cpu_time	string	Privileged CPU time.
properties.start_time	string	Start time.
properties.thread_count	integer	Thread count.
properties.threads	ProcessThreadInfo[]	Thread list.
properties.time_stamp	string	Time stamp.
properties.total_cpu_time	string	Total CPU time.
properties.user_cpu_time	string	User CPU time.
properties.user_name	string	User name.
properties.virtual_memory	integer	Virtual memory size.
properties.working_set	integer	Working set.
type	string	Resource type.

ProcessInfoCollection

Collection of Kudu process information elements.

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

ProcessModuleInfo

Process Module Information.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.base_address	string	Base address. Used as module identifier in ARM resource URI.
properties.file_description	string	File description.
properties.file_name	string	File name.
properties.file_path	string	File path.
properties.file_version	string	File version.
properties.href	string	HRef URI.
properties.is_debug	boolean	Is debug?
properties.language	string	Module language (locale).
properties.module_memory_size	integer	Module memory size.
properties.product	string	Product name.
properties.product_version	string	Product version.
type	string	Resource type.

ProcessThreadInfo

Process Thread Information.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.base_priority	integer	Base priority.
properties.current_priority	integer	Current thread priority.
properties.href	string	HRef URI.
properties.identifier	integer	Site extension ID.
properties.priority_level	string	Thread priority level.
properties.process	string	Process URI.
properties.start_address	string	Start address.
properties.start_time	string	Start time.
properties.state	string	Thread state.
properties.total_processor_time	string	Total processor time.
properties.user_processor_time	string	User processor time.
properties.wait_reason	string	Wait reason.
type	string	Resource type.