Kube Environments - Create Or Update

Usługa:

App Service

Wersja interfejsu API:

2025-05-01

Opis tworzenia lub aktualizowania środowiska Kubernetes.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa środowiska Kubernetes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
extendedLocation		ExtendedLocation	Lokalizacja rozszerzona.
kind		string	Rodzaj zasobu.
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	Konfiguracja klastra, która umożliwia demonowi dziennika eksportowanie dzienników aplikacji do miejsca docelowego. Obecnie obsługiwana jest tylko usługa "log-analytics"
properties.arcConfiguration		ArcConfiguration	Konfiguracja klastra, która określa typy składników klastra ARC. Np.: Wybór między rodzajem BuildService, FrontEnd Service ArtifactsStorageType itp.
properties.containerAppsConfiguration		ContainerAppsConfiguration	Konfiguracja klastra dla środowisk usługi Container Apps w celu skonfigurowania klucza instrumentacji dapr i konfiguracji sieci wirtualnej
properties.environmentType		string	Typ środowiska Kubernetes. Obsługiwane tylko w przypadku środowisk aplikacji kontenerów z wartością zarządzaną
properties.internalLoadBalancerEnabled		boolean	Widoczne tylko w sieci wirtualnej/podsieci
properties.staticIp		string	Statyczny adres IP platformy KubeEnvironment
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	KubeEnvironment	Aktualizacja zasobu 'KubeEnvironment' zakończyła się sukcesem
201 Created	KubeEnvironment	Operacja utworzenia zasobu 'KubeEnvironment' zakończyła się sukcesem Nagłówki Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create kube environments

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Definicje

Nazwa	Opis
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	Typ tożsamości, która utworzyła zasób.
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
DefaultErrorResponseError	Model błędu.
DefaultErrorResponseErrorDetailsItem	Szczegółowe błędy.
ExtendedLocation	Lokalizacja rozszerzona.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Klaster Kubernetes specjalizujący się w obciążeniach internetowych przez Azure App Service
KubeEnvironmentProvisioningState	Stan aprowizacji środowiska Kubernetes.
LogAnalyticsConfiguration
StorageType
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AppLogsConfiguration

Objekt

Nazwa	Typ	Opis
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Objekt

Nazwa	Typ	Opis
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string (password)

ContainerAppsConfiguration

Objekt

Nazwa	Typ	Opis
appSubnetResourceId	string	Identyfikator zasobu podsieci dla składników infrastruktury płaszczyzny sterowania. Ta podsieć musi znajdować się w tej samej sieci wirtualnej co podsieć zdefiniowana w podsieci appSubnetResourceId. Nie może nakładać się na zakres adresów IP zdefiniowany w parametrze platformReservedCidr, jeśli jest zdefiniowany.
controlPlaneSubnetResourceId	string	Identyfikator zasobu podsieci dla składników infrastruktury płaszczyzny sterowania. Ta podsieć musi znajdować się w tej samej sieci wirtualnej co podsieć zdefiniowana w podsieci appSubnetResourceId. Nie może nakładać się na zakres adresów IP zdefiniowany w parametrze platformReservedCidr, jeśli jest zdefiniowany.
daprAIInstrumentationKey	string	Klucz instrumentacji usługi Azure Monitor używany przez dapr do eksportowania danych telemetrycznych komunikacji usługi do usługi
dockerBridgeCidr	string	Zakres adresów IP notacji CIDR przypisany do sieci mostka platformy Docker. Nie może pokrywać się z żadnymi zakresami adresów IP podsieci ani zakresem adresów IP zdefiniowanymi w polu PlatformReservedCidr, jeśli jest zdefiniowana.
platformReservedCidr	string	Zakres adresów IP w notacji CIDR, który może być zarezerwowany dla adresów IP infrastruktury środowiska. Nie może pokrywać się z żadnymi innymi zakresami adresów IP podsieci.
platformReservedDnsIP	string	Adres IP z zakresu adresów IP zdefiniowany przez platformęReservedCidr, który będzie zarezerwowany dla wewnętrznego serwera DNS

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	DefaultErrorResponseError	Model błędu.

DefaultErrorResponseError

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowej identyfikacji błędu.
details	DefaultErrorResponseErrorDetailsItem[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

DefaultErrorResponseErrorDetailsItem

Objekt

Szczegółowe błędy.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowej identyfikacji błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

ExtendedLocation

Objekt

Lokalizacja rozszerzona.

Nazwa	Typ	Opis
name	string	Nazwa lokalizacji rozszerzonej.
type	string	Rodzaj rozszerzonej lokalizacji.

FrontEndConfiguration

Objekt

Nazwa	Typ	Opis
kind	FrontEndServiceType

FrontEndServiceType

Wyliczenie

Wartość	Opis
NodePort
LoadBalancer

KubeEnvironment

Objekt

Klaster Kubernetes specjalizujący się w obciążeniach internetowych przez Azure App Service

Nazwa	Typ	Opis
extendedLocation	ExtendedLocation	Lokalizacja rozszerzona.
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Rodzaj zasobu.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Konfiguracja klastra, która umożliwia demonowi dziennika eksportowanie dzienników aplikacji do miejsca docelowego. Obecnie obsługiwana jest tylko usługa "log-analytics"
properties.arcConfiguration	ArcConfiguration	Konfiguracja klastra, która określa typy składników klastra ARC. Np.: Wybór między rodzajem BuildService, FrontEnd Service ArtifactsStorageType itp.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Konfiguracja klastra dla środowisk usługi Container Apps w celu skonfigurowania klucza instrumentacji dapr i konfiguracji sieci wirtualnej
properties.defaultDomain	string	Domyślna nazwa domeny dla klastra
properties.deploymentErrors	string	Wszelkie błędy, które wystąpiły podczas wdrażania lub walidacji wdrożenia
properties.environmentType	string	Typ środowiska Kubernetes. Obsługiwane tylko w przypadku środowisk aplikacji kontenerów z wartością zarządzaną
properties.internalLoadBalancerEnabled	boolean	Widoczne tylko w sieci wirtualnej/podsieci
properties.provisioningState	KubeEnvironmentProvisioningState	Stan aprowizacji środowiska Kubernetes.
properties.staticIp	string	Statyczny adres IP platformy KubeEnvironment
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

KubeEnvironmentProvisioningState

Wyliczenie

Stan aprowizacji środowiska Kubernetes.

Wartość	Opis
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

LogAnalyticsConfiguration

Objekt

Nazwa	Typ	Opis
customerId	string
sharedKey	string (password)

StorageType

Wyliczenie

Wartość	Opis
LocalNode
NetworkFileSystem

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.