Partager via

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

D’ACCORD
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

Exemple de requête

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

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

Réponse d’erreur App Service.
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

Composant Keda des propriétés de configuration
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 d’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 l’environnement d’applications à joindre 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

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 numérique du certificat.

DaprConfiguration

Composant Dapr des propriétés de configuration

Nom Type Description
version

string

Version de Dapr

DefaultErrorResponse

Réponse d’erreur App Service.

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 des erreurs et informations de débogage.
target

string

Description détaillée des erreurs 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 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

Pour plus d’informations sur l’erreur de débogage.
message

string

Description détaillée des erreurs et informations de débogage.
target

string

Description détaillée des erreurs et informations de débogage.

KedaConfiguration

Composant Keda des propriétés de configuration

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

ManagedEnvironment

Un environnement pour l’hébergement d’applications conteneur

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

string

Type d’environnement.
location

string

Emplacement géographique où réside la ressource
name

string

Nom de la ressource
properties.appLogsConfiguration

AppLogsConfiguration

Configuration du cluster qui permet au démon de journal d’exporter les journaux d’activité d’application vers la destination configurée.
properties.customDomainConfiguration

CustomDomainConfiguration

Configuration de domaine personnalisé pour l’environnement
properties.daprAIConnectionString

string

Chaîne de connexion Application Insights utilisée par Dapr pour exporter les données de télémétrie de communication du service vers le service
properties.daprAIInstrumentationKey

string

Clé d’instrumentation Azure Monitor utilisée par Dapr pour exporter les données de télémétrie de communication du service vers le service
properties.daprConfiguration

DaprConfiguration

Configuration du composant Dapr.
properties.defaultDomain

string

Nom de domaine par défaut du cluster
properties.deploymentErrors

string

Toutes les erreurs qui se sont produites pendant le déploiement ou la validation du déploiement
properties.eventStreamEndpoint

string

Point de terminaison du flux d’événements de l’environnement.
properties.infrastructureResourceGroup

string

Nom du groupe de ressources géré par la plateforme créé pour que l’environnement managé héberge les ressources d’infrastructure. Si un ID de sous-réseau est fourni, ce groupe de ressources est créé dans le même abonnement que le sous-réseau.
properties.kedaConfiguration

KedaConfiguration

Configuration du composant Keda.
properties.peerAuthentication

PeerAuthentication

Paramètres d’authentification d’homologue pour l’environnement managé
properties.peerTrafficConfiguration

PeerTrafficConfiguration

Paramètres de trafic homologue pour l’environnement managé
properties.provisioningState

EnvironmentProvisioningState

État d’approvisionnement de l’environnement.
properties.staticIp

string

Adresse IP statique de l’environnement
properties.vnetConfiguration

VnetConfiguration

Configuration du réseau virtuel pour l’environnement
properties.workloadProfiles

WorkloadProfile[]

Profils de charge de travail configurés pour l’environnement managé.
properties.zoneRedundant

boolean

Indique si cet environnement managé est redondant interzone ou non.
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 »

Mtls

Propriétés de configuration pour l’authentification TLS mutuelle

Nom Type Description
enabled

boolean

Boolean indiquant si l’authentification TLS mutuelle est activée

PeerAuthentication

Paramètres d’authentification d’homologue pour l’environnement managé

Nom Type Description
mtls

Mtls

Paramètres d’authentification TLS mutuelle pour l’environnement managé

PeerTrafficConfiguration

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

Nom Type Description
encryption

Encryption

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

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 ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

VnetConfiguration

Propriétés de configuration pour l’environnement d’applications à joindre un réseau virtuel

Nom Type Description
dockerBridgeCidr

string

Plage IP de notation CIDR affectée au pont Docker, réseau. Ne doit pas chevaucher d’autres plages d’adresses IP fournies.
infrastructureSubnetId

string

ID de ressource d’un sous-réseau pour les composants d’infrastructure. Ne doit pas chevaucher d’autres plages d’adresses IP fournies.
internal

boolean

Boolean indiquant que l’environnement possède uniquement un équilibreur de charge interne. Ces environnements n’ont pas de ressource IP statique publique. Ils doivent fournir l’infrastructureSubnetId si cette propriété est activée
platformReservedCidr

string

Plage d’adresses IP en notation CIDR qui peut être réservée pour les adresses IP de l’infrastructure d’environnement. Ne doit pas chevaucher d’autres plages d’adresses IP fournies.
platformReservedDnsIP

string

Adresse IP de la plage d’adresses IP définie par platformReservedCidr qui sera réservée au serveur DNS interne.

WorkloadProfile

Profil de charge de travail pour étendre l’exécution de l’application conteneur.

Nom Type Description
maximumCount

integer

Capacité maximale.
minimumCount

integer

Capacité minimale.
name

string

Type de profil de charge de travail pour les charges de travail à exécuter.
workloadProfileType

string

Type de profil de charge de travail pour les charges de travail à exécuter.