Managed Environments - Get

Referenz

Dienst:: Azure Container Apps

API-Version:: 2024-03-01

Ruft die Eigenschaften einer verwalteten Umgebung ab, die zum Hosten von Container-Apps verwendet wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentName	path	True	string	Name der Umgebung.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ManagedEnvironment	OK
Other Status Codes	DefaultErrorResponse	Häufige Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get environments by name

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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
      }
    }
  }
}

Definitionen

Name	Beschreibung
AppLogsConfiguration	Konfiguration von Anwendungsprotokollen
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CustomDomainConfiguration	Konfigurationseigenschaften für benutzerdefinierte Domäne der App-Umgebung
DaprConfiguration	Dapr-Komponente für Konfigurationseigenschaften
DefaultErrorResponse	App Service Fehlerantwort.
Details	Details oder fehler
Encryption	Verschlüsselungseinstellungen für Peerdatenverkehr für die verwaltete Umgebung
EnvironmentProvisioningState	Bereitstellungsstatus der Umgebung.
Error	Fehlermodell.
KedaConfiguration	Konfigurationseigenschaften Keda-Komponente
LogAnalyticsConfiguration	Log Analytics-Konfiguration darf nur bereitgestellt werden, wenn das Ziel als "log-analytics" konfiguriert ist.
ManagedEnvironment	Eine Umgebung zum Hosten von Container-Apps
Mtls	Konfigurationseigenschaften für die gegenseitige TLS-Authentifizierung
PeerAuthentication	Peerauthentifizierungseinstellungen für die verwaltete Umgebung
PeerTrafficConfiguration	Peerdatenverkehrseinstellungen für die verwaltete Umgebung
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
VnetConfiguration	Konfigurationseigenschaften für die App-Umgebung zum Beitreten zu einer Virtual Network
WorkloadProfile	Workloadprofil zum Bereich der Container-App-Ausführung.

AppLogsConfiguration

Konfiguration von Anwendungsprotokollen

Name	Typ	Beschreibung
destination	string	Protokollziel, kann "log-analytics", "azure-monitor" oder "none" sein.
logAnalyticsConfiguration	LogAnalyticsConfiguration	Log Analytics-Konfiguration darf nur bereitgestellt werden, wenn das Ziel als "log-analytics" konfiguriert ist.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomainConfiguration

Konfigurationseigenschaften für benutzerdefinierte Domäne der App-Umgebung

Name	Typ	Beschreibung
certificatePassword	string	Zertifikatkennwort
certificateValue	string	PFX- oder PEM-Blob
customDomainVerificationId	string	Id, die zum Überprüfen des Domänennamenbesitzes verwendet wird
dnsSuffix	string	DNS-Suffix für die Umgebungsdomäne
expirationDate	string	Ablaufdatum des Zertifikats.
subjectName	string	Antragstellername des Zertifikats.
thumbprint	string	Zertifikatfingerabdruck.

DaprConfiguration

Dapr-Komponente für Konfigurationseigenschaften

Name	Typ	Beschreibung
version	string	Die Version von Dapr

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Details oder fehler

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

Encryption

Verschlüsselungseinstellungen für Peerdatenverkehr für die verwaltete Umgebung

Name	Typ	Beschreibung
enabled	boolean	Boolescher Wert, der angibt, ob die Verschlüsselung des Peerdatenverkehrs aktiviert ist

EnvironmentProvisioningState

Bereitstellungsstatus der Umgebung.

Name	Typ	Beschreibung
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
details	Details[]	Details oder fehler
innererror	string	Weitere Informationen zum Debuggen des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

KedaConfiguration

Konfigurationseigenschaften Keda-Komponente

Name	Typ	Beschreibung
version	string	Die Version von Keda

LogAnalyticsConfiguration

Log Analytics-Konfiguration darf nur bereitgestellt werden, wenn das Ziel als "log-analytics" konfiguriert ist.

Name	Typ	Beschreibung
customerId	string	Log Analytics-Kunden-ID
sharedKey	string	Log Analytics-Kundenschlüssel