Web Apps - List Instance Identifiers

Service:

App Service

API Version:

2023-12-01

Description for Gets all scale-out instances of an app.

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the app.
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	WebAppInstanceStatusCollection	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
ContainerCpuStatistics
ContainerCpuUsage
ContainerInfo
ContainerMemoryStatistics
ContainerNetworkInterfaceStatistics
ContainerThrottlingData
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
SiteRuntimeState
WebAppInstanceStatusCollection	Collection of app instances.
WebSiteInstanceStatus

ContainerCpuStatistics

Name	Type	Description
cpuUsage	ContainerCpuUsage
onlineCpuCount	integer
systemCpuUsage	integer
throttlingData	ContainerThrottlingData

ContainerCpuUsage

Name	Type	Description
kernelModeUsage	integer
perCpuUsage	integer[]
totalUsage	integer
userModeUsage	integer

ContainerInfo

Name	Type	Description
currentCpuStats	ContainerCpuStatistics
currentTimeStamp	string
eth0	ContainerNetworkInterfaceStatistics
id	string
memoryStats	ContainerMemoryStatistics
name	string
previousCpuStats	ContainerCpuStatistics
previousTimeStamp	string

ContainerMemoryStatistics

Name	Type	Description
limit	integer
maxUsage	integer
usage	integer

ContainerNetworkInterfaceStatistics

Name	Type	Description
rxBytes	integer
rxDropped	integer
rxErrors	integer
rxPackets	integer
txBytes	integer
txDropped	integer
txErrors	integer
txPackets	integer

ContainerThrottlingData

Name	Type	Description
periods	integer
throttledPeriods	integer
throttledTime	integer

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.

SiteRuntimeState

Name	Type	Description
READY	string
STOPPED	string
UNKNOWN	string

WebAppInstanceStatusCollection

Collection of app instances.

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

WebSiteInstanceStatus

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.consoleUrl	string	Link to the console to web app instance
properties.containers	<string,  ContainerInfo>
properties.detectorUrl	string	Link to the Diagnose and Solve Portal
properties.healthCheckUrl	string	Link to the console to web app instance
properties.state	SiteRuntimeState
properties.statusUrl	string	Link to the GetStatusApi in Kudu
type	string	Resource type.