Web Apps - Get Instance Info

Service:

App Service

Version d'API:

2023-12-01

Description pour Obtient toutes les instances de scale-out d’une application.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
instanceId	path	True	string
name	path	True	string	Nom de l’application.
resourceGroupName	path	True	string	Nom du groupe de ressources auquel appartient la ressource. Modèle d’expression régulière: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 0000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Version d'API

Réponses

Nom	Type	Description
200 OK	WebSiteInstanceStatus	Ok
Other Status Codes	DefaultErrorResponse	App Service réponse d’erreur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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/instances/134987120?api-version=2023-12-01

Python

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/stable/2023-12-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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-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

JavaScript

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

/**
 * 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/stable/2023-12-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

{
  "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"
      }
    }
  }
}

Définitions

Nom	Description
ContainerCpuStatistics
ContainerCpuUsage
ContainerInfo
ContainerMemoryStatistics
ContainerNetworkInterfaceStatistics
ContainerThrottlingData
DefaultErrorResponse	App Service réponse d’erreur.
Details
Error	Modèle d’erreur.
SiteRuntimeState
WebSiteInstanceStatus

ContainerCpuStatistics

Nom	Type	Description
cpuUsage	ContainerCpuUsage
onlineCpuCount	integer
systemCpuUsage	integer
throttlingData	ContainerThrottlingData

ContainerCpuUsage

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

ContainerInfo

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

ContainerMemoryStatistics

Nom	Type	Description
limit	integer
maxUsage	integer
usage	integer

ContainerNetworkInterfaceStatistics

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

ContainerThrottlingData

Nom	Type	Description
periods	integer
throttledPeriods	integer
throttledTime	integer

DefaultErrorResponse

App Service réponse d’erreur.

Nom	Type	Description
error	Error	Modèle d’erreur.

Details

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

Error

Modèle d’erreur.

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
details	Details[]	Erreurs détaillées.
innererror	string	Informations supplémentaires pour déboguer l’erreur.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

SiteRuntimeState

Nom	Type	Description
READY	string
STOPPED	string
UNKNOWN	string

WebSiteInstanceStatus

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.consoleUrl	string	Lier la console à l’application web instance
properties.containers	<string,  ContainerInfo>
properties.detectorUrl	string	Lien vers le portail Diagnostiquer et résoudre
properties.healthCheckUrl	string	Lier la console à l’application web instance
properties.state	SiteRuntimeState
properties.statusUrl	string	Lien vers l’api GetStatus dans Kudu
type	string	Type de ressource.