Kube Environments - Get

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

GET 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 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。

api-version
query True
  • string

API バージョン

応答

Name Type Description
200 OK

[OK]

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 ユーザー アカウントを偽装する

Get kube environments by name

Sample Request

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

Sample Response

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

App Service応答を返します。

Details
Error

エラー モデル。

ExtendedLocation

拡張された場所。

FrontEndConfiguration
FrontEndServiceType
KubeEnvironment

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

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

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

Name Type Description
extendedLocation

拡張された場所。

id
  • string

リソース ID。

kind
  • string

リソースの種類。

location
  • string

リソースの場所。

name
  • string

リソース名。

properties.aksResourceID
  • string
properties.appLogsConfiguration

ログ デーモンがアプリ ログを宛先にエクスポートできるクラスター構成。 現在サポートされているのは "log-analytics" のみです

properties.arcConfiguration

ARC クラスター コンポーネントの種類を決定するクラスター構成。 例: BuildService の種類、FrontEnd Service 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