Sdílet prostřednictvím


Managed Environments - Get

Získejte vlastnosti spravovaného prostředí, které se používá k hostování aplikací kontejneru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
environmentName
path True

string

Název prostředí.

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

ManagedEnvironment

OK

Other Status Codes

DefaultErrorResponse

Běžná chybová odpověď.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Get environments by name

Sample Request

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

Sample Response

{
  "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
      }
    }
  }
}

Definice

Name Description
AppLogsConfiguration

Konfigurace aplikačních protokolů

createdByType

Typ identity, která prostředek vytvořila.

CustomDomainConfiguration

Vlastnosti konfigurace pro vlastní doménu prostředí aplikací

DaprConfiguration

Vlastnosti konfigurace – komponenta Dapr

DefaultErrorResponse

App Service chybovou odpověď.

Details

Podrobnosti nebo chyba

Encryption

Nastavení šifrování partnerského provozu pro spravované prostředí

EnvironmentProvisioningState

Stav zřizování prostředí.

Error

Model chyb.

KedaConfiguration

Vlastnosti konfigurace – komponenta Keda

LogAnalyticsConfiguration

Konfigurace Log Analytics musí být poskytnuta pouze v případě, že je cíl nakonfigurovaný jako log-analytics.

ManagedEnvironment

Prostředí pro hostování aplikací kontejneru

Mtls

Vlastnosti konfigurace pro vzájemné ověřování TLS

PeerAuthentication

Nastavení ověřování partnerského vztahu pro spravované prostředí

PeerTrafficConfiguration

Nastavení partnerského provozu pro spravované prostředí

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

VnetConfiguration

Vlastnosti konfigurace pro prostředí aplikací pro připojení k Virtual Network

WorkloadProfile

Profil úlohy pro vymezení rozsahu spouštění aplikací kontejneru

AppLogsConfiguration

Konfigurace aplikačních protokolů

Name Typ Description
destination

string

Cíl protokolů může být log-analytics, azure-monitor nebo none.

logAnalyticsConfiguration

LogAnalyticsConfiguration

Konfigurace Log Analytics musí být poskytnuta pouze v případě, že je cíl nakonfigurovaný jako log-analytics.

createdByType

Typ identity, která prostředek vytvořila.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

CustomDomainConfiguration

Vlastnosti konfigurace pro vlastní doménu prostředí aplikací

Name Typ Description
certificatePassword

string

Heslo certifikátu

certificateValue

string

Objekt blob PFX nebo PEM

customDomainVerificationId

string

ID sloužící k ověření vlastnictví názvu domény

dnsSuffix

string

Přípona DNS pro doménu prostředí

expirationDate

string

Datum vypršení platnosti certifikátu.

subjectName

string

Název subjektu certifikátu.

thumbprint

string

Kryptografický otisk certifikátu.

DaprConfiguration

Vlastnosti konfigurace – komponenta Dapr

Name Typ Description
version

string

Verze Dapr

DefaultErrorResponse

App Service chybovou odpověď.

Name Typ Description
error

Error

Model chyb.

Details

Podrobnosti nebo chyba

Name Typ Description
code

string

Standardizovaný řetězec pro programovou identifikaci chyby

message

string

Podrobný popis chyby a informace o ladění

target

string

Podrobný popis chyby a informace o ladění

Encryption

Nastavení šifrování partnerského provozu pro spravované prostředí

Name Typ Description
enabled

boolean

Logická hodnota označující, jestli je povolené šifrování partnerského provozu

EnvironmentProvisioningState

Stav zřizování prostředí.

Name Typ Description
Canceled

string

Failed

string

InfrastructureSetupComplete

string

InfrastructureSetupInProgress

string

InitializationInProgress

string

ScheduledForDelete

string

Succeeded

string

UpgradeFailed

string

UpgradeRequested

string

Waiting

string

Error

Model chyb.

Name Typ Description
code

string

Standardizovaný řetězec pro programovou identifikaci chyby

details

Details[]

Podrobnosti nebo chyba

innererror

string

Další informace o chybě ladění

message

string

Podrobný popis chyby a informace o ladění

target

string

Podrobný popis chyby a informace o ladění

KedaConfiguration

Vlastnosti konfigurace – komponenta Keda

Name Typ Description
version

string

Verze Keda

LogAnalyticsConfiguration

Konfigurace Log Analytics musí být poskytnuta pouze v případě, že je cíl nakonfigurovaný jako log-analytics.

Name Typ Description
customerId

string

ID zákazníka Log Analytics

sharedKey

string

Klíč zákazníka Log Analytics

ManagedEnvironment

Prostředí pro hostování aplikací kontejneru

Name Typ Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}

kind

string

Druh prostředí.

location

string

Geografické umístění, kde se prostředek nachází

name

string

Název prostředku

properties.appLogsConfiguration

AppLogsConfiguration

Konfigurace clusteru, která umožňuje démonu protokolů exportovat protokoly aplikace do cíle. V současné době se podporuje pouze log-analytics.

properties.customDomainConfiguration

CustomDomainConfiguration

Konfigurace vlastní domény pro prostředí

properties.daprAIConnectionString

string

Application Insights připojovací řetězec používá Dapr k exportu telemetrie komunikace mezi službami

properties.daprAIInstrumentationKey

string

Instrumentační klíč služby Azure Monitor používaný nástrojem Dapr k exportu telemetrie komunikace mezi službami

properties.daprConfiguration

DaprConfiguration

Konfigurace komponenty Dapr.

properties.defaultDomain

string

Výchozí název domény pro cluster

properties.deploymentErrors

string

Všechny chyby, ke kterým došlo během nasazování nebo ověřování nasazení

properties.eventStreamEndpoint

string

Koncový bod streamu událostí prostředí.

properties.infrastructureResourceGroup

string

Název skupiny prostředků spravované platformou vytvořené pro spravované prostředí pro hostování prostředků infrastruktury. Pokud zadáte ID podsítě, vytvoří se tato skupina prostředků ve stejném předplatném jako podsíť.

properties.kedaConfiguration

KedaConfiguration

Konfigurace komponenty Keda.

properties.peerAuthentication

PeerAuthentication

Nastavení ověřování partnerského vztahu pro spravované prostředí

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Nastavení partnerského provozu pro spravované prostředí

properties.provisioningState

EnvironmentProvisioningState

Stav zřizování prostředí.

properties.staticIp

string

Statická IP adresa prostředí

properties.vnetConfiguration

VnetConfiguration

Konfigurace virtuální sítě pro prostředí

properties.workloadProfiles

WorkloadProfile[]

Profily úloh nakonfigurované pro spravované prostředí.

properties.zoneRedundant

boolean

Určuje, jestli je toto spravované prostředí zónově redundantní.

systemData

systemData

Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.

tags

object

Značky prostředků.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

Mtls

Vlastnosti konfigurace pro vzájemné ověřování TLS

Name Typ Description
enabled

boolean

Logická hodnota označující, jestli je povolené vzájemné ověřování TLS

PeerAuthentication

Nastavení ověřování partnerského vztahu pro spravované prostředí

Name Typ Description
mtls

Mtls

Nastavení vzájemného ověřování TLS pro spravované prostředí

PeerTrafficConfiguration

Nastavení partnerského provozu pro spravované prostředí

Name Typ Description
encryption

Encryption

Nastavení šifrování partnerského provozu pro spravované prostředí

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která vytvořila prostředek.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

VnetConfiguration

Vlastnosti konfigurace pro prostředí aplikací pro připojení k Virtual Network

Name Typ Description
dockerBridgeCidr

string

Rozsah IP adres notace CIDR přiřazený k mostu Dockeru, síti. Nesmí se překrývat s žádnými dalšími poskytnutými rozsahy IP adres.

infrastructureSubnetId

string

ID prostředku podsítě pro součásti infrastruktury Nesmí se překrývat s žádnými dalšími poskytnutými rozsahy IP adres.

internal

boolean

Logická hodnota označující, že prostředí má pouze interní nástroj pro vyrovnávání zatížení. Tato prostředí nemají veřejný prostředek statické IP adresy. Pokud povolíte tuto vlastnost, musí zadat infrastructureSubnetId.

platformReservedCidr

string

Rozsah IP adres v zápisu CIDR, který je možné rezervovat pro IP adresy infrastruktury prostředí. Nesmí se překrývat s žádnými dalšími poskytnutými rozsahy IP adres.

platformReservedDnsIP

string

IP adresa z rozsahu IP adres definovaného platformReservedCidr, který bude vyhrazen pro interní server DNS.

WorkloadProfile

Profil úlohy pro vymezení rozsahu spouštění aplikací kontejneru

Name Typ Description
maximumCount

integer

Maximální kapacita.

minimumCount

integer

Minimální kapacita.

name

string

Typ profilu úlohy pro úlohy, na kterých se mají spouštět.

workloadProfileType

string

Typ profilu úlohy pro úlohy, na kterých se mají spouštět.