次の方法で共有


Kube Environments - Get

「Kubernetes Environment のプロパティを取得する」の説明。

GET 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

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

正規表現パターン: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Azure のサブスクリプション ID。 これは GUID 形式の文字列です (たとえば、000000000-0000-0000-0000-000000000000000000000000000000000000000000000000000000000000、

api-version
query True

string

API バージョン

応答

名前 説明
200 OK

KubeEnvironment

OK

Other Status Codes

DefaultErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

Get kube environments by name

要求のサンプル

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1?api-version=2023-12-01

応答のサンプル

{
  "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1",
  "name": "jlaw-demo1",
  "type": "Microsoft.Web/kubeEnvironments",
  "location": "North Central US",
  "extendedLocation": {
    "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "defaultDomain": "jlaw-demo1.k4apps.io",
    "staticIp": "20.42.33.145",
    "arcConfiguration": null,
    "appLogsConfiguration": null,
    "aksResourceID": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ContainerService/managedClusters/jlaw-demo1"
  }
}

定義

名前 説明
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