Web Apps - Get Instance Info Slot

Service:

App Service

API Version:

2024-04-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}/slots/{slot}/instances/{instanceId}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
instanceId	path	True	string
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\._\(\)]+[^\.]$
slot	path	True	string	Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.
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	WebSiteInstanceStatus	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

Examples

Get site instance info

Sample request

HTTP

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

Java

/**
 * Samples for WebApps GetInstanceInfo.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-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().getInstanceInfoWithResponse("testrg123", "tests346",
            "134987120", 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

Go

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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteInstanceInfo.json
func ExampleWebAppsClient_GetInstanceInfo() {
	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().GetInstanceInfo(ctx, "testrg123", "tests346", "134987120", 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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteInstanceInfo.json
// this example is just showing the usage of "WebApps_GetInstanceInfoSlot" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SiteSlotInstanceResource created on azure
// for more information of creating SiteSlotInstanceResource, please refer to the document of SiteSlotInstanceResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "tests346";
string slot = "staging";
string instanceId = "134987120";
ResourceIdentifier siteSlotInstanceResourceId = SiteSlotInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, slot, instanceId);
SiteSlotInstanceResource siteSlotInstance = client.GetSiteSlotInstanceResource(siteSlotInstanceResourceId);

// invoke the operation
SiteSlotInstanceResource result = await siteSlotInstance.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
WebSiteInstanceStatusData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

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

Definitions

Name	Description
ContainerCpuStatistics
ContainerCpuUsage
ContainerInfo
ContainerMemoryStatistics
ContainerNetworkInterfaceStatistics
ContainerThrottlingData
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
SiteRuntimeState
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

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.physicalZone	string	The physical zone that the instance is in
properties.state	SiteRuntimeState
properties.statusUrl	string	Link to the GetStatusApi in Kudu
type	string	Resource type.