Kube Environments - Create Or Update

リファレンス

Service:: App Service

API Version:: 2023-12-01

「Kubernetes 環境を作成または更新する」の説明。

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

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	Kubernetes 環境の名前。
resourceGroupName	path	True	string	リソースが属しているリソースグループの名前。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure のサブスクリプション ID。これは GUID 形式の文字列です (たとえば、000000000-0000-0000-0000-000000000000000000000000000000000000000000000000000000000000、
api-version	query	True	string	API バージョン

要求本文

名前	必須	型	説明
location	True	string	リソースの場所。
extendedLocation		ExtendedLocation	拡張された場所。
kind		string	リソースの種類。
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	ログデーモンがアプリログを宛先にエクスポートできるようにするクラスター構成。現在、"log-analytics" のみがサポートされています
properties.arcConfiguration		ArcConfiguration	ARC クラスターコンポーネントの種類を決定するクラスター構成。例: BuildService の種類、FrontEnd Service ArtifactsStorageType などを選択します。
properties.containerAppsConfiguration		ContainerAppsConfiguration	Dapr Instrumentation Key と VNET 構成を構成するための Container Apps 環境のクラスター構成
properties.environmentType		string	Kubernetes 環境の種類。マネージドとしての値を持つコンテナーアプリ環境でのみサポートされます
properties.internalLoadBalancerEnabled		boolean	Vnet/Subnet 内でのみ表示されます
properties.staticIp		string	KubeEnvironment の静的 IP
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	KubeEnvironment	OK
201 Created	KubeEnvironment	作成済み
Other Status Codes	DefaultErrorResponse	エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Create kube environments

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv?api-version=2023-12-01

{
  "location": "East US",
  "properties": {
    "staticIp": "1.2.3.4"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv",
  "name": "testkubeenv",
  "type": "Microsoft.Web/kubeEnvironments",
  "location": "East US",
  "extendedLocation": {
    "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "defaultDomain": "testkubeenv.k4apps.io",
    "staticIp": "1.2.3.4",
    "arcConfiguration": null,
    "appLogsConfiguration": null,
    "aksResourceID": "test"
  }
}

Status code:: 201

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv",
  "name": "testkubeenv",
  "type": "Microsoft.Web/kubeEnvironments",
  "location": "East US",
  "extendedLocation": {
    "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "tags": {},
  "properties": {
    "provisioningState": "InitializationInProgress",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "defaultDomain": "testkubeenv.k4apps.io",
    "staticIp": "1.2.3.4",
    "arcConfiguration": null,
    "appLogsConfiguration": null,
    "aksResourceID": "test"
  }
}

定義

名前	説明
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	エラー応答をApp Serviceします。
Details
Error	エラーモデル。
ExtendedLocation	拡張された場所。
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Azure App Serviceによって Web ワークロードに特化した Kubernetes クラスター
KubeEnvironmentProvisioningState	Kubernetes 環境のプロビジョニング状態。
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

名前	型	説明
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

名前	型	説明
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

名前	型	説明
appSubnetResourceId	string	コントロールプレーンインフラストラクチャコンポーネントのサブネットのリソース ID。このサブネットは、appSubnetResourceId で定義されているサブネットと同じ VNET 内に存在する必要があります。 platformReservedCidr で定義されている IP 範囲 (定義されている場合) と重複しないようにする必要があります。
controlPlaneSubnetResourceId	string	コントロールプレーンインフラストラクチャコンポーネントのサブネットのリソース ID。このサブネットは、appSubnetResourceId で定義されているサブネットと同じ VNET 内に存在する必要があります。 platformReservedCidr で定義されている IP 範囲 (定義されている場合) と重複しないようにする必要があります。
daprAIInstrumentationKey	string	サービスをサービス通信テレメトリにエクスポートするために Dapr によって使用される Azure Monitor インストルメンテーションキー
dockerBridgeCidr	string	Docker ブリッジネットワークに割り当てられた CIDR 表記 IP 範囲。定義されている場合、サブネット IP 範囲または platformReservedCidr で定義されている IP 範囲と重複してはなりません。
platformReservedCidr	string	環境インフラストラクチャの IP アドレス用に予約できる CIDR 表記の IP 範囲。他のサブネット IP 範囲と重複してはなりません。
platformReservedDnsIP	string	内部 DNS サーバー用に予約される platformReservedCidr によって定義された IP 範囲の IP アドレス

DefaultErrorResponse

エラー応答をApp Serviceします。

名前	型	説明
error	Error	エラーモデル。

Details

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	詳細なエラーの説明とデバッグ情報。
target	string	詳細なエラーの説明とデバッグ情報。

Error

エラーモデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	エラーのデバッグに関する詳細情報。
message	string	詳細なエラーの説明とデバッグ情報。
target	string	詳細なエラーの説明とデバッグ情報。

ExtendedLocation

拡張された場所。

名前	型	説明
name	string	拡張場所の名前。
type	string	拡張場所の種類。

FrontEndConfiguration

名前	型	説明
kind	FrontEndServiceType

FrontEndServiceType

名前	型	説明
LoadBalancer	string
NodePort	string

KubeEnvironment

Azure App Serviceによって Web ワークロードに特化した Kubernetes クラスター

名前	型	説明
extendedLocation	ExtendedLocation	拡張された場所。
id	string	リソース ID。
kind	string	リソースの種類。
location	string	リソースの場所。
name	string	リソース名。
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	ログデーモンがアプリログを宛先にエクスポートできるようにするクラスター構成。現在、"log-analytics" のみがサポートされています
properties.arcConfiguration	ArcConfiguration	ARC クラスターコンポーネントの種類を決定するクラスター構成。例: BuildService の種類、FrontEnd Service ArtifactsStorageType などを選択します。
properties.containerAppsConfiguration	ContainerAppsConfiguration	Dapr Instrumentation Key と VNET 構成を構成するための Container Apps 環境のクラスター構成
properties.defaultDomain	string	クラスターの既定のドメイン名
properties.deploymentErrors	string	デプロイまたはデプロイの検証中に発生したエラー
properties.environmentType	string	Kubernetes 環境の種類。マネージドとしての値を持つコンテナーアプリ環境でのみサポートされます
properties.internalLoadBalancerEnabled	boolean	Vnet/Subnet 内でのみ表示されます
properties.provisioningState	KubeEnvironmentProvisioningState	Kubernetes 環境のプロビジョニング状態。
properties.staticIp	string	KubeEnvironment の静的 IP
tags	object	リソースタグ。
type	string	リソースの種類。

KubeEnvironmentProvisioningState

Kubernetes 環境のプロビジョニング状態。

名前	型	説明
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

LogAnalyticsConfiguration

名前	型	説明
customerId	string
sharedKey	string

StorageType

名前	型	説明
LocalNode	string
NetworkFileSystem	string