Managed Environments - Get

Pobierz właściwości środowiska zarządzanego używanego do hostowania aplikacji kontenera.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
environmentName
path True

string

Nazwa środowiska.

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

ManagedEnvironment

OK

Other Status Codes

DefaultErrorResponse

Typowa odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa Opis
AppLogsConfiguration

Konfiguracja dzienników aplikacji

createdByType

Typ tożsamości, która utworzyła zasób.

CustomDomainConfiguration

Właściwości konfiguracji dla domeny niestandardowej środowiska aplikacji

DaprConfiguration

Właściwości konfiguracji— składnik języka Dapr

DefaultErrorResponse

App Service odpowiedź na błąd.

Details

Szczegóły lub błąd

Encryption

Ustawienia szyfrowania ruchu równorzędnego dla środowiska zarządzanego

EnvironmentProvisioningState

Stan aprowizacji środowiska.

Error

Model błędu.

KedaConfiguration

Właściwości konfiguracji składnika Keda

LogAnalyticsConfiguration

Konfiguracja usługi Log Analytics musi być podana tylko wtedy, gdy lokalizacja docelowa jest skonfigurowana jako "log-analytics"

ManagedEnvironment

Środowisko do hostowania aplikacji kontenerów

Mtls

Właściwości konfiguracji wzajemnego uwierzytelniania TLS

PeerAuthentication

Ustawienia uwierzytelniania równorzędnego dla środowiska zarządzanego

PeerTrafficConfiguration

Ustawienia ruchu równorzędnego dla środowiska zarządzanego

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

VnetConfiguration

Właściwości konfiguracji środowiska aplikacji w celu dołączenia do Virtual Network

WorkloadProfile

Profil obciążenia umożliwiający określanie zakresu wykonywania aplikacji kontenera.

AppLogsConfiguration

Konfiguracja dzienników aplikacji

Nazwa Typ Opis
destination

string

Miejsce docelowe dzienników może być "log-analytics", "azure-monitor" lub "none"

logAnalyticsConfiguration

LogAnalyticsConfiguration

Konfiguracja usługi Log Analytics musi być podana tylko wtedy, gdy lokalizacja docelowa jest skonfigurowana jako "log-analytics"

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

CustomDomainConfiguration

Właściwości konfiguracji dla domeny niestandardowej środowiska aplikacji

Nazwa Typ Opis
certificatePassword

string

Hasło certyfikatu

certificateValue

string

Obiekt blob PFX lub PEM

customDomainVerificationId

string

Identyfikator używany do weryfikowania własności nazwy domeny

dnsSuffix

string

Sufiks DNS dla domeny środowiska

expirationDate

string

Data wygaśnięcia certyfikatu.

subjectName

string

Nazwa podmiotu certyfikatu.

thumbprint

string

Odcisk palca certyfikatu.

DaprConfiguration

Właściwości konfiguracji— składnik języka Dapr

Nazwa Typ Opis
version

string

Wersja języka Dapr

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa Typ Opis
error

Error

Model błędu.

Details

Szczegóły lub błąd

Nazwa Typ Opis
code

string

Ustandaryzowany ciąg w celu programowego identyfikowania błędu.

message

string

Szczegółowy opis błędu i informacje o debugowaniu.

target

string

Szczegółowy opis błędu i informacje o debugowaniu.

Encryption

Ustawienia szyfrowania ruchu równorzędnego dla środowiska zarządzanego

Nazwa Typ Opis
enabled

boolean

Wartość logiczna wskazująca, czy szyfrowanie ruchu równorzędnego jest włączone

EnvironmentProvisioningState

Stan aprowizacji środowiska.

Nazwa Typ Opis
Canceled

string

Failed

string

InfrastructureSetupComplete

string

InfrastructureSetupInProgress

string

InitializationInProgress

string

ScheduledForDelete

string

Succeeded

string

UpgradeFailed

string

UpgradeRequested

string

Waiting

string

Error

Model błędu.

Nazwa Typ Opis
code

string

Ustandaryzowany ciąg w celu programowego identyfikowania błędu.

details

Details[]

Szczegóły lub błąd

innererror

string

Więcej informacji na temat debugowania błędu.

message

string

Szczegółowy opis błędu i informacje o debugowaniu.

target

string

Szczegółowy opis błędu i informacje o debugowaniu.

KedaConfiguration

Właściwości konfiguracji składnika Keda

Nazwa Typ Opis
version

string

Wersja Keda

LogAnalyticsConfiguration

Konfiguracja usługi Log Analytics musi być podana tylko wtedy, gdy lokalizacja docelowa jest skonfigurowana jako "log-analytics"

Nazwa Typ Opis
customerId

string

Identyfikator klienta usługi Log Analytics

sharedKey

string

Klucz klienta usługi Log Analytics

ManagedEnvironment

Środowisko do hostowania aplikacji kontenerów

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

string

Rodzaj środowiska.

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.appLogsConfiguration

AppLogsConfiguration

Konfiguracja klastra, która umożliwia demonowi dziennika eksportowanie dzienników do miejsca docelowego. Obecnie obsługiwane są tylko "log-analytics"

properties.customDomainConfiguration

CustomDomainConfiguration

Konfiguracja domeny niestandardowej dla środowiska

properties.daprAIConnectionString

string

Usługa Application Insights parametry połączenia używana przez dapr do eksportowania danych telemetrycznych komunikacji usługi do usługi

properties.daprAIInstrumentationKey

string

Klucz instrumentacji usługi Azure Monitor używany przez dapr do eksportowania danych telemetrycznych komunikacji między usługami

properties.daprConfiguration

DaprConfiguration

Konfiguracja składnika Dapr.

properties.defaultDomain

string

Domyślna nazwa domeny klastra

properties.deploymentErrors

string

Wszelkie błędy, które wystąpiły podczas wdrażania lub walidacji wdrożenia

properties.eventStreamEndpoint

string

Punkt końcowy strumienia zdarzeń środowiska.

properties.infrastructureResourceGroup

string

Nazwa zarządzanej przez platformę grupy zasobów utworzonej dla środowiska zarządzanego do hostowania zasobów infrastruktury. Jeśli zostanie podany identyfikator podsieci, ta grupa zasobów zostanie utworzona w tej samej subskrypcji co podsieć.

properties.kedaConfiguration

KedaConfiguration

Konfiguracja składnika Keda.

properties.peerAuthentication

PeerAuthentication

Ustawienia uwierzytelniania równorzędnego dla środowiska zarządzanego

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Ustawienia ruchu równorzędnego dla środowiska zarządzanego

properties.provisioningState

EnvironmentProvisioningState

Stan aprowizacji środowiska.

properties.staticIp

string

Statyczny adres IP środowiska

properties.vnetConfiguration

VnetConfiguration

Konfiguracja sieci wirtualnej dla środowiska

properties.workloadProfiles

WorkloadProfile[]

Profile obciążeń skonfigurowane dla środowiska zarządzanego.

properties.zoneRedundant

boolean

Bez względu na to, czy to środowisko zarządzane jest strefowo nadmiarowe.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

Mtls

Właściwości konfiguracji wzajemnego uwierzytelniania TLS

Nazwa Typ Opis
enabled

boolean

Wartość logiczna wskazująca, czy wzajemne uwierzytelnianie TLS jest włączone

PeerAuthentication

Ustawienia uwierzytelniania równorzędnego dla środowiska zarządzanego

Nazwa Typ Opis
mtls

Mtls

Wzajemne ustawienia uwierzytelniania TLS dla środowiska zarządzanego

PeerTrafficConfiguration

Ustawienia ruchu równorzędnego dla środowiska zarządzanego

Nazwa Typ Opis
encryption

Encryption

Ustawienia szyfrowania ruchu równorzędnego dla środowiska zarządzanego

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

VnetConfiguration

Właściwości konfiguracji środowiska aplikacji w celu dołączenia do Virtual Network

Nazwa Typ Opis
dockerBridgeCidr

string

Zakres adresów IP notacji CIDR przypisany do mostka platformy Docker, sieć. Nie może pokrywać się z żadnymi innymi podanymi zakresami adresów IP.

infrastructureSubnetId

string

Identyfikator zasobu podsieci dla składników infrastruktury. Nie może pokrywać się z żadnymi innymi podanymi zakresami adresów IP.

internal

boolean

Wartość logiczna wskazująca, że środowisko ma tylko wewnętrzny moduł równoważenia obciążenia. Te środowiska nie mają publicznego zasobu statycznego adresu IP. Jeśli ta właściwość jest włączona, muszą podać parametr infrastructureSubnetId

platformReservedCidr

string

Zakres adresów IP w notacji CIDR, który można zarezerwować dla adresów IP infrastruktury środowiska. Nie może pokrywać się z żadnymi innymi podanymi zakresami adresów IP.

platformReservedDnsIP

string

Adres IP z zakresu adresów IP zdefiniowany przez platformęReservedCidr, który będzie zarezerwowany dla wewnętrznego serwera DNS.

WorkloadProfile

Profil obciążenia umożliwiający określanie zakresu wykonywania aplikacji kontenera.

Nazwa Typ Opis
maximumCount

integer

Maksymalna pojemność.

minimumCount

integer

Minimalna pojemność.

name

string

Typ profilu obciążenia dla obciążeń do uruchomienia.

workloadProfileType

string

Typ profilu obciążenia dla obciążeń do uruchomienia.