Container Apps - List By Resource Group

Referencia

Szolgáltatás:: App Service

API-verzió:: 2023-12-01

Kérje le a Container Appst egy adott erőforráscsoportban.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps?api-version=2023-12-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Azure-előfizetés azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Válaszok

Name	Típus	Description
200 OK	ContainerAppCollection	OKÉ
Other Status Codes	DefaultErrorResponse	App Service-hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

List Container Apps by resource group

Mintakérelem

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

Mintaválasz

Állapotkód:: 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
}

Definíciók

Name	Description
ActiveRevisionsMode	Az ActiveRevisionsMode szabályozza a tárolóalkalmazás aktív változatainak kezelését: Több: több változat is lehet aktív. Ha nincs megadva érték, ez az alapértelmezettEgyetlen: Egyszerre csak egy változat lehet aktív. A változat súlyozása ebben a módban nem használható
Configuration	Nem verziószámozott tárolóalkalmazás konfigurációs tulajdonságai, amelyek meghatározzák a tárolóalkalmazások módosítható beállításait
Container	Tárolóalkalmazás tárolódefiníciója.
ContainerApp	Tárolóalkalmazás.
ContainerAppCollection	Tárolóalkalmazás-gyűjtemény ARM-erőforrása.
ContainerAppProvisioningState	A tárolóalkalmazás kiépítési állapota.
ContainerResources	Tárolóalkalmazás tárolóerőforrás-követelményei.
CustomScaleRule	Tárolóalkalmazás egyéni skálázási szabálya.
Dapr	Tárolóalkalmazás Dapr-konfigurációja.
DaprComponent	Dapr-összetevő konfigurálása
DaprMetadata	A Container App Dapr összetevő metaadatai.
DefaultErrorResponse	App Service-hibaválasz.
Details
EnvironmentVar	Tárolóalkalmazás tárolókörnyezetének változója.
Error	Hibamodell.
HttpScaleRule	Tárolóalkalmazás egyéni skálázási szabálya.
Ingress	Tárolóalkalmazás bejövő forgalmának konfigurálása.
IngressTransportMethod	Bejövő átviteli protokoll
QueueScaleRule	Container App Container Container Azure Queue-alapú skálázási szabály.
RegistryCredentials	Tárolóalkalmazás privát beállításjegyzéke
Scale	Tárolóalkalmazás skálázási konfigurációi.
ScaleRule	Tárolóalkalmazás tárolóméretezési szabálya.
ScaleRuleAuth	A tárolóalkalmazás méretezési szabályának hitelesítési titkos kódjai
Secret	Tárolóalkalmazás titkos kódja.
Template	Tárolóalkalmazás verziószámozott alkalmazásdefiníciója. Meghatározza a nem módosítható változat kívánt állapotát. A szakasz bármely módosítása új változat létrehozását eredményezi
TrafficWeight	A korrektúra forgalmi súlyának hozzárendelése

ActiveRevisionsMode

Enumerálás

Az ActiveRevisionsMode szabályozza a tárolóalkalmazás aktív változatainak kezelését: Több: több változat is lehet aktív. Ha nincs megadva érték, ez az alapértelmezettEgyetlen: Egyszerre csak egy változat lehet aktív. A változat súlyozása ebben a módban nem használható

Érték	Description
multiple
single

Configuration

Objektum

Nem verziószámozott tárolóalkalmazás konfigurációs tulajdonságai, amelyek meghatározzák a tárolóalkalmazások módosítható beállításait

Name	Típus	Description
activeRevisionsMode	ActiveRevisionsMode	Az ActiveRevisionsMode szabályozza a tárolóalkalmazás aktív változatainak kezelését: Több: több változat is lehet aktív. Ha nincs megadva érték, ez az alapértelmezettEgyetlen: Egyszerre csak egy változat lehet aktív. A változat súlyozása ebben a módban nem használható
ingress	Ingress	Bejövő konfigurációk.
registries	RegistryCredentials[]	A tárolóalkalmazás által használt tárolókhoz tartozó privát tárolóregisztrációs adatbázis hitelesítő adatainak gyűjteménye
secrets	Secret[]	Tárolóalkalmazás által használt titkos kulcsok gyűjteménye

Container

Objektum

Tárolóalkalmazás tárolódefiníciója.

Name	Típus	Description
args	string[]	Tárolóindítási parancs argumentumai.
command	string[]	Tárolóindítási parancs.
env	EnvironmentVar[]	Tárolókörnyezet változói.
image	string	Tárolórendszerkép címkéje.
name	string	Egyéni tároló neve.
resources	ContainerResources	Tárolóerőforrás-követelmények.

ContainerApp

Objektum

Tárolóalkalmazás.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.configuration	Configuration	Nem verziószámozott tárolóalkalmazás konfigurációs tulajdonságai.
properties.kubeEnvironmentId	string	A tárolóalkalmazás KubeEnvironment erőforrás-azonosítója.
properties.latestRevisionFqdn	string	A tárolóalkalmazás legújabb változatának teljes tartományneve.
properties.latestRevisionName	string	A tárolóalkalmazás legújabb változatának neve.
properties.provisioningState	ContainerAppProvisioningState	A tárolóalkalmazás kiépítési állapota.
properties.template	Template	Tárolóalkalmazás verziószámozott alkalmazásdefiníciója.
tags	object	Erőforráscímkék.
type	string	Erőforrás típusa.

ContainerAppCollection

Objektum

Tárolóalkalmazás-gyűjtemény ARM-erőforrása.

Name	Típus	Description
nextLink	string	Hivatkozás az erőforrások következő oldalára.
value	ContainerApp[]	Erőforrások gyűjteménye.

ContainerAppProvisioningState

Enumerálás

A tárolóalkalmazás kiépítési állapota.

Érték	Description
Canceled
Failed
InProgress
Succeeded

ContainerResources

Objektum

Tárolóalkalmazás tárolóerőforrás-követelményei.

Name	Típus	Description
cpu	number (double)	Szükséges processzor a magokban, pl. 0,5
memory	string	Szükséges memória, pl. "250 Mb"

CustomScaleRule

Objektum

Tárolóalkalmazás egyéni skálázási szabálya.

Name	Típus	Description
auth	ScaleRuleAuth[]	Az egyéni méretezési szabály hitelesítési titkos kódjai.
metadata	object	Metaadat-tulajdonságok az egyéni méretezési szabály leírásához.
type	string	Az egyéni méretezési szabály típusa, például: azure-servicebus, redis stb.

Dapr

Objektum

Tárolóalkalmazás Dapr-konfigurációja.

Name	Típus	Description
appId	string	Dapr-alkalmazás azonosítója
appPort	integer (int32)	Port, amelyen a Dapr oldalkocsi
components	DaprComponent[]	Dapr-összetevők gyűjteménye
enabled	boolean	Logikai érték, amely jelzi, hogy a Dapr oldalkocsi engedélyezve van-e

DaprComponent

Objektum

Dapr-összetevő konfigurálása

Name	Típus	Description
metadata	DaprMetadata[]	Összetevő metaadatai
name	string	Összetevő neve
type	string	Alkatrésztípus
version	string	Összetevő verziója

DaprMetadata

Objektum

A Container App Dapr összetevő metaadatai.

Name	Típus	Description
name	string	Metaadat-tulajdonság neve.
secretRef	string	Annak a tárolóalkalmazás-titkos kódnak a neve, amelyből le szeretné húzni a metaadat-tulajdonság értékét.
value	string	Metaadat-tulajdonság értéke.

DefaultErrorResponse

Objektum

App Service-hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Objektum

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

EnvironmentVar

Objektum

Tárolóalkalmazás tárolókörnyezetének változója.

Name	Típus	Description
name	string	Környezeti változó neve.
secretRef	string	Annak a tárolóalkalmazás-titkos kódnak a neve, amelyből le szeretné húzni a környezeti változó értékét.
value	string	Nem titkos környezeti változó értéke.

Error

Objektum

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakereséshez.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

HttpScaleRule

Objektum

Tárolóalkalmazás egyéni skálázási szabálya.

Name	Típus	Description
auth	ScaleRuleAuth[]	Az egyéni méretezési szabály hitelesítési titkos kódjai.
metadata	object	Metaadat-tulajdonságok a http-méretezési szabály leírásához.

Ingress

Objektum

Tárolóalkalmazás bejövő forgalmának konfigurálása.

Name	Típus	Alapértelmezett érték	Description
allowInsecure	boolean		Bool jelzi, hogy a HTTP-kapcsolatok engedélyezettek-e. Ha hamis HTTP-kapcsolatokra van beállítva, a rendszer automatikusan HTTPS-kapcsolatokra irányítja át
external	boolean	False	Bool jelzi, hogy az alkalmazás külső HTTP-végpontot tesz-e elérhetővé
fqdn	string		Állomásnév.
targetPort	integer (int32)		Tárolók célportja bejövő forgalomhoz
traffic	TrafficWeight[]		A korrektúra forgalmi súlyának hozzárendelése
transport	IngressTransportMethod		Bejövő átviteli protokoll

IngressTransportMethod

Enumerálás

Bejövő átviteli protokoll

Érték	Description
auto
http
http2

QueueScaleRule

Objektum

Container App Container Container Azure Queue-alapú skálázási szabály.

Name	Típus	Description
auth	ScaleRuleAuth[]	Az üzenetsor-méretezési szabály hitelesítési titkos kódjai.
queueLength	integer (int32)	Üzenetsor hossza.
queueName	string	Üzenetsor neve.

RegistryCredentials

Objektum

Tárolóalkalmazás privát beállításjegyzéke

Name	Típus	Description
passwordSecretRef	string	A beállításjegyzék bejelentkezési jelszavát tartalmazó titkos kód neve
server	string	Tárolóregisztrációs adatbázis-kiszolgáló
username	string	Tárolóregisztrációs adatbázis felhasználóneve

Scale

Objektum

Tárolóalkalmazás skálázási konfigurációi.

Name	Típus	Description
maxReplicas	integer (int32)	Szabadon választható. Tárolóreplikák maximális száma. Alapértelmezés szerint 10, ha nincs beállítva.
minReplicas	integer (int32)	Szabadon választható. Tárolóreplikák minimális száma.
rules	ScaleRule[]	Skálázási szabályok.

ScaleRule

Objektum

Tárolóalkalmazás tárolóméretezési szabálya.

Name	Típus	Description
azureQueue	QueueScaleRule	Azure Queue-alapú skálázás.
custom	CustomScaleRule	Egyéni méretezési szabály.
http	HttpScaleRule	HTTP-kérések alapú skálázás.
name	string	Szabály skálázása

ScaleRuleAuth

Objektum

A tárolóalkalmazás méretezési szabályának hitelesítési titkos kódjai

Name	Típus	Description
secretRef	string	Annak a tárolóalkalmazás-titkos kódnak a neve, amelyből le szeretné húzni a hitelesítési paramétereket.
triggerParameter	string	A titkos kulcsot használó triggerparaméter

Secret

Objektum

Tárolóalkalmazás titkos kódja.

Name	Típus	Description
name	string	Titkos név.
value	string	Titkos kódérték.

Template

Objektum

Tárolóalkalmazás verziószámozott alkalmazásdefiníciója. Meghatározza a nem módosítható változat kívánt állapotát. A szakasz bármely módosítása új változat létrehozását eredményezi

Name	Típus	Description
containers	Container[]	A tárolóalkalmazás tárolódefinícióinak listája.
dapr	Dapr	Dapr-konfiguráció a tárolóalkalmazáshoz.
revisionSuffix	string	A korrektúra nevéhez fűzött felhasználóbarát utótag
scale	Scale	A tárolóalkalmazás skálázási tulajdonságai.

TrafficWeight

Objektum

A korrektúra forgalmi súlyának hozzárendelése

Name	Típus	Alapértelmezett érték	Description
latestRevision	boolean	False	Azt jelzi, hogy a forgalom súlya egy legújabb stabil változathoz tartozik
revisionName	string		Változat neve
weight	integer (int32)		A korrektúra forgalmi súlyának hozzárendelése

Megosztás a következőn keresztül:

Container Apps - List By Resource Group

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

List Container Apps by resource group

Mintakérelem

Mintaválasz

Definíciók

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