Freigeben über


Managed Environments - Get

Dient zum Abrufen der Eigenschaften einer verwalteten Umgebung, 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. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Die ID des Zielabonnements.

api-version
query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

ManagedEnvironment

OKAY

Other Status Codes

DefaultErrorResponse

Häufige Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

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

{
  "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 Apps-Umgebungsdomäne

DaprConfiguration

Konfigurationseigenschaften Dapr-Komponente

DefaultErrorResponse

Fehlerantwort des App-Diensts.

Details

Details oder der 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 muss nur bereitgestellt werden, wenn das Ziel als "Log-Analytics" konfiguriert ist.

ManagedEnvironment

Eine Umgebung für das Hosten von Container-Apps

Mtls

Konfigurationseigenschaften für die gegenseitige TLS-Authentifizierung

PeerAuthentication

Peerauthentifizierungseinstellungen für die verwaltete Umgebung

PeerTrafficConfiguration

Peer-Datenverkehrseinstellungen für die verwaltete Umgebung

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

VnetConfiguration

Konfigurationseigenschaften für Apps-Umgebung, um einem virtuellen Netzwerk beizutreten

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 muss 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 Apps-Umgebungsdomäne

Name Typ Beschreibung
certificatePassword

string

Zertifikatkennwort

certificateValue

string

PFX- oder PEM-Blob

customDomainVerificationId

string

Id, die verwendet wird, um den Besitz von Domänennamen zu überprüfen

dnsSuffix

string

Dns-Suffix für die Umgebungsdomäne

expirationDate

string

Ablaufdatum des Zertifikats.

subjectName

string

Antragstellername des Zertifikats.

thumbprint

string

Zertifikatfingerabdruck.

DaprConfiguration

Konfigurationseigenschaften Dapr-Komponente

Name Typ Beschreibung
version

string

Die Version von Dapr

DefaultErrorResponse

Fehlerantwort des App-Diensts.

Name Typ Beschreibung
error

Error

Fehlermodell.

Details

Details oder der Fehler

Name Typ Beschreibung
code

string

Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.

message

string

Detaillierte Fehlerbeschreibung und Debuginformationen.

target

string

Detaillierte 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 Peerdatenverkehrverschlüsselung 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, um den Fehler programmgesteuert zu identifizieren.

details

Details[]

Details oder der Fehler

innererror

string

Weitere Informationen zum Debuggen von Fehlern.

message

string

Detaillierte Fehlerbeschreibung und Debuginformationen.

target

string

Detaillierte Fehlerbeschreibung und Debuginformationen.

KedaConfiguration

Konfigurationseigenschaften Keda-Komponente

Name Typ Beschreibung
version

string

Die Version von Keda

LogAnalyticsConfiguration

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

Name Typ Beschreibung
customerId

string

Protokollanalyse-Kunden-ID

sharedKey

string

Log Analytics Customer Key

ManagedEnvironment

Eine Umgebung für das Hosten von Container-Apps

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

string

Art der Umwelt.

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.appLogsConfiguration

AppLogsConfiguration

Clusterkonfiguration, mit der der Protokolldaemon App-Protokolle in das konfigurierte Ziel exportieren kann.

properties.customDomainConfiguration

CustomDomainConfiguration

Benutzerdefinierte Domänenkonfiguration für die Umgebung

properties.daprAIConnectionString

string

Application Insights-Verbindungszeichenfolge, die von Dapr zum Exportieren der Dienst-in-Dienst-Kommunikationstelemetrie verwendet wird

properties.daprAIInstrumentationKey

string

Azure Monitor-Instrumentierungsschlüssel, der von Dapr zum Exportieren von Dienst-in-Dienst-Kommunikationstelemetrie verwendet wird

properties.daprConfiguration

DaprConfiguration

Die Konfiguration der Dapr-Komponente.

properties.defaultDomain

string

Standarddomänenname für den Cluster

properties.deploymentErrors

string

Alle Fehler, die während der Bereitstellungs- oder Bereitstellungsüberprüfung aufgetreten sind

properties.eventStreamEndpoint

string

Der Endpunkt des Ereignisstreams der Umgebung.

properties.infrastructureResourceGroup

string

Name der plattformverwalteten Ressourcengruppe, die für die verwaltete Umgebung zum Hosten von Infrastrukturressourcen erstellt wurde. Wenn eine Subnetz-ID angegeben wird, wird diese Ressourcengruppe im selben Abonnement wie das Subnetz erstellt.

properties.kedaConfiguration

KedaConfiguration

Die Konfiguration der Keda-Komponente.

properties.peerAuthentication

PeerAuthentication

Peerauthentifizierungseinstellungen für die verwaltete Umgebung

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Peer-Datenverkehrseinstellungen für die verwaltete Umgebung

properties.provisioningState

EnvironmentProvisioningState

Bereitstellungsstatus der Umgebung.

properties.staticIp

string

Statische IP der Umgebung

properties.vnetConfiguration

VnetConfiguration

Vnet-Konfiguration für die Umgebung

properties.workloadProfiles

WorkloadProfile[]

Workloadprofile, die für die verwaltete Umgebung konfiguriert sind.

properties.zoneRedundant

boolean

Gibt an, ob diese verwaltete Umgebung zonenredundant ist.

systemData

systemData

Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.

tags

object

Ressourcentags.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

Mtls

Konfigurationseigenschaften für die gegenseitige TLS-Authentifizierung

Name Typ Beschreibung
enabled

boolean

Boolescher Wert, der angibt, ob die gegenseitige TLS-Authentifizierung aktiviert ist

PeerAuthentication

Peerauthentifizierungseinstellungen für die verwaltete Umgebung

Name Typ Beschreibung
mtls

Mtls

Einstellungen für die gegenseitige TLS-Authentifizierung für die verwaltete Umgebung

PeerTrafficConfiguration

Peer-Datenverkehrseinstellungen für die verwaltete Umgebung

Name Typ Beschreibung
encryption

Encryption

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

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

VnetConfiguration

Konfigurationseigenschaften für Apps-Umgebung, um einem virtuellen Netzwerk beizutreten

Name Typ Beschreibung
dockerBridgeCidr

string

CIDR-Notation-IP-Bereich, der der Docker-Brücke, Netzwerk zugewiesen ist. Darf nicht mit anderen bereitgestellten IP-Bereichen überlappen.

infrastructureSubnetId

string

Ressourcen-ID eines Subnetzes für Infrastrukturkomponenten. Darf nicht mit anderen bereitgestellten IP-Bereichen überlappen.

internal

boolean

Boolescher Wert, der angibt, dass die Umgebung nur über einen internen Lastenausgleich verfügt. Diese Umgebungen verfügen nicht über eine öffentliche statische IP-Ressource. Sie müssen "infrastructureSubnetId" bereitstellen, wenn diese Eigenschaft aktiviert wird.

platformReservedCidr

string

IP-Bereich in CIDR-Notation, der für IP-Adressen der Umgebungsinfrastruktur reserviert werden kann. Darf nicht mit anderen bereitgestellten IP-Bereichen überlappen.

platformReservedDnsIP

string

Eine IP-Adresse aus dem durch platformReservedCidr definierten IP-Bereich, der für den internen DNS-Server reserviert wird.

WorkloadProfile

Workloadprofil zum Bereich der Container-App-Ausführung.

Name Typ Beschreibung
maximumCount

integer

Die maximale Kapazität.

minimumCount

integer

Die Mindestkapazität.

name

string

Workload-Profiltyp für die Workloads, auf denen ausgeführt werden soll.

workloadProfileType

string

Workload-Profiltyp für die Workloads, auf denen ausgeführt werden soll.