App Service Environments - List Multi Role Usages

Dienst:

App Service

API-Version:

2024-11-01

Beschreibung zum Abrufen von Nutzungsmetriken für einen Pool mit mehreren Rollen einer App-Dienstumgebung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der App-Dienstumgebung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name der Ressourcengruppe, zu der die Ressource gehört.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	UsageCollection	OKAY
Other Status Codes	DefaultErrorResponse	Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get usage metrics for a multi-role pool of an App Service Environment.

Beispielanforderung

HTTP

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

dotnet

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

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ListMultiRoleUsages.json
// this example is just showing the usage of "AppServiceEnvironments_ListMultiRoleUsages" 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 HostingEnvironmentMultiRolePoolResource created on azure
// for more information of creating HostingEnvironmentMultiRolePoolResource, please refer to the document of HostingEnvironmentMultiRolePoolResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-rg";
string name = "test-ase";
ResourceIdentifier hostingEnvironmentMultiRolePoolResourceId = HostingEnvironmentMultiRolePoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
HostingEnvironmentMultiRolePoolResource hostingEnvironmentMultiRolePool = client.GetHostingEnvironmentMultiRolePoolResource(hostingEnvironmentMultiRolePoolResourceId);

// invoke the operation and iterate over the result
await foreach (AppServiceUsage item in hostingEnvironmentMultiRolePool.GetMultiRoleUsagesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [],
  "nextLink": null
}

Definitionen

Name	Beschreibung
ComputeModeOptions	Freigegebene/dedizierte Mitarbeiter.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
Details
Error	Fehlermodell.
Usage	Verwendung der Kontingentressource.
UsageCollection	Sammlung von Verwendungen.

ComputeModeOptions

Enumeration

Freigegebene/dedizierte Mitarbeiter.

Wert	Beschreibung
Dedicated
Dynamic
Shared

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Objekt

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Usage

Objekt

Verwendung der Kontingentressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.computeMode	ComputeModeOptions	Berechnungsmodus, der für diese Verwendung verwendet wird.
properties.currentValue	integer (int64)	Der aktuelle Wert des Ressourcenzählers.
properties.displayName	string	Anzeigename, der in der Benutzeroberfläche angezeigt wird.
properties.limit	integer (int64)	Der Ressourcengrenzwert.
properties.nextResetTime	string (date-time)	Nächstes Zurücksetzen der Zeit für den Ressourcenzähler.
properties.resourceName	string	Name der Kontingentressource.
properties.siteMode	string	Der für diese Verwendung verwendete Websitemodus.
properties.unit	string	Maßeinheiten für die Kontingentressource.
type	string	Ressourcentyp.

UsageCollection

Objekt

Sammlung von Verwendungen.

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite von Ressourcen.
value	Usage[]	Sammlung von Ressourcen.