Kube Environments - Create Or Update

の説明では、Kubernetes 環境を作成または更新します。

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

URI パラメーター

Name In Required Type Description
name
path True
  • string

Kubernetes 環境の名前。

resourceGroupName
path True
  • string

リソースが属しているリソース グループの名前。

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True
  • string

Azure のサブスクリプション ID。 これは GUID 形式の文字列です (例: 00000000-0000-0000-0000-000000000000)。

api-version
query True
  • string

API バージョン

要求本文

Name Required Type Description
location True
  • string

リソースの場所。

extendedLocation

拡張位置。

kind
  • string

リソースの種類。

properties.aksResourceID
  • string
properties.appLogsConfiguration

ログデーモンがアプリケーションログを宛先にエクスポートできるようにするクラスター構成。 現時点では、"ログ分析" のみがサポートされています

properties.arcConfiguration

ARC クラスターコンポーネントの種類を決定するクラスター構成。 例: BuildService の種類、フロントエンドサービスの ArtifactsStorageType などを選択します。

properties.internalLoadBalancerEnabled
  • boolean

Vnet/サブネット内でのみ表示

properties.staticIp
  • string

KubeEnvironment の静的 IP

tags
  • object

リソース タグ。

応答

Name Type Description
200 OK

[OK]

201 Created

作成済み

Other Status Codes

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

Create kube environments

Sample Request

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv?api-version=2021-02-01
{
  "location": "East US",
  "properties": {
    "staticIp": "1.2.3.4"
  }
}

Sample Response

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

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

Details
Error

エラーモデル。

ExtendedLocation

拡張位置。

FrontEndConfiguration
FrontEndServiceType
KubeEnvironment

Azure App Service によって web ワークロード専用に特殊化された Kubernetes クラスター

KubeEnvironmentProvisioningState

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

LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Name Type Description
destination
  • string
logAnalyticsConfiguration

ArcConfiguration

Name Type Description
artifactStorageAccessMode
  • string
artifactStorageClassName
  • string
artifactStorageMountPath
  • string
artifactStorageNodeName
  • string
artifactsStorageType
frontEndServiceConfiguration
kubeConfig
  • string

DefaultErrorResponse

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

Name Type Description
error

エラーモデル。

Details

Name Type Description
code
  • string

プログラムによってエラーを識別するための標準化された文字列。

message
  • string

詳細なエラーの説明とデバッグ情報。

target
  • string

詳細なエラーの説明とデバッグ情報。

Error

エラーモデル。

Name Type Description
code
  • string

プログラムによってエラーを識別するための標準化された文字列。

details

詳細なエラー。

innererror
  • string

デバッグエラーの詳細については、こちらを参照してください。

message
  • string

詳細なエラーの説明とデバッグ情報。

target
  • string

詳細なエラーの説明とデバッグ情報。

ExtendedLocation

拡張位置。

Name Type Description
name
  • string

拡張位置の名前。

type
  • string

拡張位置の種類。

FrontEndConfiguration

Name Type Description
kind

FrontEndServiceType

Name Type Description
LoadBalancer
  • string
NodePort
  • string

KubeEnvironment

Azure App Service によって web ワークロード専用に特殊化された Kubernetes クラスター

Name Type Description
extendedLocation

拡張位置。

id
  • string

リソース Id。

kind
  • string

リソースの種類。

location
  • string

リソースの場所。

name
  • string

リソース名。

properties.aksResourceID
  • string
properties.appLogsConfiguration

ログデーモンがアプリケーションログを宛先にエクスポートできるようにするクラスター構成。 現時点では、"ログ分析" のみがサポートされています

properties.arcConfiguration

ARC クラスターコンポーネントの種類を決定するクラスター構成。 例: BuildService の種類、フロントエンドサービスの ArtifactsStorageType などを選択します。

properties.defaultDomain
  • string

クラスターの既定のドメイン名

properties.deploymentErrors
  • string

配置または配置の検証中に発生したすべてのエラー

properties.internalLoadBalancerEnabled
  • boolean

Vnet/サブネット内でのみ表示

properties.provisioningState

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

properties.staticIp
  • string

KubeEnvironment の静的 IP

tags
  • object

リソース タグ。

type
  • string

リソースの種類。

KubeEnvironmentProvisioningState

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

Name Type Description
Canceled
  • string
Failed
  • string
InfrastructureSetupComplete
  • string
InfrastructureSetupInProgress
  • string
InitializationInProgress
  • string
ScheduledForDelete
  • string
Succeeded
  • string
UpgradeFailed
  • string
UpgradeRequested
  • string
Waiting
  • string

LogAnalyticsConfiguration

Name Type Description
customerId
  • string
sharedKey
  • string

StorageType

Name Type Description
LocalNode
  • string
NetworkFileSystem
  • string