App Service Environments - List By Resource Group

Referencia

Servicio:: App Service

Versión de la API:: 2024-11-01

Descripción para Obtener todos los entornos de App Service en un grupo de recursos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Nombre del grupo de recursos al que pertenece el recurso.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
api-version	query	True	string	Versión de la API

Respuestas

Nombre	Tipo	Description
200 OK	AppServiceEnvironmentCollection	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get all App Service Environments in a resource group.

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

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.Resources;
using Azure.ResourceManager.AppService;

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

// get the collection of this AppServiceEnvironmentResource
AppServiceEnvironmentCollection collection = resourceGroupResource.GetAppServiceEnvironments();

// invoke the operation and iterate over the result
await foreach (AppServiceEnvironmentResource item in collection.GetAllAsync())
{
    // the variable item 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
    AppServiceEnvironmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
      "name": "test-ase",
      "type": "Microsoft.Web/hostingEnvironments",
      "kind": "ASEV3",
      "location": "South Central US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "status": "Ready",
        "virtualNetwork": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
          "name": "delegated",
          "type": "Microsoft.Network/virtualNetworks/subnets",
          "subnet": ""
        },
        "internalLoadBalancingMode": "None",
        "multiSize": "Standard_D2d_v4",
        "multiRoleCount": null,
        "ipsslAddressCount": 0,
        "dnsSuffix": "test-ase.p.azurewebsites.net",
        "maximumNumberOfMachines": 250,
        "frontEndScaleFactor": 15,
        "suspended": false,
        "clusterSettings": null,
        "userWhitelistedIpRanges": null,
        "hasLinuxWorkers": true,
        "dedicatedHostCount": 0,
        "zoneRedundant": false,
        "networkingConfiguration": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
          "properties": {
            "windowsOutboundIpAddresses": [
              "20.88.241.56",
              "20.88.241.9"
            ],
            "linuxOutboundIpAddresses": [
              "20.88.241.56",
              "20.88.241.9"
            ],
            "externalInboundIpAddresses": [
              "52.153.248.36"
            ],
            "internalInboundIpAddresses": [],
            "allowNewPrivateEndpointConnections": false,
            "ftpEnabled": false,
            "remoteDebugEnabled": false,
            "inboundIpAddressOverride": null
          }
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
AppServiceEnvironmentCollection	Colección de entornos de App Service.
AppServiceEnvironmentResource	Recurso de ARM de App Service Environment.
AseV3NetworkingConfiguration	Vista completa de la configuración de red de un ASE.
CustomDnsSuffixConfiguration	Vista completa de la configuración del sufijo de dominio personalizado para ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	Respuesta de error de App Service.
Details
Error	Modelo de error.
HostingEnvironmentStatus	Estado actual de App Service Environment.
LoadBalancingMode	Especifica los puntos de conexión que se van a servir internamente en la red virtual para App Service Environment.
NameValuePair	Par nombre de valor.
ProvisioningState	Estado de aprovisionamiento de App Service Environment.
UpgradeAvailability	Si hay una actualización disponible para esta instancia de App Service Environment.
UpgradePreference	Preferencias de actualización
VirtualNetworkProfile	Especificación para usar una red virtual.

AppServiceEnvironmentCollection

Object

Colección de entornos de App Service.

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de recursos.
value	AppServiceEnvironmentResource[]	Colección de recursos.

AppServiceEnvironmentResource

Object

Recurso de ARM de App Service Environment.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso.
kind	string		Tipo de recurso. Si el recurso es una aplicación, puede consultar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference para obtener más información sobre los valores admitidos para el tipo.
location	string		Ubicación del recurso.
name	string		Nombre del recurso.
properties.clusterSettings	NameValuePair[]		Configuración personalizada para cambiar el comportamiento de App Service Environment.
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Vista completa de la configuración del sufijo de dominio personalizado para ASEv3.
properties.dedicatedHostCount	integer (int32)		Recuento de hosts dedicados
properties.dnsSuffix	string		Sufijo DNS de App Service Environment.
properties.frontEndScaleFactor	integer (int32)		Factor de escala para front-end.
properties.hasLinuxWorkers	boolean		Marca que muestra si un ASE tiene trabajos de Linux o no
properties.internalLoadBalancingMode	LoadBalancingMode		Especifica los puntos de conexión que se van a servir internamente en la red virtual para App Service Environment.
properties.ipsslAddressCount	integer (int32)		Número de direcciones SSL IP reservadas para App Service Environment.
properties.maximumNumberOfMachines	integer (int32)		Número máximo de máquinas virtuales en App Service Environment.
properties.multiRoleCount	integer (int32)		Número de instancias de front-end.
properties.multiSize	string		Tamaño de máquina virtual de front-end, por ejemplo, "Mediano", "Grande".
properties.networkingConfiguration	AseV3NetworkingConfiguration		Vista completa de la configuración de red de un ASE.
properties.provisioningState	ProvisioningState		Estado de aprovisionamiento de App Service Environment.
properties.status	HostingEnvironmentStatus		Estado actual de App Service Environment.
properties.suspended	boolean		`true` si se suspende App Service Environment; de lo contrario, `false`. El entorno se puede suspender, por ejemplo, cuando el punto de conexión de administración ya no está disponible (lo más probable es que el grupo de seguridad de red bloquee el tráfico entrante).
properties.upgradeAvailability	UpgradeAvailability		Si hay una actualización disponible para esta instancia de App Service Environment.
properties.upgradePreference	UpgradePreference	None	Preferencias de actualización
properties.userWhitelistedIpRanges	string[]		El usuario agregó intervalos IP a la lista blanca en la base de datos de ASE
properties.virtualNetwork	VirtualNetworkProfile		Descripción de la red virtual.
properties.zoneRedundant	boolean		Si esta instancia de App Service Environment tiene redundancia de zona o no.
tags	object		Etiquetas de recursos.
type	string		Tipo de recurso.

AseV3NetworkingConfiguration

Object

Vista completa de la configuración de red de un ASE.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.allowNewPrivateEndpointConnections	boolean	Propiedad para habilitar y deshabilitar la creación de una nueva conexión de punto de conexión privado en ASE
properties.externalInboundIpAddresses	string[]
properties.ftpEnabled	boolean	Propiedad para habilitar y deshabilitar FTP en ASEV3
properties.inboundIpAddressOverride	string	Dirección IP de entrada proporcionada por el cliente. Solo se puede establecer en Ase create.
properties.internalInboundIpAddresses	string[]
properties.linuxOutboundIpAddresses	string[]
properties.remoteDebugEnabled	boolean	Propiedad para habilitar y deshabilitar la depuración remota en ASEV3
properties.windowsOutboundIpAddresses	string[]
type	string	Tipo de recurso.

CustomDnsSuffixConfiguration

Object

Vista completa de la configuración del sufijo de dominio personalizado para ASEv3.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.certificateUrl	string	Dirección URL que hace referencia al secreto de certificado de Azure Key Vault que se debe usar como certificado SSL/TLS predeterminado para sitios con el sufijo de dominio personalizado.
properties.dnsSuffix	string	Sufijo de dominio personalizado predeterminado que se usará para todos los sitios implementados en el ASE.
properties.keyVaultReferenceIdentity	string	Identidad asignada por el usuario que se va a usar para resolver la referencia de certificado del almacén de claves. Si no se especifica, se usará la identidad de ASE asignada por el sistema si está disponible.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	Tipo de recurso.

CustomDnsSuffixProvisioningState

Enumeración

Valor	Description
Degraded
Failed
InProgress
Succeeded

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

Error

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

HostingEnvironmentStatus

Enumeración

Estado actual de App Service Environment.

Valor	Description
Deleting
Preparing
Ready
Scaling

LoadBalancingMode

Enumeración

Especifica los puntos de conexión que se van a servir internamente en la red virtual para App Service Environment.

Valor	Description
None
Publishing
Web
Web, Publishing

NameValuePair

Object

Par nombre de valor.

Nombre	Tipo	Description
name	string	Nombre del par.
value	string	Valor del par.

ProvisioningState

Enumeración

Estado de aprovisionamiento de App Service Environment.

Valor	Description
Canceled
Deleting
Failed
InProgress
Succeeded

UpgradeAvailability

Enumeración

Si hay una actualización disponible para esta instancia de App Service Environment.

Valor	Description
None	No hay ninguna actualización disponible actualmente para esta instancia de App Service Environment
Ready	Una actualización está lista para iniciarse manualmente en esta instancia de App Service Environment

UpgradePreference

Enumeración

Preferencias de actualización

Valor	Description
Early	Esta instancia de App Service Environment se actualizará antes de que otras personas de la misma región que tengan la preferencia de actualización "Tarde"
Late	Esta instancia de App Service Environment se actualizará después de que otras personas de la misma región tengan la preferencia de actualización "Temprano".
Manual	SOLO ASEv3. Una vez disponible una actualización, app Service Environment esperará 10 días para que se inicie manualmente la actualización. Después de 10 días, la actualización se iniciará automáticamente.
None	No hay ninguna preferencia sobre cuándo se actualizará esta instancia de App Service Environment

VirtualNetworkProfile

Object

Especificación para usar una red virtual.

Nombre	Tipo	Description
id	string	Identificador de recurso de la red virtual.
name	string	Nombre de la red virtual (solo lectura).
subnet	string	Subred dentro de la red virtual.
type	string	Tipo de recurso de la red virtual (solo lectura).

Compartir a través de

App Service Environments - List By Resource Group

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get all App Service Environments in a resource group.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AppServiceEnvironmentCollection

AppServiceEnvironmentResource

AseV3NetworkingConfiguration

CustomDnsSuffixConfiguration

CustomDnsSuffixProvisioningState

DefaultErrorResponse

Details

Error

HostingEnvironmentStatus

LoadBalancingMode

NameValuePair

ProvisioningState

UpgradeAvailability

UpgradePreference

VirtualNetworkProfile