Delen via

Managed Environments - Get

  • Referentie
Service:
Azure Container Apps
API-versie:
2024-03-01

Haal de eigenschappen op van een beheerde omgeving die wordt gebruikt voor het hosten van container-apps.

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

URI-parameters

Name In Vereist Type Description
environmentName
 path True

string

Naam van de omgeving.
resourceGroupName
 path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId
 path True

string

De id van het doelabonnement.
api-version
 query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

ManagedEnvironment

OK
Other Status Codes

DefaultErrorResponse

Veelvoorkomende foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Get environments by name

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AppLogsConfiguration

Configuratie van toepassingslogboeken
createdByType

Het type identiteit waarmee de resource is gemaakt.
CustomDomainConfiguration

Configuratie-eigenschappen voor aangepast domein voor apps-omgeving
DaprConfiguration

Dapr-onderdeel configuratie-eigenschappen
DefaultErrorResponse

Foutreactie van App Service.
Details

Details of de fout
Encryption

Versleutelingsinstellingen voor peerverkeer voor de beheerde omgeving
EnvironmentProvisioningState

Inrichtingsstatus van de omgeving.
Error

Foutmodel.
KedaConfiguration

Keda-onderdeel voor configuratie-eigenschappen
LogAnalyticsConfiguration

Log Analytics-configuratie mag alleen worden opgegeven wanneer de bestemming is geconfigureerd als 'log-analytics'
ManagedEnvironment

Een omgeving voor het hosten van container-apps
Mtls

Configuratie-eigenschappen voor wederzijdse TLS-verificatie
PeerAuthentication

Peer-verificatie-instellingen voor de beheerde omgeving
PeerTrafficConfiguration

Instellingen voor peerverkeer voor de beheerde omgeving
systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
VnetConfiguration

Configuratie-eigenschappen voor de omgeving van apps om lid te worden van een virtueel netwerk
WorkloadProfile

Workloadprofiel voor het bereik van de uitvoering van container-apps.

AppLogsConfiguration

Configuratie van toepassingslogboeken

Name Type Description
destination

string

Doel van logboeken, kan 'log-analytics', 'azure-monitor' of 'none' zijn
logAnalyticsConfiguration

LogAnalyticsConfiguration

Log Analytics-configuratie mag alleen worden opgegeven wanneer de bestemming is geconfigureerd als 'log-analytics'

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

CustomDomainConfiguration

Configuratie-eigenschappen voor aangepast domein voor apps-omgeving

Name Type Description
certificatePassword

string

Certificaatwachtwoord
certificateValue

string

PFX- of PEM-blob
customDomainVerificationId

string

Id die wordt gebruikt om het eigendom van de domeinnaam te verifiëren
dnsSuffix

string

Dns-achtervoegsel voor het omgevingsdomein
expirationDate

string

Vervaldatum van certificaat.
subjectName

string

Onderwerpnaam van het certificaat.
thumbprint

string

Vingerafdruk van certificaat.

DaprConfiguration

Dapr-onderdeel configuratie-eigenschappen

Name Type Description
version

string

De versie van Dapr

DefaultErrorResponse

Foutreactie van App Service.

Name Type Description
error

Error

Foutmodel.

Details

Details of de fout

Name Type Description
code

string

Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message

string

Gedetailleerde foutbeschrijving en foutopsporingsgegevens.
target

string

Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

Encryption

Versleutelingsinstellingen voor peerverkeer voor de beheerde omgeving

Name Type Description
enabled

boolean

Booleaanse waarde die aangeeft of de versleuteling van peerverkeer is ingeschakeld

EnvironmentProvisioningState

Inrichtingsstatus van de omgeving.

Name Type Description
Canceled

string

Failed

string

InfrastructureSetupComplete

string

InfrastructureSetupInProgress

string

InitializationInProgress

string

ScheduledForDelete

string

Succeeded

string

UpgradeFailed

string

UpgradeRequested

string

Waiting

string

Error

Foutmodel.

Name Type Description
code

string

Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details

Details[]

Details of de fout
innererror

string

Meer informatie over foutopsporing.
message

string

Gedetailleerde foutbeschrijving en foutopsporingsgegevens.
target

string

Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

KedaConfiguration

Keda-onderdeel voor configuratie-eigenschappen

Name Type Description
version

string

De versie van Keda

LogAnalyticsConfiguration

Log Analytics-configuratie mag alleen worden opgegeven wanneer de bestemming is geconfigureerd als 'log-analytics'

Name Type Description
customerId

string

Log Analytics-klant-id
sharedKey

string

Log Analytics-klantsleutel

ManagedEnvironment

Een omgeving voor het hosten van container-apps

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

string

Soort omgeving.
location

string

De geografische locatie waar de resource zich bevindt
name

string

De naam van de resource
properties.appLogsConfiguration

AppLogsConfiguration

Clusterconfiguratie waarmee de logboekdaemon app-logboeken naar de geconfigureerde bestemming kan exporteren.
properties.customDomainConfiguration

CustomDomainConfiguration

Aangepaste domeinconfiguratie voor de omgeving
properties.daprAIConnectionString

string

Application Insights-verbindingsreeks die wordt gebruikt door Dapr voor het exporteren van telemetrie van service-naar-service-communicatie
properties.daprAIInstrumentationKey

string

Azure Monitor-instrumentatiesleutel die door Dapr wordt gebruikt voor het exporteren van telemetrie van service-naar-service-communicatie
properties.daprConfiguration

DaprConfiguration

De configuratie van het Dapr-onderdeel.
properties.defaultDomain

string

Standaarddomeinnaam voor het cluster
properties.deploymentErrors

string

Eventuele fouten die zijn opgetreden tijdens de implementatie of implementatievalidatie
properties.eventStreamEndpoint

string

Het eindpunt van de gebeurtenisstroom van de omgeving.
properties.infrastructureResourceGroup

string

Naam van de door het platform beheerde resourcegroep die is gemaakt voor de beheerde omgeving voor het hosten van infrastructuurresources. Als er een subnet-id is opgegeven, wordt deze resourcegroep gemaakt in hetzelfde abonnement als het subnet.
properties.kedaConfiguration

KedaConfiguration

De configuratie van Keda-onderdeel.
properties.peerAuthentication

PeerAuthentication

Peer-verificatie-instellingen voor de beheerde omgeving
properties.peerTrafficConfiguration

PeerTrafficConfiguration

Instellingen voor peerverkeer voor de beheerde omgeving
properties.provisioningState

EnvironmentProvisioningState

Inrichtingsstatus van de omgeving.
properties.staticIp

string

Statisch IP-adres van de omgeving
properties.vnetConfiguration

VnetConfiguration

VNet-configuratie voor de omgeving
properties.workloadProfiles

WorkloadProfile[]

Workloadprofielen die zijn geconfigureerd voor de beheerde omgeving.
properties.zoneRedundant

boolean

Of deze beheerde omgeving al dan niet zone-redundant is.
systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags

object

Resourcetags.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

Mtls

Configuratie-eigenschappen voor wederzijdse TLS-verificatie

Name Type Description
enabled

boolean

Booleaanse waarde die aangeeft of wederzijdse TLS-verificatie is ingeschakeld

PeerAuthentication

Peer-verificatie-instellingen voor de beheerde omgeving

Name Type Description
mtls

Mtls

Wederzijdse TLS-verificatie-instellingen voor de beheerde omgeving

PeerTrafficConfiguration

Instellingen voor peerverkeer voor de beheerde omgeving

Name Type Description
encryption

Encryption

Versleutelingsinstellingen voor peerverkeer voor de beheerde omgeving

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string

De tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string

De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

VnetConfiguration

Configuratie-eigenschappen voor de omgeving van apps om lid te worden van een virtueel netwerk

Name Type Description
dockerBridgeCidr

string

CIDR-notatie-IP-bereik dat is toegewezen aan de Docker-brug, het netwerk. Mag niet overlappen met andere opgegeven IP-bereiken.
infrastructureSubnetId

string

Resource-id van een subnet voor infrastructuuronderdelen. Mag niet overlappen met andere opgegeven IP-bereiken.
internal

boolean

Booleaanse waarde die aangeeft dat de omgeving alleen een interne load balancer heeft. Deze omgevingen hebben geen openbare statische IP-resource. Ze moeten infrastructureSubnetId opgeven als deze eigenschap is ingeschakeld
platformReservedCidr

string

IP-bereik in CIDR-notatie die kan worden gereserveerd voor IP-adressen van de omgevingsinfrastructuur. Mag niet overlappen met andere opgegeven IP-bereiken.
platformReservedDnsIP

string

Een IP-adres uit het IP-bereik dat is gedefinieerd door platformReservedCidr die wordt gereserveerd voor de interne DNS-server.

WorkloadProfile

Workloadprofiel voor het bereik van de uitvoering van container-apps.

Name Type Description
maximumCount

integer

De maximale capaciteit.
minimumCount

integer

De minimale capaciteit.
name

string

Het type workloadprofiel waarop de workloads moeten worden uitgevoerd.
workloadProfileType

string

Het type workloadprofiel waarop de workloads moeten worden uitgevoerd.