Kube Environments - Get

Reference

Service:: App Service

API Version:: 2023-12-01

Popis pro získání vlastností prostředí Kubernetes.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název prostředí Kubernetes
resourceGroupName	path	True	string	Název skupiny prostředků, do které prostředek patří. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	ID vašeho předplatného Azure Jedná se o řetězec ve formátu GUID (např. 00000000-0000-0000-0000-0000000000000000).
api-version	query	True	string	Verze rozhraní API

Odpovědi

Name	Typ	Description
200 OK	KubeEnvironment	OK
Other Status Codes	DefaultErrorResponse	App Service chybovou 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 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"
  }
}

Definice

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	App Service chybovou odpověď.
Details
Error	Model chyb.
ExtendedLocation	Rozšířené umístění.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Cluster Kubernetes specializovaný na webové úlohy podle Azure App Service
KubeEnvironmentProvisioningState	Stav zřizování prostředí Kubernetes
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Name	Typ	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Name	Typ	Description
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Name	Typ	Description
appSubnetResourceId	string	ID prostředku podsítě pro komponenty infrastruktury řídicí roviny Tato podsíť musí být ve stejné virtuální síti jako podsíť definovaná v appSubnetResourceId. Nesmí se překrývat s rozsahem IP adres definovaným v platformReservedCidr, pokud je definován.
controlPlaneSubnetResourceId	string	ID prostředku podsítě pro komponenty infrastruktury řídicí roviny Tato podsíť musí být ve stejné virtuální síti jako podsíť definovaná v appSubnetResourceId. Nesmí se překrývat s rozsahem IP adres definovaným v platformReservedCidr, pokud je definován.
daprAIInstrumentationKey	string	Instrumentační klíč služby Azure Monitor používaný nástrojem Dapr k exportu telemetrie komunikace mezi službami
dockerBridgeCidr	string	Rozsah IP adres notace CIDR přiřazený síti mostu Docker. Nesmí se překrývat s žádnými rozsahy IP adres podsítě ani s rozsahem IP adres definovaným v platformReservedCidr, pokud jsou definované.
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ým jiným rozsahem IP adres podsítě.
platformReservedDnsIP	string	IP adresa z rozsahu IP adres definovaného platformReservedCidr, který bude vyhrazen pro interní server DNS.

DefaultErrorResponse

App Service chybovou odpověď.

Name	Typ	Description
error	Error	Model chyb.

Details

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í

Error

Model chyb.

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby
details	Details[]	Podrobné chyby.
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í

ExtendedLocation

Rozšířené umístění.

Name	Typ	Description
name	string	Název rozšířeného umístění.
type	string	Typ rozšířeného umístění

FrontEndConfiguration

Name	Typ	Description
kind	FrontEndServiceType

FrontEndServiceType

Name	Typ	Description
LoadBalancer	string
NodePort	string

KubeEnvironment

Cluster Kubernetes specializovaný na webové úlohy podle Azure App Service

Name	Typ	Description
extendedLocation	ExtendedLocation	Rozšířené umístění.
id	string	ID prostředku.
kind	string	Druh prostředku.
location	string	Umístění prostředku.
name	string	Název prostředku.
properties.aksResourceID	string
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.arcConfiguration	ArcConfiguration	Konfigurace clusteru, která určuje typy součástí clusteru ARC. Například: Volba mezi typem buildservice, artefakty front-endové službyStorageType atd.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Konfigurace clusteru pro prostředí Container Apps pro konfiguraci instrumentačního klíče Dapr a konfigurace virtuální sítě
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.environmentType	string	Typ prostředí Kubernetes Podporováno pouze pro prostředí aplikací kontejneru s hodnotou Spravované
properties.internalLoadBalancerEnabled	boolean	Viditelné pouze v rámci virtuální sítě nebo podsítě
properties.provisioningState	KubeEnvironmentProvisioningState	Stav zřizování prostředí Kubernetes
properties.staticIp	string	Statická IP adresa prostředí KubeEnvironment
tags	object	Značky prostředků.
type	string	Typ prostředku.

KubeEnvironmentProvisioningState

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

Name	Typ	Description
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

LogAnalyticsConfiguration

Name	Typ	Description
customerId	string
sharedKey	string

StorageType

Name	Typ	Description
LocalNode	string
NetworkFileSystem	string