App Service Environments - List Multi Role Usages

Serviço:

App Service

Versão da API:

2024-11-01

Descrição para obter métricas de uso para um pool de várias funções de um Ambiente do Serviço de Aplicativo.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do Ambiente do Serviço de Aplicativo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	UsageCollection	OKEY
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
ComputeModeOptions	Trabalhos compartilhados/dedicados.
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
Usage	Uso do recurso de cota.
UsageCollection	Coleção de usos.

ComputeModeOptions

Enumeração

Trabalhos compartilhados/dedicados.

Valor	Description
Dedicated
Dynamic
Shared

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Usage

Objeto

Uso do recurso de cota.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.computeMode	ComputeModeOptions	Modo de computação usado para esse uso.
properties.currentValue	integer (int64)	O valor atual do contador de recursos.
properties.displayName	string	Nome amigável mostrado na interface do usuário.
properties.limit	integer (int64)	O limite de recursos.
properties.nextResetTime	string (date-time)	Hora da próxima redefinição para o contador de recursos.
properties.resourceName	string	Nome do recurso de cota.
properties.siteMode	string	Modo de site usado para esse uso.
properties.unit	string	Unidades de medida para o recurso de cota.
type	string	Tipo de recurso.

UsageCollection

Objeto

Coleção de usos.

Nome	Tipo	Description
nextLink	string	Link para a próxima página de recursos.
value	Usage[]	Coleção de recursos.