Web Apps - Get Instance Info

Service:: App Service

API Version:: 2025-03-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/{instanceId}?api-version=2025-03-01

URI Parameters

Name	In	Required	Type	Description
instanceId	path	True	string
name	path	True	string	Name of the app.
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	WebSiteInstanceStatus	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

Examples

Get site instance info

Sample request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/instances/134987120?api-version=2025-03-01


/**
 * Samples for WebApps GetInstanceInfoSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetSiteInstanceInfo.json
     */
    /**
     * Sample code: Get site instance info.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getSiteInstanceInfo(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getInstanceInfoSlotWithResponse("testrg123", "tests346",
            "134987120", "staging", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_site_instance_info.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.get_instance_info(
        resource_group_name="testrg123",
        name="tests346",
        instance_id="134987120",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetSiteInstanceInfo.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetSiteInstanceInfo.json
func ExampleWebAppsClient_GetInstanceInfoSlot() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetInstanceInfoSlot(ctx, "testrg123", "tests346", "134987120", "staging", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WebSiteInstanceStatus = armappservice.WebSiteInstanceStatus{
	// 	Name: to.Ptr("134987120"),
	// 	Type: to.Ptr("Microsoft.Web/sites/instances"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging/instances/134987120"),
	// 	Properties: &armappservice.WebSiteInstanceStatusProperties{
	// 		Containers: map[string]*armappservice.ContainerInfo{
	// 			"c1": &armappservice.ContainerInfo{
	// 				CurrentTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2013-10-21T13:28:06.419Z"); return t}()),
	// 			},
	// 		},
	// 		DetectorURL: to.Ptr("testsec579"),
	// 		State: to.Ptr(armappservice.SiteRuntimeStateREADY),
	// 		StatusURL: to.Ptr("https://sampleurl"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Gets all scale-out instances of an app.
 *
 * @summary Description for Gets all scale-out instances of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetSiteInstanceInfo.json
 */
async function getSiteInstanceInfo() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "tests346";
  const instanceId = "134987120";
  const slot = "staging";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getInstanceInfoSlot(
    resourceGroupName,
    name,
    instanceId,
    slot,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "name": "134987120",
  "type": "Microsoft.Web/sites/instances",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging/instances/134987120",
  "properties": {
    "containers": {
      "c1": {
        "currentTimeStamp": "2013-10-21T13:28:06.419Z"
      }
    },
    "detectorUrl": "testsec579",
    "state": "READY",
    "statusUrl": "https://sampleurl"
  }
}

Definitions

Name	Description
ContainerCpuStatistics
ContainerCpuUsage
ContainerInfo
ContainerMemoryStatistics
ContainerNetworkInterfaceStatistics
ContainerThrottlingData
createdByType	The type of identity that created the resource.
DefaultErrorResponse	App Service error response.
DefaultErrorResponseError	Error model.
DefaultErrorResponseErrorDetailsItem	Detailed errors.
SiteRuntimeState
systemData	Metadata pertaining to creation and last modification of the resource.
WebSiteInstanceStatus	Concrete proxy resource types can be created by aliasing this type using a specific property type.

ContainerCpuStatistics

Object

Name	Type	Description
cpuUsage	ContainerCpuUsage
onlineCpuCount	integer (int32)
systemCpuUsage	integer (int64)
throttlingData	ContainerThrottlingData

ContainerCpuUsage

Object

Name	Type	Description
kernelModeUsage	integer (int64)
perCpuUsage	integer[] (int64)
totalUsage	integer (int64)
userModeUsage	integer (int64)

ContainerInfo

Object

Name	Type	Description
currentCpuStats	ContainerCpuStatistics
currentTimeStamp	string (date-time)
eth0	ContainerNetworkInterfaceStatistics
id	string
memoryStats	ContainerMemoryStatistics
name	string
previousCpuStats	ContainerCpuStatistics
previousTimeStamp	string (date-time)

ContainerMemoryStatistics

Object

Name	Type	Description
limit	integer (int64)
maxUsage	integer (int64)
usage	integer (int64)

ContainerNetworkInterfaceStatistics

Object

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

ContainerThrottlingData

Object

Name	Type	Description
periods	integer (int32)
throttledPeriods	integer (int32)
throttledTime	integer (int32)

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.

SiteRuntimeState

Enumeration

Value	Description
READY
STOPPED
UNKNOWN

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.

WebSiteInstanceStatus

Object

Concrete proxy resource types can be created by aliasing this type using a specific property type.

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.consoleUrl	string	Link to the console to web app instance
properties.containers	<string, ContainerInfo>	Dictionary of <ContainerInfo>
properties.detectorUrl	string	Link to the Diagnose and Solve Portal
properties.healthCheckUrl	string	Link to the console to web app instance
properties.physicalZone	string	The physical zone that the instance is in
properties.state	SiteRuntimeState
properties.statusUrl	string	Link to the GetStatusApi in Kudu
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"

Share via

Web Apps - Get Instance Info

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get site instance info

Sample request

Sample response

Definitions

ContainerCpuStatistics

ContainerCpuUsage

ContainerInfo

ContainerMemoryStatistics

ContainerNetworkInterfaceStatistics

ContainerThrottlingData

createdByType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

SiteRuntimeState

systemData

WebSiteInstanceStatus