Container Apps - List By Resource Group

Referencia

Servicio:: App Service

Versión de la API:: 2023-12-01

Obtenga las aplicaciones de contenedor en un grupo de recursos determinado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps?api-version=2023-12-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	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 API

Respuestas

Nombre	Tipo	Description
200 OK	ContainerAppCollection	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

List Container Apps by resource group

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps?api-version=2023-12-01


/**
 * Samples for ContainerApps ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListContainerAppsByResourceGroup.json
     */
    /**
     * Sample code: List Container Apps by resource group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listContainerAppsByResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getContainerApps().listByResourceGroup("rg",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_container_apps_by_resource_group.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.container_apps.list_by_resource_group(
        resource_group_name="rg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListContainerAppsByResourceGroup.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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListContainerAppsByResourceGroup.json
func ExampleContainerAppsClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewContainerAppsClient().NewListByResourceGroupPager("rg", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContainerAppCollection = armappservice.ContainerAppCollection{
		// 	Value: []*armappservice.ContainerApp{
		// 		{
		// 			Name: to.Ptr("testcontainerApp0"),
		// 			Type: to.Ptr("Microsoft.Web/containerApps"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps/testcontainerApp0"),
		// 			Kind: to.Ptr("containerApp"),
		// 			Location: to.Ptr("East US"),
		// 			Properties: &armappservice.ContainerAppProperties{
		// 				Configuration: &armappservice.Configuration{
		// 					Ingress: &armappservice.Ingress{
		// 						External: to.Ptr(true),
		// 						Fqdn: to.Ptr("testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
		// 						TargetPort: to.Ptr[int32](3000),
		// 						Transport: to.Ptr(armappservice.IngressTransportMethodAuto),
		// 					},
		// 				},
		// 				KubeEnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube"),
		// 				LatestRevisionFqdn: to.Ptr("testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
		// 				ProvisioningState: to.Ptr(armappservice.ContainerAppProvisioningStateSucceeded),
		// 				Template: &armappservice.Template{
		// 					Containers: []*armappservice.Container{
		// 						{
		// 							Name: to.Ptr("testcontainerApp0"),
		// 							Image: to.Ptr("repo/testcontainerApp0:v4"),
		// 							Resources: &armappservice.ContainerResources{
		// 								CPU: to.Ptr[float64](0.2),
		// 								Memory: to.Ptr("100Mi"),
		// 							},
		// 					}},
		// 					Dapr: &armappservice.Dapr{
		// 						AppPort: to.Ptr[int32](3000),
		// 						Enabled: to.Ptr(true),
		// 					},
		// 					Scale: &armappservice.Scale{
		// 						MaxReplicas: to.Ptr[int32](5),
		// 						MinReplicas: to.Ptr[int32](1),
		// 						Rules: []*armappservice.ScaleRule{
		// 							{
		// 								Name: to.Ptr("httpscalingrule"),
		// 								HTTP: &armappservice.HTTPScaleRule{
		// 									Metadata: map[string]*string{
		// 										"concurrentRequests": to.Ptr("50"),
		// 									},
		// 								},
		// 						}},
		// 					},
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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");

/**
 * This sample demonstrates how to Get the Container Apps in a given resource group.
 *
 * @summary Get the Container Apps in a given resource group.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListContainerAppsByResourceGroup.json
 */
async function listContainerAppsByResourceGroup() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.containerApps.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/rg/providers/Microsoft.Web/containerApps/testcontainerApp0",
      "name": "testcontainerApp0",
      "type": "Microsoft.Web/containerApps",
      "kind": "containerApp",
      "location": "East US",
      "properties": {
        "provisioningState": "Succeeded",
        "kubeEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube",
        "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
        "configuration": {
          "ingress": {
            "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io",
            "external": true,
            "targetPort": 3000,
            "transport": "auto"
          }
        },
        "template": {
          "containers": [
            {
              "image": "repo/testcontainerApp0:v4",
              "name": "testcontainerApp0",
              "resources": {
                "cpu": 0.2,
                "memory": "100Mi"
              }
            }
          ],
          "scale": {
            "minReplicas": 1,
            "maxReplicas": 5,
            "rules": [
              {
                "name": "httpscalingrule",
                "http": {
                  "metadata": {
                    "concurrentRequests": "50"
                  }
                }
              }
            ]
          },
          "dapr": {
            "enabled": true,
            "appPort": 3000
          }
        }
      }
    }
  ],
  "nextLink": null
}

Definiciones

Nombre	Description
ActiveRevisionsMode	ActiveRevisionsMode controla cómo se controlan las revisiones activas para la aplicación Contenedor: multiple: varias revisiones pueden estar activas. Si no se proporciona ningún valor, esta es laúnica predeterminada: solo se puede activar una revisión a la vez. Los pesos de revisión no se pueden usar en este modo
Configuration	Propiedades de configuración de la aplicación contenedora no con versiones que definen la configuración mutable de una aplicación contenedora
Container	Definición de contenedor de la aplicación de contenedor.
ContainerApp	Aplicación contenedora.
ContainerAppCollection	Recurso arm de recopilación de aplicaciones de contenedor.
ContainerAppProvisioningState	Estado de aprovisionamiento de la aplicación contenedora.
ContainerResources	Requisitos de recursos de contenedor de la aplicación contenedora.
CustomScaleRule	Regla de escalado personalizado del contenedor de aplicaciones de contenedor.
Dapr	Configuración de Dapr de la aplicación contenedora.
DaprComponent	Configuración de componentes de Dapr
DaprMetadata	Metadatos del componente Dapr de la aplicación contenedora.
DefaultErrorResponse	Respuesta de error de App Service.
Details
EnvironmentVar	Variable de entorno de contenedor de la aplicación contenedora.
Error	Modelo de error.
HttpScaleRule	Regla de escalado personalizado del contenedor de aplicaciones de contenedor.
Ingress	Configuración de entrada de la aplicación contenedora.
IngressTransportMethod	Protocolo de transporte de entrada
QueueScaleRule	Regla de escalado basada en azure Queue del contenedor de aplicaciones de contenedor.
RegistryCredentials	Registro privado de aplicación de contenedor
Scale	Configuraciones de escalado de aplicaciones de contenedor.
ScaleRule	Regla de escalado de contenedores de aplicaciones de contenedor.
ScaleRuleAuth	Secretos de autenticación para la regla de escalado de aplicaciones de contenedor
Secret	Secreto de aplicación de contenedor.
Template	Definición de aplicación con versión de aplicación contenedora. Define el estado deseado de una revisión inmutable. Los cambios realizados en esta sección darán lugar a una nueva revisión que se va a crear.
TrafficWeight	Peso del tráfico asignado a una revisión

ActiveRevisionsMode

Enumeración

ActiveRevisionsMode controla cómo se controlan las revisiones activas para la aplicación Contenedor: multiple: varias revisiones pueden estar activas. Si no se proporciona ningún valor, esta es laúnica predeterminada: solo se puede activar una revisión a la vez. Los pesos de revisión no se pueden usar en este modo

Valor	Description
multiple
single

Configuration

Object

Propiedades de configuración de la aplicación contenedora no con versiones que definen la configuración mutable de una aplicación contenedora

Nombre	Tipo	Description
activeRevisionsMode	ActiveRevisionsMode	ActiveRevisionsMode controla cómo se controlan las revisiones activas para la aplicación Contenedor: multiple: varias revisiones pueden estar activas. Si no se proporciona ningún valor, esta es laúnica predeterminada: solo se puede activar una revisión a la vez. Los pesos de revisión no se pueden usar en este modo
ingress	Ingress	Configuraciones de entrada.
registries	RegistryCredentials[]	Recopilación de credenciales de registro de contenedor privado para contenedores usados por la aplicación contenedora
secrets	Secret[]	Colección de secretos usados por una aplicación contenedora

Container

Object

Definición de contenedor de la aplicación de contenedor.

Nombre	Tipo	Description
args	string[]	Argumentos de comando de inicio de contenedor.
command	string[]	Comando container start.
env	EnvironmentVar[]	Variables de entorno de contenedor.
image	string	Etiqueta de imagen de contenedor.
name	string	Nombre de contenedor personalizado.
resources	ContainerResources	Requisitos de recursos de contenedor.

ContainerApp

Object

Aplicación contenedora.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.configuration	Configuration	Propiedades de configuración de la aplicación contenedora sin control de versiones.
properties.kubeEnvironmentId	string	Identificador de recurso del entorno KubeEnvironment de la aplicación contenedora.
properties.latestRevisionFqdn	string	Nombre de dominio completo de la revisión más reciente de la aplicación contenedora.
properties.latestRevisionName	string	Nombre de la revisión más reciente de la aplicación contenedora.
properties.provisioningState	ContainerAppProvisioningState	Estado de aprovisionamiento de la aplicación contenedora.
properties.template	Template	Definición de aplicación con versión de aplicación contenedora.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

ContainerAppCollection

Object

Recurso arm de recopilación de aplicaciones de contenedor.

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

ContainerAppProvisioningState

Enumeración

Estado de aprovisionamiento de la aplicación contenedora.

Valor	Description
Canceled
Failed
InProgress
Succeeded

ContainerResources

Object

Requisitos de recursos de contenedor de la aplicación contenedora.

Nombre	Tipo	Description
cpu	number (double)	CPU necesaria en núcleos, por ejemplo, 0,5
memory	string	Memoria necesaria, por ejemplo, "250 Mb"

CustomScaleRule

Object

Regla de escalado personalizado del contenedor de aplicaciones de contenedor.

Nombre	Tipo	Description
auth	ScaleRuleAuth[]	Secretos de autenticación para la regla de escalado personalizada.
metadata	object	Propiedades de metadatos para describir la regla de escalado personalizada.
type	string	Tipo de la regla de escalado personalizada, por ejemplo: azure-servicebus, redis, etc.

Dapr

Object

Configuración de Dapr de la aplicación contenedora.

Nombre	Tipo	Description
appId	string	Identificador de aplicación dapr
appPort	integer (int32)	Puerto en el que el coche lateral de Dapr
components	DaprComponent[]	Colección de componentes de Dapr
enabled	boolean	Boolean que indica si el coche lateral dapr está habilitado

DaprComponent

Object

Configuración de componentes de Dapr

Nombre	Tipo	Description
metadata	DaprMetadata[]	Metadatos de componentes
name	string	Nombre del componente
type	string	Tipo de componente
version	string	Versión del componente

DaprMetadata

Object

Metadatos del componente Dapr de la aplicación contenedora.

Nombre	Tipo	Description
name	string	Nombre de propiedad de metadatos.
secretRef	string	Nombre del secreto de la aplicación contenedora del que se va a extraer el valor de la propiedad de metadatos.
value	string	Valor de propiedad de metadatos.

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.

EnvironmentVar

Object

Variable de entorno de contenedor de la aplicación contenedora.

Nombre	Tipo	Description
name	string	Nombre de la variable de entorno.
secretRef	string	Nombre del secreto de aplicación contenedora del que se va a extraer el valor de la variable de entorno.
value	string	Valor de variable de entorno no secreto.

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.

HttpScaleRule

Object

Regla de escalado personalizado del contenedor de aplicaciones de contenedor.

Nombre	Tipo	Description
auth	ScaleRuleAuth[]	Secretos de autenticación para la regla de escalado personalizada.
metadata	object	Propiedades de metadatos para describir la regla de escalado http.

Ingress

Object

Configuración de entrada de la aplicación contenedora.

Nombre	Tipo	Valor predeterminado	Description
allowInsecure	boolean		Bool que indica si se permiten conexiones HTTP a . Si se establece en conexiones HTTP falsas se redirige automáticamente a conexiones HTTPS.
external	boolean	False	Bool que indica si la aplicación expone un punto de conexión HTTP externo
fqdn	string		Nombre de host.
targetPort	integer (int32)		Puerto de destino en contenedores para el tráfico desde la entrada
traffic	TrafficWeight[]		Peso del tráfico asignado a una revisión
transport	IngressTransportMethod		Protocolo de transporte de entrada

IngressTransportMethod

Enumeración

Protocolo de transporte de entrada

Valor	Description
auto
http
http2

QueueScaleRule

Object

Regla de escalado basada en azure Queue del contenedor de aplicaciones de contenedor.

Nombre	Tipo	Description
auth	ScaleRuleAuth[]	Secretos de autenticación para la regla de escalado de colas.
queueLength	integer (int32)	Longitud de la cola.
queueName	string	Nombre de la cola.

RegistryCredentials

Object

Registro privado de aplicación de contenedor

Nombre	Tipo	Description
passwordSecretRef	string	Nombre del secreto que contiene la contraseña de inicio de sesión del Registro
server	string	Container Registry Server
username	string	Nombre de usuario de Container Registry

Scale

Object

Configuraciones de escalado de aplicaciones de contenedor.

Nombre	Tipo	Description
maxReplicas	integer (int32)	Opcional. Número máximo de réplicas de contenedor. El valor predeterminado es 10 si no se establece.
minReplicas	integer (int32)	Opcional. Número mínimo de réplicas de contenedor.
rules	ScaleRule[]	Reglas de escalado.

ScaleRule

Object

Regla de escalado de contenedores de aplicaciones de contenedor.

Nombre	Tipo	Description
azureQueue	QueueScaleRule	Escalado basado en cola de Azure.
custom	CustomScaleRule	Regla de escalado personalizada.
http	HttpScaleRule	Escalado basado en solicitudes HTTP.
name	string	Nombre de la regla de escalado

ScaleRuleAuth

Object

Secretos de autenticación para la regla de escalado de aplicaciones de contenedor

Nombre	Tipo	Description
secretRef	string	Nombre del secreto de la aplicación contenedora desde el que se van a extraer los parámetros de autenticación.
triggerParameter	string	Parámetro de desencadenador que usa el secreto

Secret

Object

Secreto de aplicación de contenedor.

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

Template

Object

Definición de aplicación con versión de aplicación contenedora. Define el estado deseado de una revisión inmutable. Los cambios realizados en esta sección darán lugar a una nueva revisión que se va a crear.

Nombre	Tipo	Description
containers	Container[]	Lista de definiciones de contenedor para la aplicación contenedora.
dapr	Dapr	Configuración de Dapr para la aplicación contenedora.
revisionSuffix	string	Sufijo descriptivo que se anexa al nombre de revisión
scale	Scale	Propiedades de escalado de la aplicación contenedora.

TrafficWeight

Object

Peso del tráfico asignado a una revisión

Nombre	Tipo	Valor predeterminado	Description
latestRevision	boolean	False	Indica que el peso del tráfico pertenece a una revisión estable más reciente.
revisionName	string		Nombre de una revisión
weight	integer (int32)		Peso del tráfico asignado a una revisión

Compartir a través de

Container Apps - List By Resource Group

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

List Container Apps by resource group

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ActiveRevisionsMode

Configuration

Container

ContainerApp

ContainerAppCollection

ContainerAppProvisioningState

ContainerResources

CustomScaleRule

Dapr

DaprComponent

DaprMetadata

DefaultErrorResponse

Details

EnvironmentVar

Error

HttpScaleRule

Ingress

IngressTransportMethod

QueueScaleRule

RegistryCredentials

Scale

ScaleRule

ScaleRuleAuth

Secret

Template

TrafficWeight