Kube Environments - Create Or Update

Service:

App Service

Version d'API:

2025-05-01

Description de Crée ou met à jour un environnement Kubernetes.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom de l’environnement Kubernetes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement géographique où réside la ressource
extendedLocation		ExtendedLocation	Emplacement étendu.
kind		string	Type de ressource.
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	Configuration du cluster, qui permet au démon de journal d’exporter les journaux d’application vers une destination. Actuellement, seul « log-analytics » est pris en charge
properties.arcConfiguration		ArcConfiguration	Configuration du cluster qui détermine les types de composants du cluster ARC. Par exemple : Choisir entre le type BuildService, le service FrontEnd ArtifactsStorageType, etc.
properties.containerAppsConfiguration		ContainerAppsConfiguration	Configuration du cluster pour les environnements Container Apps pour configurer la clé d’instrumentation Dapr et la configuration du réseau virtuel
properties.environmentType		string	Type d’environnement Kubernetes. Uniquement pris en charge pour les environnements d’application conteneur avec la valeur gérée
properties.internalLoadBalancerEnabled		boolean	Visible uniquement dans le réseau virtuel/sous-réseau
properties.staticIp		string	Adresse IP statique du KubeEnvironment
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	KubeEnvironment	Opération de mise à jour de la ressource 'KubeEnvironment' réussie
201 Created	KubeEnvironment	La ressource 'KubeEnvironment' crée l’opération a réussi En-têtes Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create kube environments

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Code d’état:

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

Définitions

Nom	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	Type d’identité qui a créé la ressource.
DefaultErrorResponse	Réponse d’erreur App Service.
DefaultErrorResponseError	Modèle d’erreur.
DefaultErrorResponseErrorDetailsItem	Erreurs détaillées.
ExtendedLocation	Emplacement étendu.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Un cluster Kubernetes spécialisé pour les charges de travail web par Azure App Service
KubeEnvironmentProvisioningState	État de provisionnement de l’environnement Kubernetes.
LogAnalyticsConfiguration
StorageType
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AppLogsConfiguration

Objet

Nom	Type	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Objet

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

ContainerAppsConfiguration

Objet

Nom	Type	Description
appSubnetResourceId	string	ID de ressource d’un sous-réseau pour les composants d’infrastructure du plan de contrôle. Ce sous-réseau doit se trouver dans le même réseau virtuel que le sous-réseau défini dans appSubnetResourceId. Ne doit pas chevaucher la plage IP définie dans platformReservedCidr, si elle est définie.
controlPlaneSubnetResourceId	string	ID de ressource d’un sous-réseau pour les composants d’infrastructure du plan de contrôle. Ce sous-réseau doit se trouver dans le même réseau virtuel que le sous-réseau défini dans appSubnetResourceId. Ne doit pas chevaucher la plage IP définie dans platformReservedCidr, si elle est définie.
daprAIInstrumentationKey	string	Clé d’instrumentation Azure Monitor utilisée par Dapr pour exporter les données de télémétrie de communication du service vers le service
dockerBridgeCidr	string	Plage d’adresses IP de notation CIDR attribuée au réseau de pont Docker. Elle ne doit pas chevaucher les plages d’adresses IP de sous-réseau ou la plage IP définie dans platformReservedCidr, si elle est définie.
platformReservedCidr	string	Plage d’adresses IP en notation CIDR qui peut être réservée pour les adresses IP de l’infrastructure d’environnement. Elle ne doit pas chevaucher d’autres plages d’adresses IP de sous-réseau.
platformReservedDnsIP	string	Une adresse IP de la plage d’adresses IP définie par platformReservedCidr qui sera réservée au serveur DNS interne

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objet

Réponse d’erreur App Service.

Nom	Type	Description
error	DefaultErrorResponseError	Modèle d’erreur.

DefaultErrorResponseError

Objet

Modèle d’erreur.

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
details	DefaultErrorResponseErrorDetailsItem[]	Erreurs détaillées.
innererror	string	Plus d’informations pour déboguer l’erreur.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

DefaultErrorResponseErrorDetailsItem

Objet

Erreurs détaillées.

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

ExtendedLocation

Objet

Emplacement étendu.

Nom	Type	Description
name	string	Nom de l’emplacement étendu.
type	string	Type de lieu étendu.

FrontEndConfiguration

Objet

Nom	Type	Description
kind	FrontEndServiceType

FrontEndServiceType

Énumération

Valeur	Description
NodePort
LoadBalancer

KubeEnvironment

Objet

Un cluster Kubernetes spécialisé pour les charges de travail web par Azure App Service

Nom	Type	Description
extendedLocation	ExtendedLocation	Emplacement étendu.
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
kind	string	Type de ressource.
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Configuration du cluster, qui permet au démon de journal d’exporter les journaux d’application vers une destination. Actuellement, seul « log-analytics » est pris en charge
properties.arcConfiguration	ArcConfiguration	Configuration du cluster qui détermine les types de composants du cluster ARC. Par exemple : Choisir entre le type BuildService, le service FrontEnd ArtifactsStorageType, etc.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Configuration du cluster pour les environnements Container Apps pour configurer la clé d’instrumentation Dapr et la configuration du réseau virtuel
properties.defaultDomain	string	Nom de domaine par défaut pour le cluster
properties.deploymentErrors	string	Toutes les erreurs survenues lors du déploiement ou de la validation du déploiement
properties.environmentType	string	Type d’environnement Kubernetes. Uniquement pris en charge pour les environnements d’application conteneur avec la valeur gérée
properties.internalLoadBalancerEnabled	boolean	Visible uniquement dans le réseau virtuel/sous-réseau
properties.provisioningState	KubeEnvironmentProvisioningState	État de provisionnement de l’environnement Kubernetes.
properties.staticIp	string	Adresse IP statique du KubeEnvironment
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

KubeEnvironmentProvisioningState

Énumération

État de provisionnement de l’environnement Kubernetes.

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

LogAnalyticsConfiguration

Objet

Nom	Type	Description
customerId	string
sharedKey	string (password)

StorageType

Énumération

Valeur	Description
LocalNode
NetworkFileSystem

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.