Kube Environments - Create Or Update

服務:: App Service

API 版本:: 2025-05-01

建立或更新 Kubernetes 環境的說明。

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

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	Kubernetes 環境的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源所在的地理位置
extendedLocation		ExtendedLocation	擴充位置。
kind		string	資源種類。
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	叢集組態，可讓記錄常駐程式將應用程式記錄匯出至目的地。目前僅支援「log-analytics」
properties.arcConfiguration		ArcConfiguration	決定 ARC 叢集元件類型的叢集組態。例如：在 BuildService 種類、前端服務成品 StorageType 等之間進行選擇。
properties.containerAppsConfiguration		ContainerAppsConfiguration	容器應用程式環境的叢集設定，以設定 Dapr 檢測金鑰和 VNET 組態
properties.environmentType		string	Kubernetes Environment 的類型。僅支援容器應用程式環境，其值為受控
properties.internalLoadBalancerEnabled		boolean	只有在 Vnet/子網內才顯示
properties.staticIp		string	KubeEnvironment 的靜態 IP
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	KubeEnvironment	資源「KubeEnvironment」更新操作成功
201 Created	KubeEnvironment	資源「KubeEnvironment」創建作業成功標題 Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	未預期的錯誤回應。

名稱

類型

Description

200 OK

KubeEnvironment

資源「KubeEnvironment」更新操作成功

201 Created

KubeEnvironment

資源「KubeEnvironment」創建作業成功

標題

Location: string
Retry-After: integer

Other Status Codes

DefaultErrorResponse

未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Create kube environments

範例要求

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


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

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

範例回覆

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

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

定義

名稱	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	建立資源的身分識別類型。
DefaultErrorResponse	App Service 錯誤回應。
DefaultErrorResponseError	錯誤模型。
DefaultErrorResponseErrorDetailsItem	詳細的錯誤。
ExtendedLocation	擴充位置。
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Azure App Service 專用於 Web 工作負載的 Kubernetes 叢集
KubeEnvironmentProvisioningState	Kubernetes 環境的佈建狀態。
LogAnalyticsConfiguration
StorageType
systemData	與建立和上次修改資源相關的元數據。

AppLogsConfiguration

Object

名稱	類型	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Object

名稱	類型	Description
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string (password)

ContainerAppsConfiguration

Object

名稱	類型	Description
appSubnetResourceId	string	控制平面基礎結構元件的子網資源標識碼。此子網必須與 appSubnetResourceId 中所定義的子網位於相同的 VNET 中。如果已定義，不得與 platformReservedCidr 中定義的 IP 範圍重疊。
controlPlaneSubnetResourceId	string	控制平面基礎結構元件的子網資源標識碼。此子網必須與 appSubnetResourceId 中所定義的子網位於相同的 VNET 中。如果已定義，不得與 platformReservedCidr 中定義的 IP 範圍重疊。
daprAIInstrumentationKey	string	Dapr 用來將服務匯出至服務通訊遙測的 Azure 監視器檢測密鑰
dockerBridgeCidr	string	指派給 Docker 網橋網路的 CIDR 表示法 IP 範圍。如果已定義，它不得與 platformReservedCidr 中定義的任何子網 IP 範圍或 IP 範圍重疊。
platformReservedCidr	string	CIDR 表示法中的IP範圍，可以保留給環境基礎結構IP位址。它不得與任何其他子網IP範圍重疊。
platformReservedDnsIP	string	由 platformReservedCidr 定義的 IP 位址，將保留給內部 DNS 伺服器

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

App Service 錯誤回應。

名稱	類型	Description
error	DefaultErrorResponseError	錯誤模型。

DefaultErrorResponseError

Object

錯誤模型。

名稱	類型	Description
code	string	標準化字串，以程式設計方式識別錯誤。
details	DefaultErrorResponseErrorDetailsItem[]	詳細的錯誤。
innererror	string	偵錯錯誤的詳細資訊。
message	string	詳細的錯誤描述和偵錯資訊。
target	string	詳細的錯誤描述和偵錯資訊。

DefaultErrorResponseErrorDetailsItem

Object

詳細的錯誤。

名稱	類型	Description
code	string	標準化字串，以程式設計方式識別錯誤。
message	string	詳細的錯誤描述和偵錯資訊。
target	string	詳細的錯誤描述和偵錯資訊。

ExtendedLocation

Object

擴充位置。

名稱	類型	Description
name	string	擴充位置的名稱。
type	string	延伸位置的類型。

FrontEndConfiguration

Object

名稱	類型	Description
kind	FrontEndServiceType

FrontEndServiceType

列舉型別

值	Description
NodePort
LoadBalancer