App Service Environments - Get Multi Role Pool

Service:: App Service

Version d'API:: 2025-03-01

Description des propriétés Obtenir d’un pool multirôle.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default?api-version=2025-03-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom de l’environnement App Service.
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	WorkerPoolResource	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 properties of a multi-role pool.

Exemple de requête

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/multiRolePools/default?api-version=2025-03-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python app_service_environments_get_multi_role_pool.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.app_service_environments.get_multi_role_pool(
        resource_group_name="test-rg",
        name="test-ase",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/AppServiceEnvironments_GetMultiRolePool.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/AppServiceEnvironments_GetMultiRolePool.json
func ExampleEnvironmentsClient_GetMultiRolePool() {
	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.NewEnvironmentsClient().GetMultiRolePool(ctx, "test-rg", "test-ase", 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.WorkerPoolResource = armappservice.WorkerPoolResource{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Web/hostingEnvironments/multiRolePools"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/multiRolePools/default"),
	// 	Properties: &armappservice.WorkerPool{
	// 		InstanceNames: []*string{
	// 			to.Ptr("10.7.1.8"),
	// 			to.Ptr("10.7.1.9")},
	// 			WorkerCount: to.Ptr[int32](2),
	// 			WorkerSize: to.Ptr("Standard_D1_V2"),
	// 		},
	// 		SKU: &armappservice.SKUDescription{
	// 			Name: to.Ptr("Q1"),
	// 			Capacity: to.Ptr[int32](2),
	// 			Family: to.Ptr("Q"),
	// 			Size: to.Ptr("Q1"),
	// 			Tier: to.Ptr("Quantum"),
	// 		},
	// 	}
}

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 Get properties of a multi-role pool.
 *
 * @summary Description for Get properties of a multi-role pool.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/AppServiceEnvironments_GetMultiRolePool.json
 */
async function getPropertiesOfAMultiRolePool() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-rg";
  const name = "test-ase";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServiceEnvironments.getMultiRolePool(resourceGroupName, name);
  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

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/multiRolePools/default",
  "name": "default",
  "type": "Microsoft.Web/hostingEnvironments/multiRolePools",
  "properties": {
    "workerSize": "Standard_D1_V2",
    "workerCount": 2,
    "instanceNames": [
      "10.7.1.8",
      "10.7.1.9"
    ]
  },
  "sku": {
    "name": "Q1",
    "tier": "Quantum",
    "size": "Q1",
    "family": "Q",
    "capacity": 2
  }
}

Définitions

Nom	Description
Capability	Décrit les capacités/fonctionnalités autorisées pour une référence SKU spécifique.
ComputeModeOptions	Des travailleurs partagés/dédiés.
DefaultErrorResponse	Réponse d’erreur App Service.
Details
Error	Modèle d’erreur.
SkuCapacity	Description des options de mise à l’échelle du plan App Service.
SkuDescription	Description d’une référence SKU pour une ressource évolutive.
WorkerPoolResource	Pool de travail d’une ressource ARM App Service Environment.

Capability

Objet

Décrit les capacités/fonctionnalités autorisées pour une référence SKU spécifique.

Nom	Type	Description
name	string	Nom de la fonctionnalité de référence SKU.
reason	string	Raison de la fonctionnalité de référence SKU.
value	string	Valeur de la fonctionnalité de référence SKU.

ComputeModeOptions

Énumération

Des travailleurs partagés/dédiés.

Valeur	Description
Shared
Dedicated
Dynamic

DefaultErrorResponse

Objet

Réponse d’erreur App Service.

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

Details

Objet

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

Objet

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	Plus d’informations 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.

SkuCapacity

Objet

Description des options de mise à l’échelle du plan App Service.

Nom	Type	Description
default	integer (int32)	Nombre de workers par défaut pour cette référence SKU de plan App Service.
elasticMaximum	integer (int32)	Nombre maximal de workers élastiques pour cette référence SKU de plan App Service.
maximum	integer (int32)	Nombre maximal de workers pour cette référence SKU de plan App Service.
minimum	integer (int32)	Nombre minimal de workers pour cette référence SKU de plan App Service.
scaleType	string	Configurations de mise à l’échelle disponibles pour un plan App Service.

SkuDescription

Objet

Description d’une référence SKU pour une ressource évolutive.

Nom	Type	Description
capabilities	Capability[]	Les fonctionnalités de la référence SKU, par exemple, traffic Manager sont-ils activées ?
capacity	integer (int32)	Nombre actuel d’instances affectées à la ressource.
family	string	Code de famille de la référence SKU de ressource.
locations	string[]	Emplacements de la référence SKU.
name	string	Nom de la référence SKU de ressource.
size	string	Spécificateur de taille de la référence SKU de ressource.
skuCapacity	SkuCapacity	Valeurs d’échelle min, max et par défaut de la référence SKU.
tier	string	Niveau de service de la référence SKU de ressource.

WorkerPoolResource

Objet

Pool de travail d’une ressource ARM App Service Environment.

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.computeMode	ComputeModeOptions	Hébergement d’application partagé ou dédié.
properties.instanceNames	string[]	Noms de toutes les instances du pool de travail (lecture seule).
properties.workerCount	integer (int32)	Nombre d’instances dans le pool de workers.
properties.workerSize	string	Taille de machine virtuelle des instances du pool de travail.
properties.workerSizeId	integer (int32)	ID de taille de travail pour référencer ce pool de workers.
sku	SkuDescription	Description d’une référence SKU pour une ressource évolutive.
type	string	Type de ressource.

Partager via

App Service Environments - Get Multi Role Pool

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get properties of a multi-role pool.

Exemple de requête

Exemple de réponse

Définitions

Capability

ComputeModeOptions

DefaultErrorResponse

Details

Error

SkuCapacity

SkuDescription

WorkerPoolResource