Dela via


Managed Environments - Get

Hämta egenskaperna för en hanterad miljö som används som värd för containerappar.

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

URI-parametrar

Name I Obligatorisk Typ Description
environmentName
path True

string

Namnet på miljön.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

minLength: 1

ID för målprenumerationen.

api-version
query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

ManagedEnvironment

OK

Other Status Codes

ErrorResponse

Vanligt felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Get environments by name

Exempelbegäran

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

Exempelsvar

{
  "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
      }
    },
    "ingressConfiguration": {
      "workloadProfileName": "My-CO-01",
      "terminationGracePeriodSeconds": 3600,
      "headerCountLimit": 30,
      "requestIdleTimeout": 5
    }
  }
}

Definitioner

Name Description
AppLogsConfiguration

Konfiguration av programloggar

CertificateKeyVaultProperties

Egenskaper för ett certifikat som lagras i ett Key Vault.

createdByType

Den typ av identitet som skapade resursen.

CustomDomainConfiguration

Konfigurationsegenskaper för appmiljöns anpassade domän

DaprConfiguration

Dapr-komponent för konfigurationsegenskaper

Encryption

Inställningar för peer-trafikkryptering för den hanterade miljön

EnvironmentProvisioningState

Etableringstillstånd för miljön.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

IngressConfiguration

Inställningar för ingresskomponenten, inklusive arbetsbelastningsprofil, skalning och anslutningshantering.

KedaConfiguration

Keda-komponent för konfigurationsegenskaper

LogAnalyticsConfiguration

Log Analytics-konfiguration får endast anges när målet har konfigurerats som "log-analytics"

ManagedEnvironment

En miljö för att vara värd för containerappar

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Mtls

Konfigurationsegenskaper för ömsesidig TLS-autentisering

PeerAuthentication

Peer-autentiseringsinställningar för den hanterade miljön

PeerTrafficConfiguration

Peer-trafikinställningar för den hanterade miljön

PrivateEndpoint

Den privata slutpunktsresursen.

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

PublicNetworkAccess

Egenskap för att tillåta eller blockera all offentlig trafik. Tillåtna värden: "Aktiverad", "Inaktiverad".

systemData

Metadata som rör skapande och senaste ändring av resursen.

UserAssignedIdentity

Användartilldelade identitetsegenskaper

VnetConfiguration

Konfigurationsegenskaper för appmiljön för att ansluta till ett virtuellt nätverk

WorkloadProfile

Arbetsbelastningsprofil för att begränsa körningen av containerappen.

AppLogsConfiguration

Konfiguration av programloggar

Name Typ Description
destination

string

Loggarnas mål, kan vara "log-analytics", "azure-monitor" eller "none"

logAnalyticsConfiguration

LogAnalyticsConfiguration

Log Analytics-konfiguration får endast anges när målet har konfigurerats som "log-analytics"

CertificateKeyVaultProperties

Egenskaper för ett certifikat som lagras i ett Key Vault.

Name Typ Description
identity

string

Resurs-ID för en hanterad identitet som ska autentiseras med Azure Key Vault eller System för att använda en systemtilldelad identitet.

keyVaultUrl

string (uri)

URL som pekar på Azure Key Vault-hemligheten som innehåller certifikatet.

createdByType

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

CustomDomainConfiguration

Konfigurationsegenskaper för appmiljöns anpassade domän

Name Typ Description
certificateKeyVaultProperties

CertificateKeyVaultProperties

Certifikat som lagras i Azure Key Vault.

certificatePassword

string

Certifikatlösenord

certificateValue

string (byte)

PFX- eller PEM-blob

customDomainVerificationId

string

Id som används för att verifiera att du äger ett domännamn

dnsSuffix

string

Dns-suffix för miljödomänen

expirationDate

string (date-time)

Certifikatets förfallodatum.

subjectName

string

Certifikatets ämnesnamn.

thumbprint

string

Certifikatets tumavtryck.

DaprConfiguration

Dapr-komponent för konfigurationsegenskaper

Name Typ Description
version

string

Versionen av Dapr

Encryption

Inställningar för peer-trafikkryptering för den hanterade miljön

Name Typ Description
enabled

boolean

Booleskt värde som anger om peer-trafikkryptering är aktiverat

EnvironmentProvisioningState

Etableringstillstånd för miljön.

Värde Description
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

IngressConfiguration

Inställningar för ingresskomponenten, inklusive arbetsbelastningsprofil, skalning och anslutningshantering.

Name Typ Description
headerCountLimit

integer (int32)

Maximalt antal rubriker per begäran som tillåts av ingressen. Måste vara minst 1. Standardvärdet är 100.

requestIdleTimeout

integer (int32)

Varaktighet (i minuter) innan tidsgränsen för inaktiva begäranden överskrids. Måste vara mellan 4 och 30 inklusive. Standardvärdet är 4 minuter.

terminationGracePeriodSeconds

integer (int32)

Tid (i sekunder) för att tillåta aktiva anslutningar att slutföras vid avslutning. Måste vara mellan 0 och 3600. Standardvärdet är 480 sekunder.

workloadProfileName

string

Namnet på arbetsbelastningsprofilen som används av ingresskomponenten. Obligatoriskt.

KedaConfiguration

Keda-komponent för konfigurationsegenskaper

Name Typ Description
version

string

Versionen av Keda

LogAnalyticsConfiguration

Log Analytics-konfiguration får endast anges när målet har konfigurerats som "log-analytics"

Name Typ Description
customerId

string

Log Analytics-kund-ID

sharedKey

string

Kundnyckel för Log Analytics

ManagedEnvironment

En miljö för att vara värd för containerappar

Name Typ Description
id

string (arm-id)

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

Hanterade identiteter för den hanterade miljön för att interagera med andra Azure-tjänster utan att ha några hemligheter eller autentiseringsuppgifter i koden.

kind

string

Typ av miljö.

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.appLogsConfiguration

AppLogsConfiguration

Klusterkonfiguration som gör det möjligt för loggdaemon att exportera apploggar till konfigurerat mål.

properties.customDomainConfiguration

CustomDomainConfiguration

Anpassad domänkonfiguration för miljön

properties.daprAIConnectionString

string

Application Insights connection string som används av Dapr för att exportera telemetri för tjänst-till-tjänstkommunikation

properties.daprAIInstrumentationKey

string

Azure Monitor instrumentationsnyckel som används av Dapr för att exportera telemetri för tjänst-till-tjänstkommunikation

properties.daprConfiguration

DaprConfiguration

Konfigurationen av Dapr-komponenten.

properties.defaultDomain

string

Standarddomännamn för klustret

properties.deploymentErrors

string

Eventuella fel som uppstod under distributionen eller distributionsverifieringen

properties.eventStreamEndpoint

string

Slutpunkten för händelseströmmen för miljön.

properties.infrastructureResourceGroup

string

Namnet på den plattformshanterade resursgrupp som skapats för den hanterade miljön som värd för infrastrukturresurser. Om ett undernäts-ID anges skapas den här resursgruppen i samma prenumeration som undernätet.

properties.ingressConfiguration

IngressConfiguration

Ingresskonfiguration för den hanterade miljön.

properties.kedaConfiguration

KedaConfiguration

Konfigurationen av Keda-komponenten.

properties.peerAuthentication

PeerAuthentication

Peer-autentiseringsinställningar för den hanterade miljön

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Peer-trafikinställningar för den hanterade miljön

properties.privateEndpointConnections

PrivateEndpointConnection[]

Privata slutpunktsanslutningar till resursen.

properties.provisioningState

EnvironmentProvisioningState

Etableringstillstånd för miljön.

properties.publicNetworkAccess

PublicNetworkAccess

Egenskap för att tillåta eller blockera all offentlig trafik. Tillåtna värden: "Aktiverad", "Inaktiverad".

properties.staticIp

string

Statisk IP i miljön

properties.vnetConfiguration

VnetConfiguration

Vnet-konfiguration för miljön

properties.workloadProfiles

WorkloadProfile[]

Arbetsbelastningsprofiler som konfigurerats för den hanterade miljön.

properties.zoneRedundant

boolean

Om den här hanterade miljön är zonredundant eller inte.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

tags

object

Resursetiketter.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name Typ Description
principalId

string (uuid)

Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

tenantId

string (uuid)

Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

type

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned identiteter
Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Värde Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Mtls

Konfigurationsegenskaper för ömsesidig TLS-autentisering

Name Typ Description
enabled

boolean

Boolesk som anger om den ömsesidiga TLS-autentiseringen är aktiverad

PeerAuthentication

Peer-autentiseringsinställningar för den hanterade miljön

Name Typ Description
mtls

Mtls

Inställningar för ömsesidig TLS-autentisering för den hanterade miljön

PeerTrafficConfiguration

Peer-trafikinställningar för den hanterade miljön

Name Typ Description
encryption

Encryption

Inställningar för peer-trafikkryptering för den hanterade miljön

PrivateEndpoint

Den privata slutpunktsresursen.

Name Typ Description
id

string (arm-id)

ARM-identifieraren för privat slutpunkt

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

Name Typ Description
id

string (arm-id)

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Namnet på resursen

properties.groupIds

string[]

Grupp-ID:t för den privata slutpunktsresursen.

properties.privateEndpoint

PrivateEndpoint

Resursen för den privata slutpunkten.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Etableringstillståndet för den privata slutpunktsanslutningsresursen.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

Värde Description
Succeeded
Failed
Canceled
Waiting
Updating
Deleting
Pending

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Värde Description
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name Typ Description
actionsRequired

string

Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.

description

string

Orsak till godkännande/avvisande av anslutningen.

status

PrivateEndpointServiceConnectionStatus

Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

PublicNetworkAccess

Egenskap för att tillåta eller blockera all offentlig trafik. Tillåtna värden: "Aktiverad", "Inaktiverad".

Värde Description
Enabled
Disabled

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Användartilldelade identitetsegenskaper

Name Typ Description
clientId

string (uuid)

Klient-ID för den tilldelade identiteten.

principalId

string (uuid)

Huvud-ID för den tilldelade identiteten.

VnetConfiguration

Konfigurationsegenskaper för appmiljön för att ansluta till ett virtuellt nätverk

Name Typ Description
dockerBridgeCidr

string

IP-intervall för CIDR-notation som tilldelats Docker-bryggan, nätverket. Får inte överlappa med andra angivna IP-intervall.

infrastructureSubnetId

string

Resurs-ID för ett undernät för infrastrukturkomponenter. Får inte överlappa med andra angivna IP-intervall.

internal

boolean

Booleskt värde som anger att miljön bara har en intern lastbalanserare. Dessa miljöer har ingen offentlig statisk IP-resurs. De måste tillhandahålla infrastructureSubnetId om du aktiverar den här egenskapen

platformReservedCidr

string

IP-intervall i CIDR-notation som kan reserveras för IP-adresser för miljöinfrastruktur. Får inte överlappa med andra angivna IP-intervall.

platformReservedDnsIP

string

En IP-adress från DET IP-intervall som definieras av platformReservedCidr som ska reserveras för den interna DNS-servern.

WorkloadProfile

Arbetsbelastningsprofil för att begränsa körningen av containerappen.

Name Typ Description
maximumCount

integer (int32)

Maximal kapacitet.

minimumCount

integer (int32)

Minsta kapacitet.

name

string

Arbetsbelastningsprofiltyp som arbetsbelastningarna ska köras på.

workloadProfileType

string

Arbetsbelastningsprofiltyp som arbetsbelastningarna ska köras på.