Kube Environments - Create Or Update

Service:

App Service

API-versie:

2025-05-01

Beschrijving voor Het maken of bijwerken van een Kubernetes-omgeving.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van de Kubernetes-omgeving.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	De geografische locatie waar de resource zich bevindt
extendedLocation		ExtendedLocation	Uitgebreide locatie.
kind		string	Soort resource.
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	Clusterconfiguratie waarmee de logdaemon app-logboeken naar een bestemming kan exporteren. Momenteel wordt alleen "log-analytics" ondersteund
properties.arcConfiguration		ArcConfiguration	Clusterconfiguratie die de typen ARC-clustercomponenten bepaalt. Bijvoorbeeld: Kiezen tussen BuildService kind, FrontEnd Service ArtifactsStorageType etc.
properties.containerAppsConfiguration		ContainerAppsConfiguration	Clusterconfiguratie voor Container Apps-omgevingen voor het configureren van de Dapr Instrumentation-sleutel en VNET-configuratie
properties.environmentType		string	Type Kubernetes-omgeving. Alleen ondersteund voor container-app-omgevingen met waarde als beheerd
properties.internalLoadBalancerEnabled		boolean	Alleen zichtbaar in Vnet/Subnet
properties.staticIp		string	Statisch IP-adres van kubeEnvironment
tags		object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	KubeEnvironment	De update-operatie van de bron 'KubeEnvironment' is geslaagd
201 Created	KubeEnvironment	Resource 'KubeEnvironment' genereerde operatie geslaagd Kopteksten Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Create kube environments

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	Het type identiteit waarmee de resource is gemaakt.
DefaultErrorResponse	Foutreactie van App Service.
DefaultErrorResponseError	Foutmodel.
DefaultErrorResponseErrorDetailsItem	Gedetailleerde fouten.
ExtendedLocation	Uitgebreide locatie.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Een Kubernetes-cluster dat is gespecialiseerd in webworkloads door Azure App Service
KubeEnvironmentProvisioningState	Provisioningstatus van de Kubernetes-omgeving.
LogAnalyticsConfiguration
StorageType
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AppLogsConfiguration

Object

Name	Type	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Object

Name	Type	Description
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string (password)

ContainerAppsConfiguration

Object

Name	Type	Description
appSubnetResourceId	string	Resource-id van een subnet voor onderdelen van de besturingsvlakinfrastructuur. Dit subnet moet zich in hetzelfde VNET bevinden als het subnet dat is gedefinieerd in appSubnetResourceId. Mag niet overlappen met het IP-bereik dat is gedefinieerd in platformReservedCidr, indien gedefinieerd.
controlPlaneSubnetResourceId	string	Resource-id van een subnet voor onderdelen van de besturingsvlakinfrastructuur. Dit subnet moet zich in hetzelfde VNET bevinden als het subnet dat is gedefinieerd in appSubnetResourceId. Mag niet overlappen met het IP-bereik dat is gedefinieerd in platformReservedCidr, indien gedefinieerd.
daprAIInstrumentationKey	string	Azure Monitor-instrumentatiesleutel die door Dapr wordt gebruikt voor het exporteren van telemetrie van service-naar-service-communicatie
dockerBridgeCidr	string	CIDR-notatie-IP-bereik dat is toegewezen aan het Docker-brugnetwerk. Het mag niet overlappen met subnet-IP-bereiken of het IP-bereik dat is gedefinieerd in platformReservedCidr, indien gedefinieerd.
platformReservedCidr	string	IP-bereik in CIDR-notatie die kan worden gereserveerd voor IP-adressen van de omgevingsinfrastructuur. Deze mag niet overlappen met andere IP-adresbereiken van het subnet.
platformReservedDnsIP	string	Een IP-adres uit het IP-bereik dat is gedefinieerd door platformReservedCidr die wordt gereserveerd voor de interne DNS-server

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

Foutreactie van App Service.

Name	Type	Description
error	DefaultErrorResponseError	Foutmodel.

DefaultErrorResponseError

Object

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	DefaultErrorResponseErrorDetailsItem[]	Gedetailleerde fouten.
innererror	string	Meer informatie om fouten op te sporen.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

DefaultErrorResponseErrorDetailsItem

Object

Gedetailleerde fouten.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

ExtendedLocation

Object

Uitgebreide locatie.

Name	Type	Description
name	string	Naam van uitgebreide locatie.
type	string	Type uitgebreide locatie.

FrontEndConfiguration

Object

Name	Type	Description
kind	FrontEndServiceType

FrontEndServiceType

Opsomming

Waarde	Description
NodePort
LoadBalancer

KubeEnvironment

Object

Een Kubernetes-cluster dat is gespecialiseerd in webworkloads door Azure App Service

Name	Type	Description
extendedLocation	ExtendedLocation	Uitgebreide locatie.
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
kind	string	Soort resource.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Clusterconfiguratie waarmee de logdaemon app-logboeken naar een bestemming kan exporteren. Momenteel wordt alleen "log-analytics" ondersteund
properties.arcConfiguration	ArcConfiguration	Clusterconfiguratie die de typen ARC-clustercomponenten bepaalt. Bijvoorbeeld: Kiezen tussen BuildService kind, FrontEnd Service ArtifactsStorageType etc.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Clusterconfiguratie voor Container Apps-omgevingen voor het configureren van de Dapr Instrumentation-sleutel en VNET-configuratie
properties.defaultDomain	string	Standaarddomeinnaam voor het cluster
properties.deploymentErrors	string	Eventuele fouten die zijn opgetreden tijdens de implementatie of validatie van de implementatie
properties.environmentType	string	Type Kubernetes-omgeving. Alleen ondersteund voor container-app-omgevingen met waarde als beheerd
properties.internalLoadBalancerEnabled	boolean	Alleen zichtbaar in Vnet/Subnet
properties.provisioningState	KubeEnvironmentProvisioningState	Provisioningstatus van de Kubernetes-omgeving.
properties.staticIp	string	Statisch IP-adres van kubeEnvironment
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Resourcetags.
type	string	Het type bron. Bijv. "Microsoft.Compute/virtualMachines" of "Microsoft.Storage/storageAccounts"

KubeEnvironmentProvisioningState

Opsomming

Provisioningstatus van de Kubernetes-omgeving.

Waarde	Description
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

LogAnalyticsConfiguration

Object

Name	Type	Description
customerId	string
sharedKey	string (password)

StorageType

Opsomming

Waarde	Description
LocalNode
NetworkFileSystem

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.