Kube Environments - Create Or Update

Servizio:

App Service

Versione API:

2025-05-01

Descrizione per Crea o aggiorna un ambiente Kubernetes.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
name	path	True	string	Nome dell'ambiente Kubernetes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui risiede la risorsa
extendedLocation		ExtendedLocation	Posizione estesa.
kind		string	Tipo di risorsa.
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	Configurazione del cluster che consente al daemon dei log di esportare i log delle app in una destinazione. Attualmente è supportata solo la "log-analytics"
properties.arcConfiguration		ArcConfiguration	Configurazione del cluster che determina i tipi di componenti del cluster ARC. Ad esempio: Scelta tra il tipo BuildService, FrontEnd Service ArtifactsStorageType ecc.
properties.containerAppsConfiguration		ContainerAppsConfiguration	Configurazione del cluster per gli ambienti di app contenitore per configurare la chiave di strumentazione dapr e la configurazione della rete virtuale
properties.environmentType		string	Tipo di ambiente Kubernetes. Supportato solo per gli ambienti dell'app contenitore con valore gestito
properties.internalLoadBalancerEnabled		boolean	Solo visibile all'interno della rete virtuale/subnet
properties.staticIp		string	IP statico di KubeEnvironment
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	KubeEnvironment	Operazione di aggiornamento della risorsa 'KubeEnvironment' riuscita
201 Created	KubeEnvironment	Risorsa 'KubeEnvironment' crea l'operazione è successa Intestazioni Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create kube environments

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	Tipo di identità che ha creato la risorsa.
DefaultErrorResponse	Risposta di errore del servizio app.
DefaultErrorResponseError	Modello di errore.
DefaultErrorResponseErrorDetailsItem	Errori dettagliati.
ExtendedLocation	Posizione estesa.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Un cluster Kubernetes specializzato per i carichi di lavoro Web dal servizio app di Azure
KubeEnvironmentProvisioningState	Stato di provisioning dell'ambiente Kubernetes.
LogAnalyticsConfiguration
StorageType
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

AppLogsConfiguration

Oggetto

Nome	Tipo	Descrizione
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Oggetto

Nome	Tipo	Descrizione
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string (password)

ContainerAppsConfiguration

Oggetto

Nome	Tipo	Descrizione
appSubnetResourceId	string	ID risorsa di una subnet per i componenti dell'infrastruttura del piano di controllo. Questa subnet deve trovarsi nella stessa rete virtuale della subnet definita in appSubnetResourceId. Non deve sovrapporsi all'intervallo IP definito in platformReservedCidr, se definito.
controlPlaneSubnetResourceId	string	ID risorsa di una subnet per i componenti dell'infrastruttura del piano di controllo. Questa subnet deve trovarsi nella stessa rete virtuale della subnet definita in appSubnetResourceId. Non deve sovrapporsi all'intervallo IP definito in platformReservedCidr, se definito.
daprAIInstrumentationKey	string	Chiave di strumentazione di Monitoraggio di Azure usata da Dapr per esportare i dati di telemetria di comunicazione da servizio a servizio
dockerBridgeCidr	string	Intervallo IP di notazione CIDR assegnato alla rete bridge Docker. Non deve sovrapporsi ad alcun intervallo IP subnet o all'intervallo IP definito in platformReservedCidr, se definito.
platformReservedCidr	string	Intervallo IP nella notazione CIDR che può essere riservato per gli indirizzi IP dell'infrastruttura dell'ambiente. Non deve sovrapporsi ad altri intervalli IP subnet.
platformReservedDnsIP	string	Indirizzo IP dall'intervallo IP definito da platformReservedCidr che verrà riservato per il server DNS interno

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Oggetto

Risposta di errore del servizio app.

Nome	Tipo	Descrizione
error	DefaultErrorResponseError	Modello di errore.

DefaultErrorResponseError

Oggetto

Modello di errore.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
details	DefaultErrorResponseErrorDetailsItem[]	Errori dettagliati.
innererror	string	Ulteriori informazioni per eseguire il debug dell'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

DefaultErrorResponseErrorDetailsItem

Oggetto

Errori dettagliati.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

ExtendedLocation

Oggetto

Posizione estesa.

Nome	Tipo	Descrizione
name	string	Nome della posizione estesa.
type	string	Tipo di posizione estesa.

FrontEndConfiguration

Oggetto

Nome	Tipo	Descrizione
kind	FrontEndServiceType

FrontEndServiceType

Enumerazione

Valore	Descrizione
NodePort
LoadBalancer

KubeEnvironment

Oggetto

Un cluster Kubernetes specializzato per i carichi di lavoro Web dal servizio app di Azure

Nome	Tipo	Descrizione
extendedLocation	ExtendedLocation	Posizione estesa.
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo di risorsa.
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Configurazione del cluster che consente al daemon dei log di esportare i log delle app in una destinazione. Attualmente è supportata solo la "log-analytics"
properties.arcConfiguration	ArcConfiguration	Configurazione del cluster che determina i tipi di componenti del cluster ARC. Ad esempio: Scelta tra il tipo BuildService, FrontEnd Service ArtifactsStorageType ecc.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Configurazione del cluster per gli ambienti di app contenitore per configurare la chiave di strumentazione dapr e la configurazione della rete virtuale
properties.defaultDomain	string	Nome di dominio predefinito per il cluster
properties.deploymentErrors	string	Eventuali errori che si sono verificati durante la distribuzione o la convalida della distribuzione
properties.environmentType	string	Tipo di ambiente Kubernetes. Supportato solo per gli ambienti dell'app contenitore con valore gestito
properties.internalLoadBalancerEnabled	boolean	Solo visibile all'interno della rete virtuale/subnet
properties.provisioningState	KubeEnvironmentProvisioningState	Stato di provisioning dell'ambiente Kubernetes.
properties.staticIp	string	IP statico di KubeEnvironment
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

KubeEnvironmentProvisioningState

Enumerazione

Stato di provisioning dell'ambiente Kubernetes.

Valore	Descrizione
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

LogAnalyticsConfiguration

Oggetto

Nome	Tipo	Descrizione
customerId	string
sharedKey	string (password)

StorageType

Enumerazione

Valore	Descrizione
LocalNode
NetworkFileSystem

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.