Kube Environments - Get

Referensi

Service:: App Service

API Version:: 2023-12-01

Deskripsi untuk Mendapatkan properti Lingkungan Kubernetes.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
name	path	True	string	Nama Lingkungan Kubernetes.
resourceGroupName	path	True	string	Nama grup sumber daya tempat sumber daya berada. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	ID langganan Azure Anda. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	Versi API

Respons

Nama	Jenis	Deskripsi
200 OK	KubeEnvironment	OK
Other Status Codes	DefaultErrorResponse	App Service respons kesalahan.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	App Service respons kesalahan.
Details
Error	Model kesalahan.
ExtendedLocation	Lokasi Yang Diperluas.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Kluster Kubernetes khusus untuk beban kerja web dengan Azure App Service
KubeEnvironmentProvisioningState	Status penyediaan Lingkungan Kubernetes.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Nama	Jenis	Deskripsi
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Nama	Jenis	Deskripsi
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Nama	Jenis	Deskripsi
appSubnetResourceId	string	ID sumber daya subnet untuk komponen infrastruktur sarana kontrol. Subnet ini harus berada di VNET yang sama dengan subnet yang ditentukan dalam appSubnetResourceId. Tidak boleh tumpang tindih dengan rentang IP yang ditentukan dalam platformReservedCidr, jika ditentukan.
controlPlaneSubnetResourceId	string	ID sumber daya subnet untuk komponen infrastruktur sarana kontrol. Subnet ini harus berada di VNET yang sama dengan subnet yang ditentukan dalam appSubnetResourceId. Tidak boleh tumpang tindih dengan rentang IP yang ditentukan dalam platformReservedCidr, jika ditentukan.
daprAIInstrumentationKey	string	Kunci instrumentasi Azure Monitor yang digunakan oleh Dapr untuk mengekspor telemetri komunikasi Layanan ke Layanan
dockerBridgeCidr	string	Rentang IP notasi CIDR yang ditetapkan ke jaringan jembatan Docker. Ini tidak boleh tumpang tindih dengan rentang IP Subnet atau rentang IP yang ditentukan dalam platformReservedCidr, jika ditentukan.
platformReservedCidr	string	Rentang IP dalam notasi CIDR yang dapat dicadangkan untuk alamat IP infrastruktur lingkungan. Ini tidak boleh tumpang tindih dengan rentang IP Subnet lainnya.
platformReservedDnsIP	string	Alamat IP dari rentang IP yang ditentukan oleh platformReservedCidr yang akan dicadangkan untuk server DNS internal

DefaultErrorResponse

App Service respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Model kesalahan.

Details

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
message	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

Error

Model kesalahan.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
details	Details[]	Kesalahan terperinci.
innererror	string	Informasi selengkapnya untuk men-debug kesalahan.
message	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

ExtendedLocation

Lokasi Yang Diperluas.

Nama	Jenis	Deskripsi
name	string	Nama lokasi yang diperluas.
type	string	Jenis lokasi yang diperluas.

FrontEndConfiguration

Nama	Jenis	Deskripsi
kind	FrontEndServiceType

FrontEndServiceType

Nama	Jenis	Deskripsi
LoadBalancer	string
NodePort	string

KubeEnvironment

Kluster Kubernetes khusus untuk beban kerja web dengan Azure App Service

Nama	Jenis	Deskripsi
extendedLocation	ExtendedLocation	Lokasi Yang Diperluas.
id	string	Id Sumber Daya.
kind	string	Jenis sumber daya.
location	string	Lokasi Sumber Daya.
name	string	Nama Sumber Daya.
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Konfigurasi kluster yang memungkinkan daemon log untuk mengekspor log aplikasi ke tujuan. Saat ini hanya "analitik log" yang didukung
properties.arcConfiguration	ArcConfiguration	Konfigurasi kluster yang menentukan jenis komponen kluster ARC. Misalnya: Memilih antara jenis BuildService, FrontEnd Service ArtifactsStorageType dll.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Konfigurasi kluster untuk Lingkungan Container Apps untuk mengonfigurasi Kunci Instrumentasi Dapr dan Konfigurasi VNET
properties.defaultDomain	string	Nama Domain Default untuk kluster
properties.deploymentErrors	string	Kesalahan apa pun yang terjadi selama penyebaran atau validasi penyebaran
properties.environmentType	string	Jenis Lingkungan Kubernetes. Hanya didukung untuk Lingkungan Aplikasi Kontainer dengan nilai sebagai Terkelola
properties.internalLoadBalancerEnabled	boolean	Hanya terlihat dalam Vnet/Subnet
properties.provisioningState	KubeEnvironmentProvisioningState	Status penyediaan Lingkungan Kubernetes.
properties.staticIp	string	IP statis KubeEnvironment
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

KubeEnvironmentProvisioningState

Status penyediaan Lingkungan Kubernetes.

Nama	Jenis	Deskripsi
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

LogAnalyticsConfiguration

Nama	Jenis	Deskripsi
customerId	string
sharedKey	string

StorageType

Nama	Jenis	Deskripsi
LocalNode	string
NetworkFileSystem	string