Kube Environments - Create Or Update

Layanan:

App Service

Versi API:

2025-05-01

Deskripsi untuk Membuat atau memperbarui Lingkungan Kubernetes.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
name	path	True	string	Nama lingkungan Kubernetes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
location	True	string	Lokasi geografis tempat sumber daya berada
extendedLocation		ExtendedLocation	Lokasi yang Diperluas.
kind		string	Jenis 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 Aplikasi Kontainer untuk mengonfigurasi Kunci Instrumentasi Dapr dan Konfigurasi VNET
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.staticIp		string	IP statis KubeEnvironment
tags		object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	KubeEnvironment	Operasi pembaruan 'KubeEnvironment' sumber daya berhasil
201 Created	KubeEnvironment	Resource 'KubeEnvironment' membuat operasi berhasil Header Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Create kube environments

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv?api-version=2025-05-01

{
  "location": "East US",
  "properties": {
    "staticIp": "1.2.3.4"
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.KubeEnvironmentInner;

/**
 * Samples for KubeEnvironments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/KubeEnvironments_CreateOrUpdate.json
     */
    /**
     * Sample code: Create kube environments.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void createKubeEnvironments(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getKubeEnvironments().createOrUpdate("examplerg", "testkubeenv",
            new KubeEnvironmentInner().withLocation("East US").withStaticIp("1.2.3.4"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/KubeEnvironments_CreateOrUpdate.json
func ExampleKubeEnvironmentsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKubeEnvironmentsClient().BeginCreateOrUpdate(ctx, "examplerg", "testkubeenv", armappservice.KubeEnvironment{
		Location: to.Ptr("East US"),
		Properties: &armappservice.KubeEnvironmentProperties{
			StaticIP: to.Ptr("1.2.3.4"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.KubeEnvironmentsClientCreateOrUpdateResponse{
	// 	KubeEnvironment: &armappservice.KubeEnvironment{
	// 		Name: to.Ptr("testkubeenv"),
	// 		Type: to.Ptr("Microsoft.Web/kubeEnvironments"),
	// 		ExtendedLocation: &armappservice.ExtendedLocation{
	// 			Name: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
	// 			Type: to.Ptr("customLocation"),
	// 		},
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv"),
	// 		Location: to.Ptr("East US"),
	// 		Properties: &armappservice.KubeEnvironmentProperties{
	// 			AksResourceID: to.Ptr("test"),
	// 			DefaultDomain: to.Ptr("testkubeenv.k4apps.io"),
	// 			InternalLoadBalancerEnabled: to.Ptr(false),
	// 			ProvisioningState: to.Ptr(armappservice.KubeEnvironmentProvisioningStateSucceeded),
	// 			StaticIP: to.Ptr("1.2.3.4"),
	// 		},
	// 		Tags: map[string]*string{
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:

200

{
  "name": "testkubeenv",
  "type": "Microsoft.Web/kubeEnvironments",
  "extendedLocation": {
    "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv",
  "location": "East US",
  "properties": {
    "aksResourceID": "test",
    "appLogsConfiguration": null,
    "arcConfiguration": null,
    "defaultDomain": "testkubeenv.k4apps.io",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "provisioningState": "Succeeded",
    "staticIp": "1.2.3.4"
  },
  "tags": {}
}

Kode status:

201

{
  "name": "testkubeenv",
  "type": "Microsoft.Web/kubeEnvironments",
  "extendedLocation": {
    "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv",
  "location": "East US",
  "properties": {
    "aksResourceID": "test",
    "appLogsConfiguration": null,
    "arcConfiguration": null,
    "defaultDomain": "testkubeenv.k4apps.io",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "provisioningState": "InitializationInProgress",
    "staticIp": "1.2.3.4"
  },
  "tags": {}
}

Definisi

Nama	Deskripsi
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	Jenis identitas yang membuat sumber daya.
DefaultErrorResponse	Respons kesalahan App Service.
DefaultErrorResponseError	Model kesalahan.
DefaultErrorResponseErrorDetailsItem	Kesalahan terperinci.
ExtendedLocation	Lokasi yang Diperluas.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Kluster Kubernetes khusus untuk beban kerja web oleh Azure App Service
KubeEnvironmentProvisioningState	Status penyediaan Lingkungan Kubernetes.
LogAnalyticsConfiguration
StorageType
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AppLogsConfiguration

Objek

Nama	Jenis	Deskripsi
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Objek

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

ContainerAppsConfiguration

Objek

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 Service to Service
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

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objek

Respons kesalahan App Service.

Nama	Jenis	Deskripsi
error	DefaultErrorResponseError	Model kesalahan.

DefaultErrorResponseError

Objek

Model kesalahan.

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

DefaultErrorResponseErrorDetailsItem

Objek

Kesalahan terperinci.

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

ExtendedLocation

Objek

Lokasi yang Diperluas.

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

FrontEndConfiguration

Objek

Nama	Jenis	Deskripsi
kind	FrontEndServiceType

FrontEndServiceType

Enumerasi

Nilai	Deskripsi
NodePort
LoadBalancer

KubeEnvironment

Objek

Kluster Kubernetes khusus untuk beban kerja web oleh Azure App Service

Nama	Jenis	Deskripsi
extendedLocation	ExtendedLocation	Lokasi yang Diperluas.
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Jenis sumber daya.
location	string	Lokasi geografis tempat sumber daya berada
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 Aplikasi Kontainer untuk mengonfigurasi Kunci Instrumentasi Dapr dan Konfigurasi VNET
properties.defaultDomain	string	Nama Domain Default untuk kluster
properties.deploymentErrors	string	Setiap kesalahan 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
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

KubeEnvironmentProvisioningState

Enumerasi

Status penyediaan Lingkungan Kubernetes.

Nilai	Deskripsi
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

LogAnalyticsConfiguration

Objek

Nama	Jenis	Deskripsi
customerId	string
sharedKey	string (password)

StorageType

Enumerasi

Nilai	Deskripsi
LocalNode
NetworkFileSystem

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.