Web Apps - Get Instance Info

Service:

App Service

Version d'API:

2024-11-01

Description pour Obtenir 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=2024-11-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 minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nom du groupe de ressources auquel appartient la ressource.
subscriptionId	path	True	string	Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 000000000-0000-0000-0000-00000000000000000000000).
api-version	query	True	string	Version de l’API

Réponses

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

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Get site instance info

Exemple de requête

HTTP

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

Java

/**
 * Samples for WebApps GetInstanceInfoSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-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

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/2024-11-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/v5"
)

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

JavaScript

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/stable/2024-11-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 credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getInstanceInfo(resourceGroupName, name, instanceId);
  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

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-11-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 WebSiteSlotResource created on azure
// for more information of creating WebSiteSlotResource, please refer to the document of WebSiteSlotResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "tests346";
string slot = "staging";
ResourceIdentifier webSiteSlotResourceId = WebSiteSlotResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, slot);
WebSiteSlotResource webSiteSlot = client.GetWebSiteSlotResource(webSiteSlotResourceId);

// get the collection of this SiteSlotInstanceResource
SiteSlotInstanceCollection collection = webSiteSlot.GetSiteSlotInstances();

// invoke the operation
string instanceId = "134987120";
NullableResponse<SiteSlotInstanceResource> response = await collection.GetIfExistsAsync(instanceId);
SiteSlotInstanceResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

Exemple de réponse

Code d’état:

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	Réponse d’erreur App Service.
Details
Error	Modèle d’erreur.
SiteRuntimeState
WebSiteInstanceStatus

ContainerCpuStatistics

Object

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

ContainerCpuUsage

Object

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

ContainerInfo

Object

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

ContainerMemoryStatistics

Object

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

ContainerNetworkInterfaceStatistics

Object

Nom	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

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

DefaultErrorResponse

Object

Réponse d’erreur App Service.

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

Details

Object

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

Error

Object

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	Pour plus d’informations sur l’erreur de débogage.
message	string	Description détaillée des erreurs et informations de débogage.
target	string	Description détaillée des erreurs et informations de débogage.

SiteRuntimeState

Énumération

Valeur	Description
READY
STOPPED
UNKNOWN

WebSiteInstanceStatus

Object

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.consoleUrl	string	Lien vers la console vers l’instance d’application web
properties.containers	<string,  ContainerInfo>
properties.detectorUrl	string	Lien vers le portail de diagnostic et de résolution
properties.healthCheckUrl	string	Lien vers la console vers l’instance d’application web
properties.physicalZone	string	Zone physique dans laquelle l’instance se trouve
properties.state	SiteRuntimeState
properties.statusUrl	string	Lien vers GetStatusApi dans Kudu
type	string	Type de ressource.