Web Apps - Get Instance Process

Service:

App Service

API Version:

2025-05-01

Description for Get process information by its ID 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/{processId}?api-version=2025-05-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.
processId	path	True	string	PID.
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	ProcessInfo	Azure operation completed successfully.
404 Not Found		The server cannot find the requested resource.
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.
ProcessInfo	Process Information.
ProcessModuleInfo	Process Module Information.
ProcessThreadInfo	Process Thread Information.
systemData	Metadata pertaining to creation and last modification of the resource.

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.

ProcessInfo

Object

Process 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.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 (int32)	Handle count.
properties.href	string	HRef URI.
properties.identifier	integer (int32)	ARM Identifier for deployment.
properties.iis_profile_timeout_in_seconds	number (double)	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 (int32)	Module count.
properties.modules	ProcessModuleInfo[]	List of modules.
properties.non_paged_system_memory	integer (int64)	Non-paged system memory.
properties.open_file_handles	string[]	List of open files.
properties.paged_memory	integer (int64)	Paged memory.
properties.paged_system_memory	integer (int64)	Paged system memory.
properties.parent	string	Parent process.
properties.peak_paged_memory	integer (int64)	Peak paged memory.
properties.peak_virtual_memory	integer (int64)	Peak virtual memory usage.
properties.peak_working_set	integer (int64)	Peak working set.
properties.private_memory	integer (int64)	Private memory size.
properties.privileged_cpu_time	string	Privileged CPU time.
properties.start_time	string (date-time)	Start time.
properties.thread_count	integer (int32)	Thread count.
properties.threads	ProcessThreadInfo[]	Thread list.
properties.time_stamp	string (date-time)	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 (int64)	Virtual memory size.
properties.working_set	integer (int64)	Working set.
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"

ProcessModuleInfo

Object

Process Module 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.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 (int32)	Module memory size.
properties.product	string	Product name.
properties.product_version	string	Product version.
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"

ProcessThreadInfo

Object

Process Thread Information.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.base_priority	integer (int32)	Base priority.
properties.current_priority	integer (int32)	Current thread priority.
properties.href	string	HRef URI.
properties.identifier	integer (int32)	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 (date-time)	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.

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.