Kube Environments - Get
Kubernetes 環境のプロパティの取得の説明。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}?api-version=2026-07-15
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
name
|
path | True |
string |
Kubernetes 環境の名前。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前は大文字と小文字を区別しません。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azureの運用は無事に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
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=2026-07-15
応答のサンプル
{
"name": "jlaw-demo1",
"type": "Microsoft.Web/kubeEnvironments",
"extendedLocation": {
"name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
"type": "customLocation"
},
"id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1",
"location": "North Central US",
"properties": {
"aksResourceID": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ContainerService/managedClusters/jlaw-demo1",
"appLogsConfiguration": null,
"arcConfiguration": null,
"defaultDomain": "jlaw-demo1.k4apps.io",
"deploymentErrors": null,
"internalLoadBalancerEnabled": false,
"provisioningState": "Succeeded",
"staticIp": "20.42.33.145"
},
"tags": {}
}
定義
| 名前 | 説明 |
|---|---|
|
App |
|
|
Arc |
|
|
Container |
|
|
created |
リソースを作成した ID の種類。 |
|
Default |
App Service エラー応答。 |
|
Default |
エラー モデル。 |
|
Default |
詳細なエラー。 |
|
Extended |
拡張された場所。 |
|
Front |
|
|
Front |
|
|
Kube |
A Kubernetes cluster specialized for web workload by Azure App Service |
|
Kube |
Kubernetes 環境のプロビジョニング状態。 |
|
Log |
|
|
Storage |
|
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
AppLogsConfiguration
| 名前 | 型 | 説明 |
|---|---|---|
| destination |
string |
|
| logAnalyticsConfiguration |
ArcConfiguration
| 名前 | 型 | 説明 |
|---|---|---|
| artifactStorageAccessMode |
string |
|
| artifactStorageClassName |
string |
|
| artifactStorageMountPath |
string |
|
| artifactStorageNodeName |
string |
|
| artifactsStorageType | ||
| frontEndServiceConfiguration | ||
| kubeConfig |
string (password) |
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 アドレス |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DefaultErrorResponse
App Service エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー モデル。 |
DefaultErrorResponseError
エラー モデル。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
プログラムでエラーを識別するための標準化された文字列。 |
| details |
詳細なエラー。 |
|
| innererror |
string |
エラーのデバッグに関する詳細情報。 |
| message |
string |
詳細なエラーの説明とデバッグ情報。 |
| target |
string |
詳細なエラーの説明とデバッグ情報。 |
DefaultErrorResponseErrorDetailsItem
詳細なエラー。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
プログラムでエラーを識別するための標準化された文字列。 |
| message |
string |
詳細なエラーの説明とデバッグ情報。 |
| target |
string |
詳細なエラーの説明とデバッグ情報。 |
ExtendedLocation
拡張された場所。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
拡張された場所の名前。 |
| type |
string |
拡張ロケーションのタイプ。 |
FrontEndConfiguration
| 名前 | 型 | 説明 |
|---|---|---|
| kind |
FrontEndServiceType
| 値 | 説明 |
|---|---|
| NodePort | |
| LoadBalancer |
KubeEnvironment
A Kubernetes cluster specialized for web workload by Azure App Service
| 名前 | 型 | 説明 |
|---|---|---|
| extendedLocation |
拡張された場所。 |
|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| kind |
string |
リソースの種類。 |
| location |
string |
リソースが存在する地理的な場所 |
| name |
string |
リソースの名前 |
| properties.aksResourceID |
string |
|
| properties.appLogsConfiguration |
ログデーモンがアプリログを宛先にエクスポートできるようにするクラスター構成。 現在、"log-analytics" のみがサポートされています |
|
| properties.arcConfiguration |
ARC クラスター コンポーネント タイプを決定するクラスター構成。 例:BuildServiceの種類、フロントエンドサービスアーティファクトStorageTypeなどから選択します。 |
|
| properties.containerAppsConfiguration |
Dapr インストルメンテーション キーと VNET 構成を構成するための Container Apps 環境のクラスター構成 |
|
| properties.defaultDomain |
string |
クラスタのデフォルトドメイン名 |
| properties.deploymentErrors |
string |
デプロイメントまたはデプロイメントの検証中に発生したエラー |
| properties.environmentType |
string |
Kubernetes 環境の種類。 値がマネージドである Container App Environment でのみサポートされます |
| properties.internalLoadBalancerEnabled |
boolean |
Vnet/Subnet 内でのみ表示される |
| properties.provisioningState |
Kubernetes 環境のプロビジョニング状態。 |
|
| properties.staticIp |
string |
KubeEnvironment の静的 IP |
| systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
| tags |
object |
リソース タグ。 |
| type |
string |
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
KubeEnvironmentProvisioningState
Kubernetes 環境のプロビジョニング状態。
| 値 | 説明 |
|---|---|
| Succeeded | |
| Failed | |
| Canceled | |
| Waiting | |
| InitializationInProgress | |
| InfrastructureSetupInProgress | |
| InfrastructureSetupComplete | |
| ScheduledForDelete | |
| UpgradeRequested | |
| UpgradeFailed |
LogAnalyticsConfiguration
| 名前 | 型 | 説明 |
|---|---|---|
| customerId |
string |
|
| sharedKey |
string (password) |
StorageType
| 値 | 説明 |
|---|---|
| LocalNode | |
| NetworkFileSystem |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |