Kube Environments - Create Or Update

Dienst:

App Service

API-Version:

2025-05-01

Beschreibung für Erstellt oder aktualisiert eine Kubernetes-Umgebung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der Kubernetes-Umgebung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der geografische Standort, an dem sich die Ressource befindet
extendedLocation		ExtendedLocation	Erweiterter Speicherort.
kind		string	Art der Ressource.
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	Clusterkonfiguration, die es dem Log-Daemon ermöglicht, App-Protokolle an ein Ziel zu exportieren. Derzeit wird nur "log-analytics" unterstützt
properties.arcConfiguration		ArcConfiguration	Cluster-Konfiguration, die die Typen der ARC-Cluster-Komponenten bestimmt. Z.B.: Auswahl zwischen BuildService kind, FrontEnd Service ArtifactsStorageType usw.
properties.containerAppsConfiguration		ContainerAppsConfiguration	Clusterkonfiguration für Container-Apps-Umgebungen zum Konfigurieren von Dapr Instrumentation Key und VNET-Konfiguration
properties.environmentType		string	Typ der Kubernetes-Umgebung. Nur für Container-App-Umgebungen mit dem Wert "Verwaltet" unterstützt
properties.internalLoadBalancerEnabled		boolean	Nur in Vnet/Subnetz sichtbar
properties.staticIp		string	Statische IP des KubeEnvironment
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	KubeEnvironment	Die Aktualisierung der Ressource 'KubeEnvironment' war erfolgreich
201 Created	KubeEnvironment	Die Ressourcen-"KubeEnvironment"-Erstellungsoperation war erfolgreich Header Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Create kube environments

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Definitionen

Name	Beschreibung
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
DefaultErrorResponseError	Fehlermodell.
DefaultErrorResponseErrorDetailsItem	Detaillierte Fehler.
ExtendedLocation	Erweiterter Speicherort.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Ein Kubernetes-Cluster, der von Azure App Service auf Webworkloads spezialisiert ist
KubeEnvironmentProvisioningState	Bereitstellungsstatus der Kubernetes-Umgebung.
LogAnalyticsConfiguration
StorageType
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AppLogsConfiguration

Objekt

Name	Typ	Beschreibung
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Objekt

Name	Typ	Beschreibung
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string (password)

ContainerAppsConfiguration

Objekt

Name	Typ	Beschreibung
appSubnetResourceId	string	Ressourcen-ID eines Subnetzes für Komponenten der Steuerebeneninfrastruktur. Dieses Subnetz muss sich im selben VNET wie das in appSubnetResourceId definierte Subnetz befinden. Darf nicht mit dem in platformReservedCidr definierten IP-Bereich überlappen, falls definiert.
controlPlaneSubnetResourceId	string	Ressourcen-ID eines Subnetzes für Komponenten der Steuerebeneninfrastruktur. Dieses Subnetz muss sich im selben VNET wie das in appSubnetResourceId definierte Subnetz befinden. Darf nicht mit dem in platformReservedCidr definierten IP-Bereich überlappen, falls definiert.
daprAIInstrumentationKey	string	Azure Monitor-Instrumentierungsschlüssel, der von Dapr zum Exportieren von Dienst-in-Dienst-Kommunikationstelemetrie verwendet wird
dockerBridgeCidr	string	CIDR-Notation-IP-Bereich, der dem Docker-Brücke-Netzwerk zugewiesen ist. Sie darf sich nicht mit subnetzweiten IP-Bereichen oder dem in platformReservedCidr definierten IP-Bereich überlappen, sofern definiert.
platformReservedCidr	string	IP-Bereich in CIDR-Notation, der für IP-Adressen der Umgebungsinfrastruktur reserviert werden kann. Sie darf nicht mit anderen Subnetz-IP-Bereichen überlappen.
platformReservedDnsIP	string	Eine IP-Adresse aus dem durch platformReservedCidr definierten IP-Bereich, der für den internen DNS-Server reserviert wird

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	DefaultErrorResponseError	Fehlermodell.

DefaultErrorResponseError

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zur programmgesteuerten Identifizierung des Fehlers.
details	DefaultErrorResponseErrorDetailsItem[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.
target	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.

DefaultErrorResponseErrorDetailsItem

Objekt

Detaillierte Fehler.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zur programmgesteuerten Identifizierung des Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.
target	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.

ExtendedLocation

Objekt

Erweiterter Speicherort.

Name	Typ	Beschreibung
name	string	Name des erweiterten Speicherorts.
type	string	Art des erweiterten Standorts.

FrontEndConfiguration

Objekt

Name	Typ	Beschreibung
kind	FrontEndServiceType

FrontEndServiceType

Enumeration

Wert	Beschreibung
NodePort
LoadBalancer

KubeEnvironment

Objekt

Ein Kubernetes-Cluster, der von Azure App Service auf Webworkloads spezialisiert ist

Name	Typ	Beschreibung
extendedLocation	ExtendedLocation	Erweiterter Speicherort.
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Art der Ressource.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Clusterkonfiguration, die es dem Log-Daemon ermöglicht, App-Protokolle an ein Ziel zu exportieren. Derzeit wird nur "log-analytics" unterstützt
properties.arcConfiguration	ArcConfiguration	Cluster-Konfiguration, die die Typen der ARC-Cluster-Komponenten bestimmt. Z.B.: Auswahl zwischen BuildService kind, FrontEnd Service ArtifactsStorageType usw.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Clusterkonfiguration für Container-Apps-Umgebungen zum Konfigurieren von Dapr Instrumentation Key und VNET-Konfiguration
properties.defaultDomain	string	Standarddomänenname für den Cluster
properties.deploymentErrors	string	Alle Fehler, die während der Bereitstellung oder der Bereitstellungsvalidierung aufgetreten sind
properties.environmentType	string	Typ der Kubernetes-Umgebung. Nur für Container-App-Umgebungen mit dem Wert "Verwaltet" unterstützt
properties.internalLoadBalancerEnabled	boolean	Nur in Vnet/Subnetz sichtbar
properties.provisioningState	KubeEnvironmentProvisioningState	Bereitstellungsstatus der Kubernetes-Umgebung.
properties.staticIp	string	Statische IP des KubeEnvironment
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

KubeEnvironmentProvisioningState

Enumeration

Bereitstellungsstatus der Kubernetes-Umgebung.

Wert	Beschreibung
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

LogAnalyticsConfiguration

Objekt

Name	Typ	Beschreibung
customerId	string
sharedKey	string (password)

StorageType

Enumeration

Wert	Beschreibung
LocalNode
NetworkFileSystem

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.