Share via

Web Apps - Get Instance Process

Service:
App Service
API Version:
2025-03-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-03-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
pattern: ^[-\w\._\(\)]+[^\.]$

Name of the resource group to which the resource belongs.
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

ProcessInfo

Process information returned.
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.
ProcessModuleInfo

Process Module Information.
ProcessThreadInfo

Process Thread Information.

DefaultErrorResponse

Object

App Service error response.

Name Type Description
error

Error

Error model.

Details

Object
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

Object

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

Object

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 (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.
type

string

Resource type.

ProcessModuleInfo

Object

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 (int32)

Module memory size.
properties.product

string

Product name.
properties.product_version

string

Product version.
type

string

Resource type.

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.