Kube Environments - Create Or Update

Služba:

App Service

Verze rozhraní API:

2025-05-01

Popis pro Vytvoří nebo aktualizuje prostředí Kubernetes.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název prostředí Kubernetes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Geografické umístění, ve kterém se nachází zdroj
extendedLocation		ExtendedLocation	Rozšířené umístění.
kind		string	Druh prostředku.
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	Konfigurace clusteru, která umožňuje démonovi protokolu exportovat protokoly aplikací do cíle. V současné době je podporována pouze "log-analytics"
properties.arcConfiguration		ArcConfiguration	Konfigurace clusteru, která určuje typy komponent clusteru ARC. Např.: Volba mezi druhem BuildService, ArtifactsStorageType frontEnd služby atd.
properties.containerAppsConfiguration		ContainerAppsConfiguration	Konfigurace clusteru pro prostředí Container Apps pro konfiguraci klíče instrumentace Dapr a konfigurace virtuální sítě
properties.environmentType		string	Typ prostředí Kubernetes Podporuje se jenom pro container App Environment s hodnotou jako spravovanou.
properties.internalLoadBalancerEnabled		boolean	Viditelné pouze v rámci virtuální sítě nebo podsítě
properties.staticIp		string	Statická IP adresa kubeEnvironmentu
tags		object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	KubeEnvironment	Aktualizace zdroje 'KubeEnvironment' byla úspěšná
201 Created	KubeEnvironment	Zdroj 'KubeEnvironment' vytvořil operaci úspěšnou Hlavičky Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Create kube environments

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Definice

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	Typ identity, která prostředek vytvořila.
DefaultErrorResponse	Odpověď na chybu služby App Service
DefaultErrorResponseError	Chybový model
DefaultErrorResponseErrorDetailsItem	Podrobné chyby.
ExtendedLocation	Rozšířené umístění.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Cluster Kubernetes specializovaný na webové úlohy službou Azure App Service
KubeEnvironmentProvisioningState	Stav zřizování prostředí Kubernetes.
LogAnalyticsConfiguration
StorageType
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AppLogsConfiguration

Objekt

Name	Typ	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Objekt

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

ContainerAppsConfiguration

Objekt

Name	Typ	Description
appSubnetResourceId	string	ID prostředku podsítě pro komponenty infrastruktury řídicí roviny Tato podsíť musí být ve stejné virtuální síti jako podsíť definovaná v appSubnetResourceId. Nesmí se překrývat s rozsahem IP definovaným v platformReservedCidr, pokud je definován.
controlPlaneSubnetResourceId	string	ID prostředku podsítě pro komponenty infrastruktury řídicí roviny Tato podsíť musí být ve stejné virtuální síti jako podsíť definovaná v appSubnetResourceId. Nesmí se překrývat s rozsahem IP definovaným v platformReservedCidr, pokud je definován.
daprAIInstrumentationKey	string	Instrumentační klíč služby Azure Monitor používaný nástrojem Dapr k exportu telemetrie komunikace služby do služby
dockerBridgeCidr	string	Rozsah IP adres zápisu CIDR přiřazený k síti mostu Docker. Nesmí se překrývat s žádnými rozsahy IP adres podsítě ani s rozsahem IP definovaným v platformReservedCidr, pokud je definován.
platformReservedCidr	string	Rozsah IP adres v zápisu CIDR, který je možné rezervovat pro IP adresy infrastruktury prostředí. Nesmí se překrývat s žádnými dalšími rozsahy IP adres podsítě.
platformReservedDnsIP	string	IP adresa z rozsahu IP definovaného platformOuReservedCidr, který bude vyhrazen pro interní server DNS

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objekt

Odpověď na chybu služby App Service

Name	Typ	Description
error	DefaultErrorResponseError	Chybový model

DefaultErrorResponseError

Objekt

Chybový model

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby.
details	DefaultErrorResponseErrorDetailsItem[]	Podrobné chyby.
innererror	string	Další informace k chybě ladění.
message	string	Podrobný popis chyby a informace o ladění.
target	string	Podrobný popis chyby a informace o ladění.

DefaultErrorResponseErrorDetailsItem

Objekt

Podrobné chyby.

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby.
message	string	Podrobný popis chyby a informace o ladění.
target	string	Podrobný popis chyby a informace o ladění.

ExtendedLocation

Objekt

Rozšířené umístění.

Name	Typ	Description
name	string	Název rozšířeného umístění
type	string	Typ rozšířené lokality.

FrontEndConfiguration

Objekt

Name	Typ	Description
kind	FrontEndServiceType

FrontEndServiceType

Výčet

Hodnota	Description
NodePort
LoadBalancer

KubeEnvironment

Objekt

Cluster Kubernetes specializovaný na webové úlohy službou Azure App Service

Name	Typ	Description
extendedLocation	ExtendedLocation	Rozšířené umístění.
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Druh prostředku.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Konfigurace clusteru, která umožňuje démonovi protokolu exportovat protokoly aplikací do cíle. V současné době je podporována pouze "log-analytics"
properties.arcConfiguration	ArcConfiguration	Konfigurace clusteru, která určuje typy komponent clusteru ARC. Např.: Volba mezi druhem BuildService, ArtifactsStorageType frontEnd služby atd.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Konfigurace clusteru pro prostředí Container Apps pro konfiguraci klíče instrumentace Dapr a konfigurace virtuální sítě
properties.defaultDomain	string	Výchozí název domény pro cluster
properties.deploymentErrors	string	Jakékoli chyby, ke kterým došlo během nasazení nebo ověření nasazení
properties.environmentType	string	Typ prostředí Kubernetes Podporuje se jenom pro container App Environment s hodnotou jako spravovanou.
properties.internalLoadBalancerEnabled	boolean	Viditelné pouze v rámci virtuální sítě nebo podsítě
properties.provisioningState	KubeEnvironmentProvisioningState	Stav zřizování prostředí Kubernetes.
properties.staticIp	string	Statická IP adresa kubeEnvironmentu
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

KubeEnvironmentProvisioningState

Výčet

Stav zřizování prostředí Kubernetes.

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

LogAnalyticsConfiguration

Objekt

Name	Typ	Description
customerId	string
sharedKey	string (password)

StorageType

Výčet

Hodnota	Description
LocalNode
NetworkFileSystem

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.