Managed Environments - Get

Référence

Service:: Azure Container Apps

Version d'API:: 2024-03-01

Obtenez les propriétés d’un environnement managé utilisé pour héberger des applications conteneur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentName	path	True	string	Nom de l’environnement.
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	ManagedEnvironment	Ok
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 environments by name

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1?api-version=2024-03-01

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/ManagedEnvironments_Get.json
// this example is just showing the usage of "ManagedEnvironments_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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "8efdecc5-919e-44eb-b179-915dca89ebf9";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ContainerAppManagedEnvironmentResource
ContainerAppManagedEnvironmentCollection collection = resourceGroupResource.GetContainerAppManagedEnvironments();

// invoke the operation
string environmentName = "jlaw-demo1";
NullableResponse<ContainerAppManagedEnvironmentResource> response = await collection.GetIfExistsAsync(environmentName);
ContainerAppManagedEnvironmentResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
    ContainerAppManagedEnvironmentData 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/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1",
  "name": "jlaw-demo1",
  "type": "Microsoft.App/managedEnvironments",
  "location": "North Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentErrors": null,
    "defaultDomain": "jlaw-demo1.k4apps.io",
    "staticIp": "20.42.33.145",
    "zoneRedundant": true,
    "vnetConfiguration": {
      "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"
    },
    "customDomainConfiguration": {
      "customDomainVerificationId": "custom domain verification id",
      "dnsSuffix": "www.my-name.com",
      "subjectName": "CN=www.my-name.com",
      "expirationDate": "2022-11-06T04:00:00Z",
      "thumbprint": "CERTIFICATE_THUMBPRINT"
    },
    "eventStreamEndpoint": "testEndpoint",
    "workloadProfiles": [
      {
        "name": "My-GP-01",
        "workloadProfileType": "GeneralPurpose",
        "minimumCount": 3,
        "maximumCount": 12
      },
      {
        "name": "My-MO-01",
        "workloadProfileType": "MemoryOptimized",
        "minimumCount": 3,
        "maximumCount": 6
      },
      {
        "name": "My-CO-01",
        "workloadProfileType": "ComputeOptimized",
        "minimumCount": 3,
        "maximumCount": 6
      },
      {
        "name": "My-consumption-01",
        "workloadProfileType": "Consumption"
      }
    ],
    "kedaConfiguration": {
      "version": "2.8.1"
    },
    "daprConfiguration": {
      "version": "1.9"
    },
    "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus",
    "peerAuthentication": {
      "mtls": {
        "enabled": true
      }
    },
    "peerTrafficConfiguration": {
      "encryption": {
        "enabled": true
      }
    }
  }
}

Définitions

Nom	Description
AppLogsConfiguration	Configuration des journaux d’application
createdByType	Type d’identité qui a créé la ressource.
CustomDomainConfiguration	Propriétés de configuration pour le domaine personnalisé de l’environnement d’applications
DaprConfiguration	Composant Dapr des propriétés de configuration
DefaultErrorResponse	App Service réponse d’erreur.
Details	Détails ou erreur
Encryption	Paramètres de chiffrement du trafic homologue pour l’environnement managé
EnvironmentProvisioningState	État d’approvisionnement de l’environnement.
Error	Modèle d’erreur.
KedaConfiguration	Propriétés de configuration Composant Keda
LogAnalyticsConfiguration	La configuration de Log Analytics ne doit être fournie que lorsque la destination est configurée en tant que « log-analytics »
ManagedEnvironment	Un environnement pour l’hébergement d’applications conteneur
Mtls	Propriétés de configuration pour l’authentification TLS mutuelle
PeerAuthentication	Paramètres d’authentification homologue pour l’environnement managé
PeerTrafficConfiguration	Paramètres de trafic homologue pour l’environnement managé
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
VnetConfiguration	Propriétés de configuration pour que l’environnement d’applications rejoigne un Réseau virtuel
WorkloadProfile	Profil de charge de travail pour étendre l’exécution de l’application conteneur.

AppLogsConfiguration

Configuration des journaux d’application

Nom	Type	Description
destination	string	La destination des journaux peut être « log-analytics », « azure-monitor » ou « none »
logAnalyticsConfiguration	LogAnalyticsConfiguration	La configuration de Log Analytics ne doit être fournie que lorsque la destination est configurée en tant que « log-analytics »

createdByType

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

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomainConfiguration

Propriétés de configuration pour le domaine personnalisé de l’environnement d’applications

Nom	Type	Description
certificatePassword	string	Mot de passe du certificat
certificateValue	string	Objet blob PFX ou PEM
customDomainVerificationId	string	ID utilisé pour vérifier la propriété du nom de domaine
dnsSuffix	string	Suffixe DNS pour le domaine d’environnement
expirationDate	string	Date d’expiration du certificat.
subjectName	string	Nom de l’objet du certificat.
thumbprint	string	Empreinte du certificat.

DaprConfiguration

Composant Dapr des propriétés de configuration

Nom	Type	Description
version	string	La version de Dapr

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.

Encryption

Paramètres de chiffrement du trafic homologue pour l’environnement managé

Nom	Type	Description
enabled	boolean	Boolean indiquant si le chiffrement du trafic d’homologue est activé

EnvironmentProvisioningState

État d’approvisionnement de l’environnement.

Nom	Type	Description
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

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.

KedaConfiguration

Propriétés de configuration Composant Keda

Nom	Type	Description
version	string	La version de Keda

LogAnalyticsConfiguration

La configuration de Log Analytics ne doit être fournie que lorsque la destination est configurée en tant que « log-analytics »

Nom	Type	Description
customerId	string	ID client Log Analytics
sharedKey	string	Clé client Log Analytics