Container Apps - Get

Service:

Azure Container Apps

Version d'API:

2024-03-01

Obtenez les propriétés d’une application conteneur.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}?api-version=2024-03-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
containerAppName	path	True	string	Nom de l’application conteneur.
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ContainerApp	OK.
404 Not Found		Introuvable.
Other Status Codes	DefaultErrorResponse	Réponse d’erreur courante.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Get Container App

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0?api-version=2024-03-01

Java

/**
 * Samples for ContainerApps GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_Get.json
     */
    /**
     * Sample code: Get Container App.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void getContainerApp(com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.containerApps().getByResourceGroupWithResponse("rg", "testcontainerapp0",
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcontainers import ContainerAppsAPIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python container_apps_get.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 = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.container_apps_diagnostics.get_root(
        resource_group_name="rg",
        container_app_name="testcontainerapp0",
    )
    print(response)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_Get.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

Go

package armappcontainers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edf14cc0a577f6b9c4e3ce018cec0c383e64b7b0/specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_Get.json
func ExampleContainerAppsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsClient().Get(ctx, "rg", "testcontainerapp0", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ContainerApp = armappcontainers.ContainerApp{
	// 	Name: to.Ptr("testcontainerapp0"),
	// 	Type: to.Ptr("Microsoft.App/containerApps"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armappcontainers.ContainerAppProperties{
	// 		Configuration: &armappcontainers.Configuration{
	// 			Dapr: &armappcontainers.Dapr{
	// 				AppPort: to.Ptr[int32](3000),
	// 				AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
	// 				EnableAPILogging: to.Ptr(true),
	// 				Enabled: to.Ptr(true),
	// 				HTTPMaxRequestSize: to.Ptr[int32](10),
	// 				HTTPReadBufferSize: to.Ptr[int32](30),
	// 				LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
	// 			},
	// 			Ingress: &armappcontainers.Ingress{
	// 				CustomDomains: []*armappcontainers.CustomDomain{
	// 					{
	// 						Name: to.Ptr("www.my-name.com"),
	// 						BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
	// 						CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"),
	// 					},
	// 					{
	// 						Name: to.Ptr("www.my--other-name.com"),
	// 						BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
	// 						CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
	// 				}},
	// 				External: to.Ptr(true),
	// 				Fqdn: to.Ptr("testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
	// 				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
	// 					{
	// 						Name: to.Ptr("Allow work IP A subnet"),
	// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
	// 						Action: to.Ptr(armappcontainers.ActionAllow),
	// 						IPAddressRange: to.Ptr("192.168.1.1/32"),
	// 					},
	// 					{
	// 						Name: to.Ptr("Allow work IP B subnet"),
	// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
	// 						Action: to.Ptr(armappcontainers.ActionAllow),
	// 						IPAddressRange: to.Ptr("192.168.1.1/8"),
	// 				}},
	// 				StickySessions: &armappcontainers.IngressStickySessions{
	// 					Affinity: to.Ptr(armappcontainers.AffinitySticky),
	// 				},
	// 				TargetPort: to.Ptr[int32](3000),
	// 				Traffic: []*armappcontainers.TrafficWeight{
	// 					{
	// 						RevisionName: to.Ptr("testcontainerapp0-ab1234"),
	// 						Weight: to.Ptr[int32](80),
	// 					},
	// 					{
	// 						Label: to.Ptr("staging"),
	// 						RevisionName: to.Ptr("testcontainerapp0-ab4321"),
	// 						Weight: to.Ptr[int32](20),
	// 				}},
	// 				Transport: to.Ptr(armappcontainers.IngressTransportMethodAuto),
	// 			},
	// 			MaxInactiveRevisions: to.Ptr[int32](10),
	// 			Service: &armappcontainers.Service{
	// 				Type: to.Ptr("redis"),
	// 			},
	// 		},
	// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
	// 		LatestReadyRevisionName: to.Ptr("testcontainerapp0-pjxhsye"),
	// 		LatestRevisionFqdn: to.Ptr("testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
	// 		ManagedEnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
	// 		ProvisioningState: to.Ptr(armappcontainers.ContainerAppProvisioningStateSucceeded),
	// 		Template: &armappcontainers.Template{
	// 			Containers: []*armappcontainers.Container{
	// 				{
	// 					Name: to.Ptr("testcontainerapp0"),
	// 					Image: to.Ptr("repo/testcontainerapp0:v4"),
	// 					Resources: &armappcontainers.ContainerResources{
	// 						CPU: to.Ptr[float64](0.5),
	// 						Memory: to.Ptr("1Gi"),
	// 					},
	// 			}},
	// 			InitContainers: []*armappcontainers.InitContainer{
	// 				{
	// 					Name: to.Ptr("testinitcontainerApp0"),
	// 					Image: to.Ptr("repo/testcontainerapp0:v4"),
	// 					Resources: &armappcontainers.ContainerResources{
	// 						CPU: to.Ptr[float64](0.5),
	// 						Memory: to.Ptr("1Gi"),
	// 					},
	// 			}},
	// 			Scale: &armappcontainers.Scale{
	// 				MaxReplicas: to.Ptr[int32](5),
	// 				MinReplicas: to.Ptr[int32](1),
	// 				Rules: []*armappcontainers.ScaleRule{
	// 					{
	// 						Name: to.Ptr("httpscalingrule"),
	// 						HTTP: &armappcontainers.HTTPScaleRule{
	// 							Metadata: map[string]*string{
	// 								"concurrentRequests": to.Ptr("50"),
	// 							},
	// 						},
	// 				}},
	// 			},
	// 			ServiceBinds: []*armappcontainers.ServiceBind{
	// 				{
	// 					Name: to.Ptr("service"),
	// 					ServiceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service"),
	// 			}},
	// 		},
	// 		WorkloadProfileName: to.Ptr("My-GP-01"),
	// 	},
	// }
}

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

JavaScript

const { ContainerAppsAPIClient } = require("@azure/arm-appcontainers");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the properties of a Container App.
 *
 * @summary Get the properties of a Container App.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_Get.json
 */
async function getContainerApp() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPCONTAINERS_RESOURCE_GROUP"] || "rg";
  const containerAppName = "testcontainerapp0";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const result = await client.containerApps.get(resourceGroupName, containerAppName);
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppContainers.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppContainers;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_Get.json
// this example is just showing the usage of "ContainerApps_Get" 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 ContainerAppResource created on azure
// for more information of creating ContainerAppResource, please refer to the document of ContainerAppResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string containerAppName = "testcontainerapp0";
ResourceIdentifier containerAppResourceId = ContainerAppResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, containerAppName);
ContainerAppResource containerApp = client.GetContainerAppResource(containerAppResourceId);

// invoke the operation
ContainerAppResource result = await containerApp.GetAsync();

// the variable result 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
ContainerAppData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exemple de réponse

Code d’état:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0",
  "name": "testcontainerapp0",
  "type": "Microsoft.App/containerApps",
  "location": "East US",
  "properties": {
    "provisioningState": "Succeeded",
    "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
    "workloadProfileName": "My-GP-01",
    "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
    "latestReadyRevisionName": "testcontainerapp0-pjxhsye",
    "configuration": {
      "ingress": {
        "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io",
        "external": true,
        "targetPort": 3000,
        "transport": "auto",
        "customDomains": [
          {
            "name": "www.my-name.com",
            "bindingType": "SniEnabled",
            "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"
          },
          {
            "name": "www.my--other-name.com",
            "bindingType": "SniEnabled",
            "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"
          }
        ],
        "traffic": [
          {
            "weight": 80,
            "revisionName": "testcontainerapp0-ab1234"
          },
          {
            "weight": 20,
            "revisionName": "testcontainerapp0-ab4321",
            "label": "staging"
          }
        ],
        "ipSecurityRestrictions": [
          {
            "name": "Allow work IP A subnet",
            "description": "Allowing all IP's within the subnet below to access containerapp",
            "ipAddressRange": "192.168.1.1/32",
            "action": "Allow"
          },
          {
            "name": "Allow work IP B subnet",
            "description": "Allowing all IP's within the subnet below to access containerapp",
            "ipAddressRange": "192.168.1.1/8",
            "action": "Allow"
          }
        ],
        "stickySessions": {
          "affinity": "sticky"
        }
      },
      "dapr": {
        "enabled": true,
        "appPort": 3000,
        "appProtocol": "http",
        "httpReadBufferSize": 30,
        "httpMaxRequestSize": 10,
        "logLevel": "debug",
        "enableApiLogging": true
      },
      "maxInactiveRevisions": 10,
      "service": {
        "type": "redis"
      }
    },
    "template": {
      "containers": [
        {
          "image": "repo/testcontainerapp0:v4",
          "name": "testcontainerapp0",
          "resources": {
            "cpu": 0.5,
            "memory": "1Gi"
          }
        }
      ],
      "initContainers": [
        {
          "image": "repo/testcontainerapp0:v4",
          "name": "testinitcontainerApp0",
          "resources": {
            "cpu": 0.5,
            "memory": "1Gi"
          }
        }
      ],
      "scale": {
        "minReplicas": 1,
        "maxReplicas": 5,
        "rules": [
          {
            "name": "httpscalingrule",
            "http": {
              "metadata": {
                "concurrentRequests": "50"
              }
            }
          }
        ]
      },
      "serviceBinds": [
        {
          "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service",
          "name": "service"
        }
      ]
    },
    "eventStreamEndpoint": "testEndpoint"
  }
}

Code d’état:

404

Définitions

Nom	Description
action	Autoriser ou refuser les règles à déterminer pour l’adresse IP entrante. Remarque : Les règles peuvent uniquement se composer de ALL Allow ou ALL Deny
ActiveRevisionsMode	ActiveRevisionsMode contrôle la façon dont les révisions actives sont gérées pour l’application conteneur : Multiple : plusieurs révisions peuvent être actives.Unique : une seule révision peut être active à la fois. Les pondérations de révision ne peuvent pas être utilisées dans ce mode. Si aucune valeur n’est fournie, il s’agit de la valeur par défaut.
affinity	Affinité de session collante
appProtocol	Indique à Dapr quel protocole votre application utilise. Les options valides sont http et grpc. La valeur par défaut est http
bindingType	Custom Domain type de liaison.
Configuration	Propriétés de configuration d’application conteneur sans version qui définissent les paramètres mutables d’une application conteneur
Container	Définition de conteneur d’application conteneur
ContainerApp	Application conteneur.
ContainerAppProbe	Sonde décrit une case activée d’intégrité à effectuer sur un conteneur pour déterminer s’il est actif ou prêt à recevoir du trafic.
ContainerAppProvisioningState	État d’approvisionnement de l’application conteneur.
ContainerResources	Exigences en ressources de conteneur d’application conteneur.
CorsPolicy	Stratégie de partage des ressources entre les origines
createdByType	Type d’identité qui a créé la ressource.
CustomDomain	Custom Domain d’une application conteneur
CustomScaleRule	Conteneur d’application conteneur Règle de mise à l’échelle personnalisée.
Dapr	Configuration de Dapr d’application conteneur.
DefaultErrorResponse	App Service réponse d’erreur.
Details	Détails ou erreur
EnvironmentVar	Variable d’environnement conteneur Container App.
Error	Modèle d’erreur.
ExtendedLocation	Type complexe de l’emplacement étendu.
ExtendedLocationTypes	Type de l’emplacement étendu.
HttpGet	HTTPGet spécifie la requête http à effectuer.
HttpHeaders	En-têtes personnalisés à définir dans la demande. HTTP autorise les en-têtes répétés.
HttpScaleRule	Règle de mise à l’échelle Http du conteneur d’application conteneur.
Ingress	Configuration de l’entrée d’application conteneur.
IngressClientCertificateMode	Mode certificat client pour l’authentification mTLS. Ignorer indique que le serveur supprime le certificat client lors du transfert. Accept indique que le serveur transfère le certificat client, mais ne nécessite pas de certificat client. Exiger indique que le serveur a besoin d’un certificat client.
IngressPortMapping	Mappages de ports d’entrée d’application conteneur
IngressTransportMethod	Protocole de transport d’entrée
InitContainer	Définition de conteneur d’init d’application conteneur
IpSecurityRestrictionRule	Règle pour restreindre l’adresse IP entrante.
logLevel	Définit le niveau de journal pour le side-car Dapr. Les valeurs autorisées sont débogage, informations, avertissement, erreur. La valeur par défaut est info.
ManagedServiceIdentity	Identité de service managée (identités attribuées par le système et/ou attribuées par l’utilisateur)
ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
QueueScaleRule	Règle de mise à l’échelle basée sur la file d’attente Azure de conteneur d’application conteneur.
RegistryCredentials	Registre privé d’application de conteneur
Scale	Configurations de mise à l’échelle d’application conteneur.
ScaleRule	Règle de mise à l’échelle de conteneur d’application conteneur.
ScaleRuleAuth	Secrets d’authentification pour la règle d’échelle
Scheme	Schéma à utiliser pour la connexion à l’hôte. La valeur par défaut est HTTP.
Secret	Définition du secret.
SecretVolumeItem	Secret à ajouter au volume.
Service	Container App pour être un service de développement
ServiceBind	Configuration pour lier un ContainerApp à un service ContainerApp de développement
StickySessions	Sessions collantes pour le mode révision unique
StorageType	Type de stockage pour le volume. S’il n’est pas fourni, utilisez EmptyDir.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TcpScaleRule	Règle de mise à l’échelle tcp du conteneur Container App.
TcpSocket	TCPSocket spécifie une action impliquant un port TCP. Les crochets TCP ne sont pas encore pris en charge.
Template	Définition d’application avec version d’application conteneur. Définit l’état souhaité d’une révision immuable. Toute modification apportée à cette section entraîne la création d’une nouvelle révision
TrafficWeight	Poids du trafic attribué à une révision
Type	Type de sonde.
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur
Volume	Définitions de volume pour l’application conteneur.
VolumeMount	Montage de volume pour l’application conteneur.

action

Autoriser ou refuser les règles à déterminer pour l’adresse IP entrante. Remarque : Les règles peuvent uniquement se composer de ALL Allow ou ALL Deny

Nom	Type	Description
Allow	string
Deny	string

ActiveRevisionsMode

ActiveRevisionsMode contrôle la façon dont les révisions actives sont gérées pour l’application conteneur : Multiple : plusieurs révisions peuvent être actives.Unique : une seule révision peut être active à la fois. Les pondérations de révision ne peuvent pas être utilisées dans ce mode. Si aucune valeur n’est fournie, il s’agit de la valeur par défaut.

Nom	Type	Description
Multiple	string
Single	string

affinity

Affinité de session collante

Nom	Type	Description
none	string
sticky	string

appProtocol

Indique à Dapr quel protocole votre application utilise. Les options valides sont http et grpc. La valeur par défaut est http

Nom	Type	Description
grpc	string
http	string

bindingType

Custom Domain type de liaison.

Nom	Type	Description
Disabled	string
SniEnabled	string

Configuration

Propriétés de configuration d’application conteneur sans version qui définissent les paramètres mutables d’une application conteneur

Nom	Type	Valeur par défaut	Description
activeRevisionsMode	ActiveRevisionsMode	Single	ActiveRevisionsMode contrôle la façon dont les révisions actives sont gérées pour l’application conteneur : Multiple : plusieurs révisions peuvent être actives.Unique : une seule révision peut être active à la fois. Les pondérations de révision ne peuvent pas être utilisées dans ce mode. Si aucune valeur n’est fournie, il s’agit de la valeur par défaut.
dapr	Dapr		Configuration de Dapr pour l’application conteneur.
ingress	Ingress		Configurations d’entrée.
maxInactiveRevisions	integer		facultatif. Nombre maximal de révisions inactives qu’une application conteneur peut avoir.
registries	RegistryCredentials[]		Collection d’informations d’identification de registre de conteneurs privés pour les conteneurs utilisés par l’application conteneur
secrets	Secret[]		Collection de secrets utilisés par une application conteneur
service	Service		Container App pour être un conteneur de développement App Service

Container

Définition de conteneur d’application conteneur

Nom	Type	Description
args	string[]	Arguments de commande de démarrage du conteneur.
command	string[]	Commande de démarrage du conteneur.
env	EnvironmentVar[]	Variables d’environnement de conteneur.
image	string	Balise d’image conteneur.
name	string	Nom du conteneur personnalisé.
probes	ContainerAppProbe[]	Liste des sondes pour le conteneur.
resources	ContainerResources	Besoins en ressources de conteneur.
volumeMounts	VolumeMount[]	Montages de volume de conteneur.

ContainerApp

Application conteneur.

Nom	Type	Description
extendedLocation	ExtendedLocation	Type complexe de l’emplacement étendu.
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	identités managées permettant à l’application conteneur d’interagir avec d’autres services Azure sans conserver de secrets ou d’informations d’identification dans le code.
location	string	Emplacement géographique où réside la ressource
managedBy	string	ID de ressource complet de la ressource qui gère cette ressource. Indique si cette ressource est gérée par une autre ressource Azure. Si cela est présent, le déploiement en mode complet ne supprimera pas la ressource si elle est supprimée du modèle, car elle est gérée par une autre ressource.
name	string	nom de la ressource.
properties.configuration	Configuration	Propriétés de configuration d’application conteneur non versionnée.
properties.customDomainVerificationId	string	ID utilisé pour vérifier la propriété du nom de domaine
properties.environmentId	string	ID de ressource de l’environnement.
properties.eventStreamEndpoint	string	Point de terminaison du flux d’événements de l’application conteneur.
properties.latestReadyRevisionName	string	Nom de la dernière révision prête de l’application conteneur.
properties.latestRevisionFqdn	string	Nom de domaine complet de la dernière révision de l’application conteneur.
properties.latestRevisionName	string	Nom de la dernière révision de l’application conteneur.
properties.managedEnvironmentId	string	Action déconseillée. ID de ressource de l’environnement de l’application conteneur.
properties.outboundIpAddresses	string[]	Adresses IP sortantes pour l’application conteneur.
properties.provisioningState	ContainerAppProvisioningState	État d’approvisionnement de l’application conteneur.
properties.template	Template	Définition d’application avec version d’application conteneur.
properties.workloadProfileName	string	Nom du profil de charge de travail à épingler pour l’exécution de l’application conteneur.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ContainerAppProbe

Sonde décrit une case activée d’intégrité à effectuer sur un conteneur pour déterminer s’il est actif ou prêt à recevoir du trafic.

Nom	Type	Description
failureThreshold	integer	Échecs consécutifs minimaux pour que la sonde soit considérée comme ayant échoué après avoir réussi. La valeur par défaut est 3. La valeur minimale est 1. La valeur maximale est 10.
httpGet	HttpGet	HTTPGet spécifie la requête http à effectuer.
initialDelaySeconds	integer	Nombre de secondes après le démarrage du conteneur avant le lancement des probes liveness. La valeur minimale est 1. La valeur maximale est 60.
periodSeconds	integer	Fréquence (en secondes) d’exécution de la probe. La valeur par défaut est 10 secondes. La valeur minimale est 1. La valeur maximale est 240.
successThreshold	integer	Réussites consécutives minimales pour que la sonde soit considérée comme ayant réussi après l’échec. La valeur par défaut est de 1. Doit être 1 pour le liveness et le démarrage. La valeur minimale est 1. La valeur maximale est 10.
tcpSocket	TcpSocket	TCPSocket spécifie une action impliquant un port TCP. Les crochets TCP ne sont pas encore pris en charge.
terminationGracePeriodSeconds	integer	Durée facultative en secondes, le pod doit se terminer correctement en cas d’échec de la sonde. La période de grâce est la durée en secondes après l’envoi d’un signal de terminaison aux processus en cours d’exécution dans le pod et la durée pendant laquelle les processus sont arrêtés de force avec un signal d’arrêt. Définissez cette valeur plus longtemps que le temps de nettoyage prévu pour votre processus. Si cette valeur est nulle, l’option terminationGracePeriodSeconds du pod est utilisée. Sinon, cette valeur remplace la valeur fournie par la spécification pod. La valeur doit être un entier non négatif. La valeur zéro indique l’arrêt immédiat via le signal d’arrêt (aucune possibilité d’arrêt). Il s’agit d’un champ alpha qui nécessite l’activation de la porte de fonctionnalité ProbeTerminationGracePeriod. La valeur maximale est de 3600 secondes (1 heure)
timeoutSeconds	integer	Nombre de secondes après lesquelles la sonde expire. La valeur par défaut est 1 seconde. La valeur minimale est 1. La valeur maximale est 240.
type	Type	Type de sonde.

ContainerAppProvisioningState

État d’approvisionnement de l’application conteneur.

Nom	Type	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

ContainerResources

Exigences en ressources de conteneur d’application conteneur.

Nom	Type	Description
cpu	number	Processeur requis dans les cœurs, par exemple 0,5
ephemeralStorage	string	Stockage éphémère, par exemple « 1Gi »
memory	string	Mémoire requise, par exemple « 250 Mo »

CorsPolicy

Stratégie de partage des ressources entre les origines

Nom	Type	Description
allowCredentials	boolean	Spécifie si la ressource autorise les informations d’identification
allowedHeaders	string[]	Spécifie le contenu de l’en-tête access-control-allow-headers
allowedMethods	string[]	Spécifie le contenu de l’en-tête access-control-allow-methods
allowedOrigins	string[]	Spécifie le contenu de l’en-tête access-control-allow-origins
exposeHeaders	string[]	Spécifie le contenu de l’en-tête access-control-expose-headers
maxAge	integer	Spécifie le contenu de l’en-tête access-control-max-age

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomain

Custom Domain d’une application conteneur

Nom	Type	Description
bindingType	bindingType	Custom Domain type de liaison.
certificateId	string	ID de ressource du certificat à lier à ce nom d’hôte. Doit exister dans l’environnement managé.
name	string	Nom d'hôte.

CustomScaleRule

Conteneur d’application conteneur Règle de mise à l’échelle personnalisée.

Nom	Type	Description
auth	ScaleRuleAuth[]	Secrets d’authentification pour la règle de mise à l’échelle personnalisée.
metadata	object	Propriétés de métadonnées pour décrire une règle de mise à l’échelle personnalisée.
type	string	Type de la règle de mise à l’échelle personnalisée, par exemple : azure-servicebus, redis, etc.

Dapr

Configuration de Dapr d’application conteneur.

Nom	Type	Valeur par défaut	Description
appId	string		Identificateur d’application Dapr
appPort	integer		Indique à Dapr le port sur lequel votre application écoute
appProtocol	appProtocol	http	Indique à Dapr quel protocole votre application utilise. Les options valides sont http et grpc. La valeur par défaut est http
enableApiLogging	boolean		Active la journalisation des API pour le side-car Dapr
enabled	boolean	False	Boolean indiquant si le side car Dapr est activé
httpMaxRequestSize	integer		Augmentation de la taille maximale du paramètre de serveurs http et grpc du corps de la requête en Mo pour gérer le chargement de fichiers volumineux. La valeur par défaut est de 4 Mo.
httpReadBufferSize	integer		Taille maximale dapr de la mémoire tampon de lecture d’en-tête http en Ko à gérer lors de l’envoi d’en-têtes de plusieurs ko. La valeur par défaut est de 65 Ko.
logLevel	logLevel		Définit le niveau de journal pour le side-car Dapr. Les valeurs autorisées sont débogage, informations, avertissement, erreur. La valeur par défaut est info.

DefaultErrorResponse

App Service réponse d’erreur.

Nom	Type	Description
error	Error	Modèle d’erreur.

Details

Détails ou erreur

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

EnvironmentVar

Variable d’environnement conteneur Container App.

Nom	Type	Description
name	string	Nom de la variable d'environnement.
secretRef	string	Nom du secret Container App à partir duquel extraire la valeur de la variable d’environnement.
value	string	Valeur de variable d’environnement non secrète.

Error

Modèle d’erreur.

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
details	Details[]	Détails ou erreur
innererror	string	Plus d’informations sur l’erreur de débogage.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

ExtendedLocation

Type complexe de l’emplacement étendu.

Nom	Type	Description
name	string	Nom de l’emplacement étendu.
type	ExtendedLocationTypes	Type de l’emplacement étendu.

ExtendedLocationTypes

Type de l’emplacement étendu.

Nom	Type	Description
CustomLocation	string

HttpGet

HTTPGet spécifie la requête http à effectuer.

Nom	Type	Description
host	string	Le nom d’hôte auquel se connecter est défini par défaut sur l’ADRESSE IP du pod. Vous souhaitez probablement définir « Host » dans httpHeaders à la place.
httpHeaders	HttpHeaders[]	En-têtes personnalisés à définir dans la demande. HTTP autorise les en-têtes répétés.
path	string	Chemin d’accès sur le serveur HTTP.
port	integer	Nom ou numéro du port à accéder sur le conteneur. Le nombre doit être compris entre 1 et 65535. Le nom doit être un IANA_SVC_NAME.
scheme	Scheme	Schéma à utiliser pour la connexion à l’hôte. La valeur par défaut est HTTP.

HttpHeaders

En-têtes personnalisés à définir dans la demande. HTTP autorise les en-têtes répétés.

Nom	Type	Description
name	string	Nom du champ d’en-tête
value	string	Valeur du champ d’en-tête

HttpScaleRule

Règle de mise à l’échelle Http du conteneur d’application conteneur.

Nom	Type	Description
auth	ScaleRuleAuth[]	Secrets d’authentification pour la règle de mise à l’échelle personnalisée.
metadata	object	Propriétés de métadonnées pour décrire la règle de mise à l’échelle http.

Ingress

Configuration de l’entrée d’application conteneur.

Nom	Type	Valeur par défaut	Description
additionalPortMappings	IngressPortMapping[]		Paramètres pour exposer des ports supplémentaires sur l’application conteneur
allowInsecure	boolean	False	Bool indiquant si les connexions HTTP à sont autorisées. Si la valeur est false HTTP, les connexions sont automatiquement redirigées vers les connexions HTTPS
clientCertificateMode	IngressClientCertificateMode		Mode certificat client pour l’authentification mTLS. Ignorer indique que le serveur supprime le certificat client lors du transfert. Accept indique que le serveur transfère le certificat client, mais ne nécessite pas de certificat client. Exiger indique que le serveur a besoin d’un certificat client.
corsPolicy	CorsPolicy		Stratégie CORS pour l’application conteneur
customDomains	CustomDomain[]		liaisons de domaine personnalisées pour les noms d’hôte de Container Apps.
exposedPort	integer		Port exposé dans les conteneurs pour le trafic TCP d’entrée
external	boolean	False	Bool indiquant si l’application expose un point de terminaison http externe
fqdn	string		Nom d'hôte.
ipSecurityRestrictions	IpSecurityRestrictionRule[]		Règles pour restreindre l’adresse IP entrante.
stickySessions	StickySessions		Sessions collantes pour le mode révision unique
targetPort	integer		Port cible dans les conteneurs pour le trafic d’entrée
traffic	TrafficWeight[]		Pondérations du trafic pour les révisions de l’application
transport	IngressTransportMethod	auto	Protocole de transport d’entrée

IngressClientCertificateMode

Mode certificat client pour l’authentification mTLS. Ignorer indique que le serveur supprime le certificat client lors du transfert. Accept indique que le serveur transfère le certificat client, mais ne nécessite pas de certificat client. Exiger indique que le serveur a besoin d’un certificat client.

Nom	Type	Description
accept	string
ignore	string
require	string

IngressPortMapping

Mappages de ports d’entrée d’application conteneur

Nom	Type	Description
exposedPort	integer	Spécifie le port exposé pour le port cible. S’il n’est pas spécifié, il est défini par défaut sur le port cible
external	boolean	Spécifie si le port d’application est accessible en dehors de l’environnement
targetPort	integer	Spécifie que le conteneur de l’utilisateur de port écoute sur

IngressTransportMethod

Protocole de transport d’entrée

Nom	Type	Description
auto	string
http	string
http2	string
tcp	string

InitContainer

Définition de conteneur d’init d’application conteneur

Nom	Type	Description
args	string[]	Arguments de commande de démarrage du conteneur.
command	string[]	Commande de démarrage du conteneur.
env	EnvironmentVar[]	Variables d’environnement de conteneur.
image	string	Balise d’image conteneur.
name	string	Nom du conteneur personnalisé.
resources	ContainerResources	Besoins en ressources de conteneur.
volumeMounts	VolumeMount[]	Montages de volume de conteneur.

IpSecurityRestrictionRule

Règle pour restreindre l’adresse IP entrante.

Nom	Type	Description
action	action	Autoriser ou refuser les règles à déterminer pour l’adresse IP entrante. Remarque : Les règles peuvent uniquement se composer de ALL Allow ou ALL Deny
description	string	Décrire la règle de restriction IP envoyée à l’application conteneur. Ce champ est facultatif.
ipAddressRange	string	Notation CIDR pour correspondre à l’adresse IP entrante
name	string	Nom de la règle de restriction IP.

logLevel

Définit le niveau de journal pour le side-car Dapr. Les valeurs autorisées sont débogage, informations, avertissement, erreur. La valeur par défaut est info.

Nom	Type	Description
debug	string
error	string
info	string
warn	string

ManagedServiceIdentity

Identité de service managée (identités attribuées par le système et/ou attribuées par l’utilisateur)

Nom	Type	Description
principalId	string	ID de principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
userAssignedIdentities	<string,  UserAssignedIdentity>	identités User-Assigned Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes.

ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

Nom	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

QueueScaleRule

Règle de mise à l’échelle basée sur la file d’attente Azure de conteneur d’application conteneur.

Nom	Type	Description
auth	ScaleRuleAuth[]	Secrets d’authentification pour la règle de mise à l’échelle de la file d’attente.
queueLength	integer	Longueur de la file d’attente.
queueName	string	Nom de la file d’attente.

RegistryCredentials

Registre privé d’application de conteneur

Nom	Type	Description
identity	string	Identité managée à utiliser pour l’authentification auprès de Azure Container Registry. Pour les identités attribuées par l’utilisateur, utilisez l’ID de ressource d’identité entièrement attribué par l’utilisateur. Pour les identités attribuées par le système, utilisez « système »
passwordSecretRef	string	Nom du secret qui contient le mot de passe de connexion au Registre
server	string	Serveur Container Registry
username	string	Nom d’utilisateur container Registry

Scale

Configurations de mise à l’échelle d’application conteneur.

Nom	Type	Valeur par défaut	Description
maxReplicas	integer	10	facultatif. Nombre maximal de réplicas de conteneur. La valeur par défaut est 10 si elle n’est pas définie.
minReplicas	integer		facultatif. Nombre minimal de réplicas de conteneur.
rules	ScaleRule[]		Règles de mise à l’échelle.

ScaleRule

Règle de mise à l’échelle de conteneur d’application conteneur.

Nom	Type	Description
azureQueue	QueueScaleRule	Mise à l’échelle basée sur la file d’attente Azure.
custom	CustomScaleRule	Règle de mise à l’échelle personnalisée.
http	HttpScaleRule	Mise à l’échelle basée sur les requêtes HTTP.
name	string	Nom de la règle d’échelle
tcp	TcpScaleRule	Mise à l’échelle basée sur les requêtes Tcp.

ScaleRuleAuth

Secrets d’authentification pour la règle d’échelle

Nom	Type	Description
secretRef	string	Nom du secret à partir duquel extraire les params d’authentification.
triggerParameter	string	Paramètre de déclencheur qui utilise le secret

Scheme

Schéma à utiliser pour la connexion à l’hôte. La valeur par défaut est HTTP.

Nom	Type	Description
HTTP	string
HTTPS	string

Secret

Définition du secret.

Nom	Type	Description
identity	string	ID de ressource d’une identité managée pour l’authentification auprès d’Azure Key Vault ou système pour utiliser une identité affectée par le système.
keyVaultUrl	string	Azure Key Vault URL pointant vers le secret référencé par l’application conteneur.
name	string	Nom du secret.
value	string	Valeur secrète.

SecretVolumeItem

Secret à ajouter au volume.

Nom	Type	Description
path	string	Chemin d’accès au secret du projet. Si aucun chemin n’est fourni, le chemin d’accès est défini par défaut sur le nom du secret répertorié dans secretRef.
secretRef	string	Nom du secret d’application conteneur à partir duquel extraire la valeur du secret.

Service

Container App pour être un service de développement

Nom	Type	Description
type	string	Type de service ContainerApp dev

ServiceBind

Configuration pour lier un ContainerApp à un service ContainerApp de développement

Nom	Type	Description
name	string	Nom de la liaison de service
serviceId	string	ID de ressource du service cible

StickySessions

Sessions collantes pour le mode révision unique

Nom	Type	Description
affinity	affinity	Affinité de session collante

StorageType

Type de stockage pour le volume. S’il n’est pas fourni, utilisez EmptyDir.

Nom	Type	Description
AzureFile	string
EmptyDir	string
Secret	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

TcpScaleRule

Règle de mise à l’échelle tcp du conteneur Container App.

Nom	Type	Description
auth	ScaleRuleAuth[]	Secrets d’authentification pour la règle de mise à l’échelle tcp.
metadata	object	Propriétés de métadonnées pour décrire la règle de mise à l’échelle tcp.

TcpSocket

TCPSocket spécifie une action impliquant un port TCP. Les crochets TCP ne sont pas encore pris en charge.

Nom	Type	Description
host	string	Facultatif : nom d’hôte auquel se connecter, valeur par défaut de l’ADRESSE IP du pod.
port	integer	Numéro ou nom du port à accéder sur le conteneur. Le nombre doit être compris entre 1 et 65535. Le nom doit être un IANA_SVC_NAME.

Template

Définition d’application avec version d’application conteneur. Définit l’état souhaité d’une révision immuable. Toute modification apportée à cette section entraîne la création d’une nouvelle révision

Nom	Type	Description
containers	Container[]	Liste des définitions de conteneur pour l’application conteneur.
initContainers	InitContainer[]	Liste des conteneurs spécialisés qui s’exécutent avant les conteneurs d’application.
revisionSuffix	string	Suffixe convivial ajouté au nom de la révision
scale	Scale	Propriétés de mise à l’échelle pour l’application conteneur.
serviceBinds	ServiceBind[]	Liste des services d’application conteneur liés à l’application
terminationGracePeriodSeconds	integer	Durée facultative en secondes que l’instance d’application conteneur doit se terminer correctement. La valeur doit être un entier non négatif. La valeur zéro indique l’arrêt immédiat via le signal d’arrêt (aucune possibilité d’arrêt). Si cette valeur est nulle, la période de grâce par défaut est utilisée à la place. Définissez cette valeur plus longtemps que le temps de nettoyage prévu pour votre processus. La valeur par défaut est de 30 secondes.
volumes	Volume[]	Liste des définitions de volume pour l’application conteneur.

TrafficWeight

Poids du trafic attribué à une révision

Nom	Type	Valeur par défaut	Description
label	string		Associe une étiquette de trafic à une révision
latestRevision	boolean	False	Indique que le poids du trafic appartient à une révision stable la plus récente
revisionName	string		Nom d’une révision
weight	integer		Poids du trafic attribué à une révision

Type

Type de sonde.

Nom	Type	Description
Liveness	string
Readiness	string
Startup	string

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

Nom	Type	Description
clientId	string	ID client de l’identité affectée.
principalId	string	ID principal de l’identité affectée.

Volume

Définitions de volume pour l’application conteneur.

Nom	Type	Description
mountOptions	string	Options de montage utilisées lors du montage d’AzureFile. Doit être une chaîne séparée par des virgules.
name	string	Nom du volume.
secrets	SecretVolumeItem[]	Liste des secrets à ajouter dans le volume. Si aucun secret n’est fourni, tous les secrets de la collection seront ajoutés au volume.
storageName	string	Nom de la ressource de stockage. Il n’est pas nécessaire de fournir EmptyDir et Secret.
storageType	StorageType	Type de stockage pour le volume. S’il n’est pas fourni, utilisez EmptyDir.

VolumeMount

Montage de volume pour l’application conteneur.

Nom	Type	Description
mountPath	string	Chemin d’accès dans le conteneur sur lequel le volume doit être monté. Ne doit pas contenir « : ».
subPath	string	Chemin dans le volume à partir duquel le volume du conteneur doit être monté. La valeur par défaut est « » (racine du volume).
volumeName	string	Cela doit correspondre au nom d’un volume.