Kube Environments - Get

Odwołanie

Service:: App Service

API Version:: 2023-12-01

Opis właściwości środowiska Kubernetes.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}?api-version=2023-12-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa środowiska Kubernetes.
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy zasób. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-0000000000000000000000000000000000000000 00000).
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	KubeEnvironment	OK
Other Status Codes	DefaultErrorResponse	App Service 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 kube environments by name

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1",
  "name": "jlaw-demo1",
  "type": "Microsoft.Web/kubeEnvironments",
  "location": "North Central US",
  "extendedLocation": {
    "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "defaultDomain": "jlaw-demo1.k4apps.io",
    "staticIp": "20.42.33.145",
    "arcConfiguration": null,
    "appLogsConfiguration": null,
    "aksResourceID": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ContainerService/managedClusters/jlaw-demo1"
  }
}

Definicje

Nazwa	Opis
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	App Service odpowiedź na błąd.
Details
Error	Model błędu.
ExtendedLocation	Lokalizacja rozszerzona.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Klaster Kubernetes wyspecjalizowany w przypadku obciążeń internetowych przez Azure App Service
KubeEnvironmentProvisioningState	Stan aprowizacji środowiska Kubernetes.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Nazwa	Typ	Opis
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Nazwa	Typ	Opis
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Nazwa	Typ	Opis
appSubnetResourceId	string	Identyfikator zasobu podsieci dla składników infrastruktury płaszczyzny sterowania. Ta podsieć musi znajdować się w tej samej sieci wirtualnej co podsieć zdefiniowana w parametrze appSubnetResourceId. Nie może nakładać się na zakres adresów IP zdefiniowany w parametrze PlatformReservedCidr, jeśli jest zdefiniowany.
controlPlaneSubnetResourceId	string	Identyfikator zasobu podsieci dla składników infrastruktury płaszczyzny sterowania. Ta podsieć musi znajdować się w tej samej sieci wirtualnej co podsieć zdefiniowana w parametrze appSubnetResourceId. Nie może nakładać się na zakres adresów IP zdefiniowany w parametrze PlatformReservedCidr, jeśli jest zdefiniowany.
daprAIInstrumentationKey	string	Klucz instrumentacji usługi Azure Monitor używany przez narzędzie Dapr do eksportowania danych telemetrycznych komunikacji między usługami
dockerBridgeCidr	string	Zakres adresów IP notacji CIDR przypisany do sieci mostka platformy Docker. Nie może nakładać się na żadne zakresy adresów IP podsieci ani zakres adresów IP zdefiniowany w polu PlatformReservedCidr, jeśli jest zdefiniowany.
platformReservedCidr	string	Zakres adresów IP w notacji CIDR, który może być zarezerwowany dla adresów IP infrastruktury środowiska. Nie może nakładać się na inne zakresy adresów IP podsieci.
platformReservedDnsIP	string	Adres IP z zakresu adresów IP zdefiniowany przez platformęReservedCidr, który będzie zarezerwowany dla wewnętrznego serwera DNS

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

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.

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat błędu debugowania.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

ExtendedLocation

Lokalizacja rozszerzona.

Nazwa	Typ	Opis
name	string	Nazwa lokalizacji rozszerzonej.
type	string	Typ lokalizacji rozszerzonej.

FrontEndConfiguration

Nazwa	Typ	Opis
kind	FrontEndServiceType

FrontEndServiceType

Nazwa	Typ	Opis
LoadBalancer	string
NodePort	string

KubeEnvironment

Klaster Kubernetes wyspecjalizowany w przypadku obciążeń internetowych przez Azure App Service

Nazwa	Typ	Opis
extendedLocation	ExtendedLocation	Lokalizacja rozszerzona.
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Konfiguracja klastra, która umożliwia demonowi dziennika eksportowanie dzienników aplikacji do miejsca docelowego. Obecnie obsługiwane są tylko "log-analytics"
properties.arcConfiguration	ArcConfiguration	Konfiguracja klastra, która określa typy składników klastra ARC. Na przykład: wybór między rodzajem buildService, artefaktami usługi FrontEndStorageType itp.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Konfiguracja klastra dla środowisk Container Apps w celu skonfigurowania klucza instrumentacji dapr i konfiguracji sieci wirtualnej
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.environmentType	string	Typ środowiska Kubernetes. Obsługiwane tylko dla środowisk aplikacji kontenera z wartością zarządzaną
properties.internalLoadBalancerEnabled	boolean	Widoczne tylko w sieci wirtualnej/podsieci
properties.provisioningState	KubeEnvironmentProvisioningState	Stan aprowizacji środowiska Kubernetes.
properties.staticIp	string	Statyczny adres IP środowiska KubeEnvironment
tags	object	Tagi zasobów.
type	string	Typ zasobu.

KubeEnvironmentProvisioningState

Stan aprowizacji środowiska Kubernetes.

Nazwa	Typ	Opis
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

LogAnalyticsConfiguration

Nazwa	Typ	Opis
customerId	string
sharedKey	string

StorageType

Nazwa	Typ	Opis
LocalNode	string
NetworkFileSystem	string