Kube Environments - Get

Tjänst:

App Service

API-version:

2023-12-01

Beskrivning för Hämta egenskaperna för en Kubernetes-miljö.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Namnet på Kubernetes-miljön.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Namnet på resursgruppen som resursen tillhör.
subscriptionId	path	True	string	Ditt Azure-prenumerations-ID. Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-version

Svar

Name	Typ	Description
200 OK	KubeEnvironment	OKEJ
Other Status Codes	DefaultErrorResponse	App Service-felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get kube environments by name

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	App Service-felsvar.
Details
Error	Felmodell.
ExtendedLocation	Utökad plats.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Ett Kubernetes-kluster som är specialiserat på webbarbetsbelastningar av Azure App Service
KubeEnvironmentProvisioningState	Etableringstillstånd för Kubernetes-miljön.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Objekt

Name	Typ	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Objekt

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

ContainerAppsConfiguration

Objekt

Name	Typ	Description
appSubnetResourceId	string	Resurs-ID för ett undernät för kontrollplansinfrastrukturkomponenter. Det här undernätet måste finnas i samma VNET som det undernät som definierats i appSubnetResourceId. Får inte överlappa med DET IP-intervall som definierats i platformReservedCidr, om det definieras.
controlPlaneSubnetResourceId	string	Resurs-ID för ett undernät för kontrollplansinfrastrukturkomponenter. Det här undernätet måste finnas i samma VNET som det undernät som definierats i appSubnetResourceId. Får inte överlappa med DET IP-intervall som definierats i platformReservedCidr, om det definieras.
daprAIInstrumentationKey	string	Azure Monitor-instrumentationsnyckel som används av Dapr för att exportera telemetri för tjänst-till-tjänstkommunikation
dockerBridgeCidr	string	IP-intervall för CIDR-notation som tilldelats Docker-bryggnätverket. Den får inte överlappa med några IP-intervall för undernätet eller det IP-intervall som definierats i platformReservedCidr, om det definieras.
platformReservedCidr	string	IP-intervall i CIDR-notation som kan reserveras för IP-adresser för miljöinfrastruktur. Den får inte överlappa andra IP-intervall för undernätet.
platformReservedDnsIP	string	En IP-adress från IP-intervallet som definieras av platformReservedCidr som kommer att reserveras för den interna DNS-servern

DefaultErrorResponse

Objekt

App Service-felsvar.

Name	Typ	Description
error	Error	Felmodell.

Details

Objekt

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

Error

Objekt

Felmodell.

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
details	Details[]	Detaljerade fel.
innererror	string	Mer information om felsökningsfel.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

ExtendedLocation

Objekt

Utökad plats.

Name	Typ	Description
name	string	Namn på utökad plats.
type	string	Typ av utökad plats.

FrontEndConfiguration

Objekt

Name	Typ	Description
kind	FrontEndServiceType

FrontEndServiceType

Uppräkning

Värde	Description
NodePort
LoadBalancer

KubeEnvironment

Objekt

Ett Kubernetes-kluster som är specialiserat på webbarbetsbelastningar av Azure App Service

Name	Typ	Description
extendedLocation	ExtendedLocation	Utökad plats.
id	string	Resurs-ID.
kind	string	Typ av resurs.
location	string	Resursplats.
name	string	Resursnamn.
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Klusterkonfiguration som gör att loggdaemonen kan exportera apploggar till ett mål. För närvarande stöds endast "log-analytics"
properties.arcConfiguration	ArcConfiguration	Klusterkonfiguration som avgör typerna av ARC-klusterkomponenter. Till exempel: Välja mellan BuildService-typ, FrontEnd Service ArtifactsStorageType osv.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Klusterkonfiguration för Container Apps-miljöer för att konfigurera Dapr Instrumentation Key och VNET-konfiguration
properties.defaultDomain	string	Standarddomännamn för klustret
properties.deploymentErrors	string	Eventuella fel som inträffade under distributions- eller distributionsvalidering
properties.environmentType	string	Typ av Kubernetes-miljö. Stöds endast för containerappmiljöer med värdet Hanterad
properties.internalLoadBalancerEnabled	boolean	Endast synligt i Vnet/undernät
properties.provisioningState	KubeEnvironmentProvisioningState	Etableringstillstånd för Kubernetes-miljön.
properties.staticIp	string	Statisk IP för KubeEnvironment
tags	object	Resurstaggar.
type	string	Resurstyp.

KubeEnvironmentProvisioningState

Uppräkning

Etableringstillstånd för Kubernetes-miljön.

Värde	Description
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

LogAnalyticsConfiguration

Objekt

Name	Typ	Description
customerId	string
sharedKey	string

StorageType

Uppräkning

Värde	Description
LocalNode
NetworkFileSystem