Kube Environments - Get

Riferimento

Service:: App Service

API Version:: 2023-12-01

Descrizione per Ottenere le proprietà di un ambiente Kubernetes.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
name	path	True	string	Nome dell'ambiente Kubernetes.
resourceGroupName	path	True	string	Nome del gruppo di risorse a cui appartiene la risorsa. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	L'ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Versione API

Risposte

Nome	Tipo	Descrizione
200 OK	KubeEnvironment	OK
Other Status Codes	DefaultErrorResponse	servizio app risposta di errore.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	servizio app risposta di errore.
Details
Error	Modello di errore.
ExtendedLocation	Posizione estesa.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Un cluster Kubernetes specializzato per carichi di lavoro Web Servizio app di Azure
KubeEnvironmentProvisioningState	Stato di provisioning dell'ambiente Kubernetes.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Nome	Tipo	Descrizione
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Nome	Tipo	Descrizione
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Nome	Tipo	Descrizione
appSubnetResourceId	string	ID risorsa di una subnet per i componenti dell'infrastruttura del piano di controllo. Questa subnet deve trovarsi nella stessa rete virtuale della subnet definita in appSubnetResourceId. Non deve sovrapporsi all'intervallo IP definito in platformReservedCidr, se definito.
controlPlaneSubnetResourceId	string	ID risorsa di una subnet per i componenti dell'infrastruttura del piano di controllo. Questa subnet deve trovarsi nella stessa rete virtuale della subnet definita in appSubnetResourceId. Non deve sovrapporsi all'intervallo IP definito in platformReservedCidr, se definito.
daprAIInstrumentationKey	string	Chiave di strumentazione di Monitoraggio di Azure usata da Dapr per esportare i dati di telemetria della comunicazione dal servizio al servizio
dockerBridgeCidr	string	Intervallo IP di notazione CIDR assegnato alla rete del bridge Docker. Non deve sovrapporsi ad alcun intervallo IP subnet o all'intervallo IP definito in platformReservedCidr, se definito.
platformReservedCidr	string	Intervallo IP nella notazione CIDR che può essere riservato per gli indirizzi IP dell'infrastruttura di ambiente. Non deve sovrapporsi ad altri intervalli IP subnet.
platformReservedDnsIP	string	Un indirizzo IP dall'intervallo IP definito da platformReservedCidr che verrà riservato per il server DNS interno

DefaultErrorResponse

servizio app risposta di errore.

Nome	Tipo	Descrizione
error	Error	Modello di errore.

Details

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

Error

Modello di errore.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
details	Details[]	Errori dettagliati.
innererror	string	Altre informazioni per eseguire il debug dell'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

ExtendedLocation

Posizione estesa.

Nome	Tipo	Descrizione
name	string	Nome della posizione estesa.
type	string	Tipo di posizione estesa.

FrontEndConfiguration

Nome	Tipo	Descrizione
kind	FrontEndServiceType

FrontEndServiceType

Nome	Tipo	Descrizione
LoadBalancer	string
NodePort	string

KubeEnvironment

Un cluster Kubernetes specializzato per carichi di lavoro Web Servizio app di Azure

Nome	Tipo	Descrizione
extendedLocation	ExtendedLocation	Posizione estesa.
id	string	ID risorsa.
kind	string	Tipo di risorsa.
location	string	Posizione risorsa.
name	string	Nome risorsa.
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Configurazione del cluster che consente al daemon di log di esportare i log delle app in una destinazione. Attualmente è supportato solo "log-analytics"
properties.arcConfiguration	ArcConfiguration	Configurazione del cluster che determina i tipi di componenti del cluster ARC. Ad esempio: scelta tra il tipo BuildService, gli artefatti del servizio FrontEndStorageType e così via.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Configurazione del cluster per ambienti di app contenitore per configurare la chiave di strumentazione Dapr e la configurazione della rete virtuale
properties.defaultDomain	string	Nome di dominio predefinito per il cluster
properties.deploymentErrors	string	Eventuali errori che si sono verificati durante la distribuzione o la convalida della distribuzione
properties.environmentType	string	Tipo di ambiente Kubernetes. Supportato solo per gli ambienti app contenitore con valore gestito
properties.internalLoadBalancerEnabled	boolean	Visibile solo all'interno della rete virtuale/subnet
properties.provisioningState	KubeEnvironmentProvisioningState	Stato di provisioning dell'ambiente Kubernetes.
properties.staticIp	string	IP statico di KubeEnvironment
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

KubeEnvironmentProvisioningState

Stato di provisioning dell'ambiente Kubernetes.

Nome	Tipo	Descrizione
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

LogAnalyticsConfiguration

Nome	Tipo	Descrizione
customerId	string
sharedKey	string

StorageType

Nome	Tipo	Descrizione
LocalNode	string
NetworkFileSystem	string