Managed Clusters - Update Tags

マネージド クラスターでタグをUpdatesします。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}?api-version=2024-02-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

resourceName
path True

string

マネージド クラスター リソースの名前。

Regex pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$

subscriptionId
path True

string

uuid

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

api-version
query True

string

この操作に使用する API バージョン。

要求本文

名前 説明
tags

object

リソース タグ。

応答

名前 説明
200 OK

ManagedCluster

OK

Other Status Codes

CloudError

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

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

Update Managed Cluster Tags

Sample Request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1?api-version=2024-02-01

{
  "tags": {
    "tier": "testing",
    "archv3": ""
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
  "location": "location1",
  "name": "clustername1",
  "tags": {
    "archv3": "",
    "tier": "testing"
  },
  "type": "Microsoft.ContainerService/ManagedClusters",
  "properties": {
    "provisioningState": "Succeeded",
    "kubernetesVersion": "1.9.6",
    "dnsPrefix": "dnsprefix1",
    "agentPoolProfiles": [
      {
        "name": "nodepool1",
        "count": 3,
        "vmSize": "Standard_DS1_v2",
        "maxPods": 110,
        "osType": "Linux",
        "provisioningState": "Succeeded",
        "orchestratorVersion": "1.9.6",
        "currentOrchestratorVersion": "1.9.6"
      }
    ],
    "linuxProfile": {
      "adminUsername": "azureuser",
      "ssh": {
        "publicKeys": [
          {
            "keyData": "keydata"
          }
        ]
      }
    },
    "servicePrincipalProfile": {
      "clientId": "clientid"
    },
    "nodeResourceGroup": "MC_rg1_clustername1_location1",
    "enableRBAC": false,
    "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
    "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
    "networkProfile": {
      "networkPlugin": "kubenet",
      "podCidr": "10.244.0.0/16",
      "serviceCidr": "10.0.0.0/16",
      "dnsServiceIP": "10.0.0.10"
    }
  }
}

定義

名前 説明
AgentPoolMode

エージェント プールのモード。

AgentPoolNetworkProfile

エージェント プールのネットワーク設定。

AgentPoolType

エージェント プールの種類。

AgentPoolUpgradeSettings

エージェント プールをアップグレードするための設定

AgentPoolWindowsProfile

Windows エージェント プールの特定のプロファイル。

AutoScalerProfile

有効になっている場合にクラスター オートスケーラーに適用されるパラメーター

AzureKeyVaultKms

セキュリティ プロファイルの Azure Key Vaultキー管理サービスの設定。

BackendPoolType

BackendPool Load Balancerマネージド受信の型。

CloudError

コンテナー サービスからのエラー応答。

CloudErrorBody

コンテナー サービスからのエラー応答。

ClusterUpgradeSettings

クラスターをアップグレードするための設定。

code

クラスターが実行中か停止かを示します

ContainerServiceLinuxProfile

コンテナー サービス クラスター内の Linux VM のプロファイル。

ContainerServiceNetworkProfile

ネットワーク構成のプロファイル。

ContainerServiceSshConfiguration

Azure で実行されている Linux ベースの VM の SSH 構成。

ContainerServiceSshPublicKey

SSH 証明書の公開キー データに関する情報が含まれています。

createdByType

リソースを作成した ID の種類。

CreationData

ソース リソースからターゲット リソースを作成するときに使用されるデータ。

DelegatedResource

委任されたリソース プロパティ - 内部使用のみ。

expander

スケールアップ時に使用するエキスパンダー

ExtendedLocation

拡張場所の複合型。

ExtendedLocationTypes

拡張場所の型。

GPUInstanceProfile

サポートされている GPU VM SKU の GPU MIG インスタンス プロファイルを指定するために使用する GPUInstanceProfile。

Identity

リソースの ID。

ipFamily

クラスターで使用できる IP バージョンを指定するために使用される IP ファミリ。

IPTag

オブジェクトに関連付けられている IPTag を格納します。

IstioCertificateAuthority

Istio Service Mesh 証明機関 (CA) の構成。 現時点では、こちらの説明に従ってプラグイン証明書のみをサポートしています https://aka.ms/asm-plugin-ca

IstioComponents

Istio コンポーネントの構成。

IstioEgressGateway

Istio エグレス ゲートウェイの構成。

IstioIngressGateway

Istio イングレス ゲートウェイの構成。 ここでは、 という名前の外部イングレス ゲートウェイと という名前aks-istio-ingressgateway-externalaks-istio-ingressgateway-internalの内部イングレス ゲートウェイを最大 1 つサポートしています。

IstioIngressGatewayMode

イングレス ゲートウェイのモード。

IstioPluginCertificateAuthority

Service Mesh のプラグイン証明書情報。

IstioServiceMesh

Istio サービス メッシュの構成。

KeyVaultNetworkAccessTypes

キー コンテナーのネットワーク アクセス

KubeletConfig

エージェント ノードの Kubelet 構成。

KubeletDiskType

emptyDir ボリューム、コンテナー ランタイム データ ルート、Kubelet エフェメラル ストレージの配置を決定します。

KubernetesSupportPlan

AKS マネージド クラスターのさまざまなサポート層

licenseType

Windows VM に使用するライセンスの種類。 詳細については、「 Azure ハイブリッド ユーザー特典 」を参照してください。

LinuxOSConfig

Linux エージェント ノードの OS 構成。

loadBalancerSku

マネージド クラスターのロード バランサー SKU。

ManagedCluster

マネージド クラスター。

ManagedClusterAADProfile

AADProfile は、Azure Active Directory 統合の属性を指定します。

ManagedClusterAddonProfile

マネージド クラスターの Kubernetes アドオン プロファイル。

ManagedClusterAgentPoolProfile

コンテナー サービス エージェント プールのプロファイル。

ManagedClusterAPIServerAccessProfile

マネージド クラスター API サーバーのアクセス プロファイル。

ManagedClusterAutoUpgradeProfile

マネージド クラスターの自動アップグレード プロファイル。

ManagedClusterAzureMonitorProfile

マネージド クラスターを監視するための Azure Monitor アドオン プロファイル。

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure Managed Prometheus アドオンの Kube State Metrics プロファイル。 これらのオプションの設定は、アドオンと共にデプロイされる kube-state-metrics ポッド用です。 詳細については、「aka.ms/AzureManagedPrometheus-optional-parameters」を参照してください。

ManagedClusterAzureMonitorProfileMetrics

Prometheus アドオンの Azure Monitor マネージド サービスのメトリック プロファイル。 すぐに使用できる Kubernetes インフラストラクチャ メトリックを収集して Azure Monitor ワークスペースに送信し、カスタム ターゲットの追加スクレイピングを構成します。 概要については、「aka.ms/AzureManagedPrometheus」を参照してください。

ManagedClusterCostAnalysis

クラスターのコスト分析構成

ManagedClusterHTTPProxyConfig

クラスター HTTP プロキシの構成。

ManagedClusterIdentity

マネージド クラスターの ID。

ManagedClusterIngressProfile

コンテナー サービス クラスターのイングレス プロファイル。

ManagedClusterIngressProfileWebAppRouting

イングレス プロファイルのアプリケーション ルーティング アドオン設定。

ManagedClusterLoadBalancerProfile

マネージド クラスター ロード バランサーのプロファイル。

ManagedClusterManagedOutboundIPProfile

マネージド クラスターのマネージド送信 IP リソースのプロファイル。

ManagedClusterMetricsProfile

ManagedCluster のメトリック プロファイル。

ManagedClusterNATGatewayProfile

マネージド クラスター NAT ゲートウェイのプロファイル。

ManagedClusterOIDCIssuerProfile

マネージド クラスターの OIDC 発行者プロファイル。

ManagedClusterPodIdentity

マネージド クラスターに割り当てられたポッド ID の詳細。

ManagedClusterPodIdentityException

ポッド ID 例外。特定のラベルを持つポッドは、ノード マネージド ID (NMI) サーバーによってインターセプトされることなく、Azure Instance Metadata Service (IMDS) エンドポイントにアクセスできます。

ManagedClusterPodIdentityProfile

マネージド クラスターのポッド ID プロファイル。

ManagedClusterPodIdentityProvisioningError

ポッド ID プロビジョニングからのエラー応答。

ManagedClusterPodIdentityProvisioningErrorBody

ポッド ID プロビジョニングからのエラー応答。

ManagedClusterPodIdentityProvisioningState

ポッド ID の現在のプロビジョニング状態。

ManagedClusterSecurityProfile

コンテナー サービス クラスターのセキュリティ プロファイル。

ManagedClusterSecurityProfileDefender

セキュリティ プロファイルの設定をMicrosoft Defenderします。

ManagedClusterSecurityProfileDefenderSecurityMonitoring

セキュリティ プロファイルの脅威検出の設定をMicrosoft Defenderします。

ManagedClusterSecurityProfileImageCleaner

イメージ クリーナーは、ノードから未使用のイメージを削除し、ディスク領域を解放し、攻撃対象領域を減らすのに役立ちます。 セキュリティ プロファイルの設定を次に示します。

ManagedClusterSecurityProfileWorkloadIdentity

セキュリティ プロファイルのワークロード ID 設定。

ManagedClusterServicePrincipalProfile

Azure API の操作に使用するクラスターのサービス プリンシパル ID に関する情報。

ManagedClusterSKU

マネージド クラスターの SKU。

ManagedClusterSKUName

マネージド クラスター SKU の名前。

ManagedClusterSKUTier

マネージド クラスター SKU の層。

ManagedClusterStorageProfile

コンテナー サービス クラスターのストレージ プロファイル。

ManagedClusterStorageProfileBlobCSIDriver

ストレージ プロファイルの AzureBlob CSI ドライバー設定。

ManagedClusterStorageProfileDiskCSIDriver

ストレージ プロファイルの AzureDisk CSI ドライバー設定。

ManagedClusterStorageProfileFileCSIDriver

ストレージ プロファイルの AzureFile CSI ドライバー設定。

ManagedClusterStorageProfileSnapshotController

ストレージ プロファイルのスナップショット コントローラー設定。

ManagedClusterWindowsProfile

マネージド クラスター内の Windows VM のプロファイル。

ManagedClusterWorkloadAutoScalerProfile

マネージド クラスターのワークロード自動スケーラー プロファイル。

ManagedClusterWorkloadAutoScalerProfileKeda

ワークロード自動スケーラー プロファイルの KEDA (Kubernetes イベント ドリブン自動スケーリング) 設定。

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

ワークロード自動スケーラー プロファイルの VPA (Vertical Pod Autoscaler) 設定。

ManagedOutboundIPs

クラスター ロード バランサーに必要なマネージド送信 IP。

networkDataplane

Kubernetes クラスターで使用されるネットワーク データプレーン。

networkMode

ネットワーク モードの Azure CNI は で構成されています。

NetworkPlugin

Kubernetes ネットワークの構築に使用されるネットワーク プラグイン。

NetworkPluginMode

ネットワーク プラグインで使用する必要があるモード。

NetworkPolicy

Kubernetes ネットワークの構築に使用されるネットワーク ポリシー。

nodeOSUpgradeChannel

ノード OS アップグレード チャネル

OSDiskType

エージェント プール内のマシンに使用する OS ディスクの種類。

OSSKU

エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。 既定値は、Kubernetes <= 1.24 の場合は Windows2019、OSType が Windows の場合は Kubernetes >= 1.25 の場合は Windows2022 です。

OSType

オペレーティング システムの種類。 既定値は Linux です。

OutboundIPPrefixes

クラスター ロード バランサーの必要な送信 IP プレフィックス リソース。

OutboundIPs

クラスター ロード バランサーに必要な送信 IP リソース。

outboundType

送信 (エグレス) ルーティング方法。

PortRange

ポート範囲。

PowerState

クラスターの電源状態について説明します

PrivateLinkResource

プライベート リンク リソース

Protocol

ポートのネットワーク プロトコル。

ProvisioningInfo
PublicNetworkAccess

managedCluster の PublicNetworkAccess

ResourceIdentityType

マネージド クラスターに使用される ID の種類。

ResourceReference

Azure リソースへの参照。

ScaleDownMode

エージェント プールに対して VM を追加または削除する方法について説明します。 課金の状態を参照してください。

ScaleSetEvictionPolicy

仮想マシン スケール セットの削除ポリシー。

ScaleSetPriority

仮想マシン スケール セットの優先度。

ServiceMeshMode

サービス メッシュのモード。

ServiceMeshProfile

マネージド クラスターのサービス メッシュ プロファイル。

SysctlConfig

Linux エージェント ノードの Sysctl 設定。

systemData

リソースの作成と最後の変更に関連するメタデータ。

TagsObject

パッチ操作用のタグ オブジェクト。

upgradeChannel

自動アップグレードのアップグレード チャネル。 既定値は 'none' です。

UpgradeOverrideSettings

クラスターをアップグレードするときのオーバーライドの設定。

UserAssignedIdentities

マネージド クラスターに関連付けられているユーザー ID。 この ID はコントロール プレーンで使用されます。 許可されるユーザー割り当て ID は 1 つだけです。

UserAssignedIdentity

ユーザー割り当て ID の詳細。

WindowsGmsaProfile

マネージド クラスター内の Windows gMSA プロファイル。

WorkloadRuntime

ノードが実行できるワークロードの種類を決定します。

AgentPoolMode

エージェント プールのモード。

名前 説明
System

string

システム エージェント プールは、主に CoreDNS や metrics-server などの重要なシステム ポッドをホストするためのプールです。 システム エージェント プール osType は Linux である必要があります。 システム エージェント プール VM SKU には、少なくとも 2vCPU と 4 GB のメモリが必要です。

User

string

ユーザー エージェント プールは、主にアプリケーション ポッドをホストするためのプールです。

AgentPoolNetworkProfile

エージェント プールのネットワーク設定。

名前 説明
allowedHostPorts

PortRange[]

アクセスが許可されているポート範囲。 指定された範囲は重複することが許可されます。

applicationSecurityGroups

string[]

エージェント プールの作成時に関連付けるアプリケーション セキュリティ グループの ID。

nodePublicIPTags

IPTag[]

インスタンス レベルのパブリック IP の IP タグ。

AgentPoolType

エージェント プールの種類。

名前 説明
AvailabilitySet

string

これを使用することは強くお勧めします。

VirtualMachineScaleSets

string

仮想マシン スケール セットによってサポートされるエージェント プールを作成します。

AgentPoolUpgradeSettings

エージェント プールをアップグレードするための設定

名前 説明
drainTimeoutInMinutes

integer

ノードのドレイン タイムアウト
ポッドの削除とノードごとの正常終了を待機する時間 (分単位)。 この削除待機時間は、ポッド中断予算の待機を優先します。 この時間を超えると、アップグレードは失敗します。 指定しない場合、既定値は 30 分です。

maxSurge

string

アップグレード中に急増したノードの最大数または割合。
これは、整数 (例: '5') またはパーセンテージ ("50%" など) に設定できます。 パーセンテージを指定すると、アップグレード時のエージェント・プール・サイズの合計に対するパーセンテージになります。 パーセンテージの場合、小数ノードは切り上げられます。 指定しない場合は、1 が既定値です。 ベスト プラクティスを含む詳細については、次を参照してください。 https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

nodeSoakDurationInMinutes

integer

ノードのソーク期間
ノードをドレインした後、再イメージ化して次のノードに進む前に待機する時間 (分単位)。 指定しない場合、既定値は 0 分です。

AgentPoolWindowsProfile

Windows エージェント プールの特定のプロファイル。

名前 説明
disableOutboundNat

boolean

Windows ノードで OutboundNAT を無効にするかどうか
既定値は false です。 アウトバウンド NAT を無効にできるのは、クラスターの outboundType が NAT ゲートウェイで、Windows エージェント プールでノード パブリック IP が有効になっていない場合のみです。

AutoScalerProfile

有効になっている場合にクラスター オートスケーラーに適用されるパラメーター

名前 説明
balance-similar-node-groups

string

類似のノード プールを検出し、その間でノード数のバランスを取ります。
有効な値は 'true' と 'false' です

expander

expander

スケールアップ時に使用するエキスパンダー
指定しない場合、既定値は 'random' です。 詳細については、「 エクスパンダー 」を参照してください。

max-empty-bulk-delete

string

同時に削除できる空のノードの最大数。 これは正の整数である必要があります。
既定値は 10 です。

max-graceful-termination-sec

string

ノードのスケールダウンを試みると、クラスター オートスケーラーがポッドの終了を待機する最大秒数。
既定値は 600 です。

max-node-provision-time

string

自動スケーラーがノードのプロビジョニングを待機する最大時間。
既定値は '15m' です。 値は整数の後に 'm' が続く必要があります。 分 (m) 以外の時間の単位はサポートされていません。

max-total-unready-percentage

string

クラスター内の未読ノードの最大割合。 この割合を超えると、クラスター オートスケーラーは操作を停止します。
既定値は 45 です。 最大値は 100、最小値は 0 です。

new-pod-scale-up-delay

string

特定の期間になる前に、スケジュールされていないポッドを無視します。
バーストまたはバッチ スケールのように、Kubernetes スケジューラによってすべてのポッドがスケジュールされる前に CA を動作させたくないシナリオの場合、一定の期間に達する前のスケジュールされていないポッドを無視するように CA に指示できます。 既定値は '0s' です。 値は整数の後に単位 (秒の場合は 's'、分の場合は 'm'、時間の場合は 'h') である必要があります。

ok-total-unready-count

string

max-total-unready-percentage に関係なく、許容される未読ノードの数。
これは整数である必要があります。 既定値は 3 です。

scale-down-delay-after-add

string

スケールアップ後に、スケールダウンの評価が再開されるまでの時間
既定値は '10m' です。 値は整数の後に 'm' が続く必要があります。 分 (m) 以外の時間の単位はサポートされていません。

scale-down-delay-after-delete

string

ノードの削除後に、スケールダウンの評価が再開されるまでの時間。
既定値はスキャン間隔です。 値は整数の後に 'm' が続く必要があります。 分 (m) 以外の時間の単位はサポートされていません。

scale-down-delay-after-failure

string

スケールダウンの失敗後に、スケールダウンの評価が再開されるまでの時間。
既定値は '3m' です。 値は整数の後に 'm' が続く必要があります。 分 (m) 以外の時間の単位はサポートされていません。

scale-down-unneeded-time

string

スケール ダウンの対象になるまでのノードの不要な期間。
既定値は '10m' です。 値は整数の後に 'm' が続く必要があります。 分 (m) 以外の時間の単位はサポートされていません。

scale-down-unready-time

string

準備ができていないノードが不要になってからスケールダウンの対象になるまでの時間
既定値は '20m' です。 値は整数の後に 'm' が続く必要があります。 分 (m) 以外の時間の単位はサポートされていません。

scale-down-utilization-threshold

string

要求されたリソースの合計を容量で割った値として定義される、ノード利用レベル。これを下回るノードはスケールダウンの対象と見なすことができます。
既定値は '0.5' です。

scan-interval

string

スケールアップまたはスケールダウンに関してクラスターが再評価される頻度。
既定値は '10' です。 値は、秒数の整数である必要があります。

skip-nodes-with-local-storage

string

クラスター オートスケーラーがローカル ストレージを持つポッド (EmptyDir や HostPath など) を含むノードの削除をスキップする場合。
既定値は true です。

skip-nodes-with-system-pods

string

クラスター オートスケーラーが kube-system からのポッドを含むノードの削除をスキップする場合 (DaemonSet またはミラー ポッドを除く)
既定値は true です。

AzureKeyVaultKms

セキュリティ プロファイルの Azure Key Vaultキー管理サービスの設定。

名前 既定値 説明
enabled

boolean

Azure Key Vault キー管理サービスを有効にするかどうか。 既定値は false です。

keyId

string

Azure Key Vault キーの識別子。 詳細については、「 キー識別子の形式 」を参照してください。 Azure Key Vault キー管理サービスが有効になっている場合、このフィールドは必須であり、有効なキー識別子である必要があります。 Azure Key Vault キー管理サービスが無効になっている場合は、フィールドを空のままにします。

keyVaultNetworkAccess

KeyVaultNetworkAccessTypes

Public

キー コンテナーのネットワーク アクセス
キー コンテナーのネットワーク アクセス。 設定可能な値は、Public および Private です。 Public は、キー コンテナーですべてのネットワークからのパブリック アクセスを許可することを意味します。 Private は、キー コンテナーがパブリック アクセスを無効にし、プライベート リンクを有効にすることを意味します。 既定値は Public です。

keyVaultResourceId

string

キー コンテナーのリソース ID。 keyVaultNetworkAccess が の場合、 Privateこのフィールドは必須であり、有効なリソース ID である必要があります。 keyVaultNetworkAccess が の場合、 Publicフィールドは空のままにします。

BackendPoolType

BackendPool Load Balancerマネージド受信の型。

名前 説明
NodeIP

string

BackendPool Load Balancerマネージド受信の型。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend.

NodeIPConfiguration

string

BackendPool Load Balancerマネージド受信の型。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend.

CloudError

コンテナー サービスからのエラー応答。

名前 説明
error

CloudErrorBody

エラーの詳細。

CloudErrorBody

コンテナー サービスからのエラー応答。

名前 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

details

CloudErrorBody[]

エラーに関するその他の詳細の一覧。

message

string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

target

string

特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

ClusterUpgradeSettings

クラスターをアップグレードするための設定。

名前 説明
overrideSettings

UpgradeOverrideSettings

オーバーライドの設定。

code

クラスターが実行中か停止かを示します

名前 説明
Running

string

クラスターが実行されています。

Stopped

string

クラスターが停止しています。

ContainerServiceLinuxProfile

コンテナー サービス クラスター内の Linux VM のプロファイル。

名前 説明
adminUsername

string

Linux VM に使用する管理者ユーザー名。

ssh

ContainerServiceSshConfiguration

Azure で実行されている Linux ベースの VM の SSH 構成。

ContainerServiceNetworkProfile

ネットワーク構成のプロファイル。

名前 既定値 説明
dnsServiceIP

string

10.0.0.10

Kubernetes DNS サービスに割り当てられた IP アドレス。 これは、serviceCidr で指定された Kubernetes サービス アドレス範囲内である必要があります。

ipFamilies

ipFamily[]

クラスターで使用できる IP バージョンを指定するために使用される IP ファミリ。
IP ファミリは、単一スタッククラスターまたはデュアルスタック クラスターを決定するために使用されます。 単一スタックの場合、期待される値は IPv4 です。 デュアルスタックの場合、期待される値は IPv4 と IPv6 です。

loadBalancerProfile

ManagedClusterLoadBalancerProfile

クラスター ロード バランサーのプロファイル。

loadBalancerSku

loadBalancerSku

マネージド クラスターのロード バランサー SKU。
既定値は 'standard' です。 ロード バランサー SKU の違いの詳細については、「Azure Load Balancer SKU」を参照してください。

natGatewayProfile

ManagedClusterNATGatewayProfile

クラスター NAT ゲートウェイのプロファイル。

networkDataplane

networkDataplane

Kubernetes クラスターで使用されるネットワーク データプレーン。

networkMode

networkMode

ネットワーク モードの Azure CNI は で構成されています。
networkPlugin が 'azure' 以外の場合、これは指定できません。

networkPlugin

NetworkPlugin

kubenet

Kubernetes ネットワークの構築に使用されるネットワーク プラグイン。

networkPluginMode

NetworkPluginMode

ネットワーク プラグインで使用する必要があるモード。

networkPolicy

NetworkPolicy

Kubernetes ネットワークの構築に使用されるネットワーク ポリシー。

outboundType

outboundType

loadBalancer

送信 (エグレス) ルーティング方法。
これはクラスター作成時にのみ設定でき、後で変更することはできません。 詳細については、「 エグレス送信の種類」を参照してください。

podCidr

string

10.244.0.0/16

Kubenet を使用している場合、ポッド IP を割り当てる CIDR 表記の IP 範囲。

podCidrs

string[]

ポッド IP の割り当て元となる CIDR 表記 IP 範囲。
単一スタック ネットワークでは、1 つの IPv4 CIDR が必要です。 デュアルスタック ネットワークには、2 つの CIDR (IP ファミリごとに 1 つ (IPv4/IPv6) が必要です。

serviceCidr

string

10.0.0.0/16

Kubenet を使用している場合、サービス クラスター IP を割り当てる CIDR 表記の IP 範囲。 どのサブネット IP アドレスとも重複していてはなりません。

serviceCidrs

string[]

サービス クラスター IP の割り当て元となる CIDR 表記 IP 範囲。
単一スタック ネットワークでは、1 つの IPv4 CIDR が必要です。 デュアルスタック ネットワークには、2 つの CIDR (IP ファミリごとに 1 つ (IPv4/IPv6) が必要です。 サブネット IP 範囲と重複しないようにする必要があります。

ContainerServiceSshConfiguration

Azure で実行されている Linux ベースの VM の SSH 構成。

名前 説明
publicKeys

ContainerServiceSshPublicKey[]

Linux ベースの VM で認証するために使用される SSH 公開キーの一覧。 最大 1 つのキーを指定できます。

ContainerServiceSshPublicKey

SSH 証明書の公開キー データに関する情報が含まれています。

名前 説明
keyData

string

SSH 経由で VM で認証するために使用される証明書公開キー。 証明書は、ヘッダーの有無にかかわらず PEM 形式である必要があります。

createdByType

リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

CreationData

ソース リソースからターゲット リソースを作成するときに使用されるデータ。

名前 説明
sourceResourceId

string

これは、ターゲット オブジェクトの作成に使用するソース オブジェクトの ARM ID です。

DelegatedResource

委任されたリソース プロパティ - 内部使用のみ。

名前 説明
location

string

ソース リソースの場所 - 内部使用のみ。

referralResource

string

紹介委任の委任 ID (省略可能) - 内部使用のみ。

resourceId

string

委任されたリソースの ARM リソース ID - 内部使用のみ。

tenantId

string

委任されたリソースのテナント ID - 内部使用のみ。

expander

スケールアップ時に使用するエキスパンダー

名前 説明
least-waste

string

スケールアップ後にアイドル状態の CPU が最も少ない (関連付けられている場合は未使用のメモリ) ノード グループを選択します。 これは、CPU 使用率の高いノードやメモリの高いノードなど、さまざまなクラスのノードがあり、それらのリソースの多くを必要とする保留中のポッドがある場合にのみノードを拡張する場合に便利です。

most-pods

string

スケールアップ時に最も多くのポッドをスケジュールできるノード グループを選択します。 これは、nodeSelector を使用して特定のポッドが特定のノードに到達することを確認する場合に便利です。 これにより、自動スケーラーは一度に複数の小さなノードを追加できるため、より大きなノードと小さいノードを選択することはありません。

priority

string

ユーザーによって割り当てられた優先度が最も高いノード グループを選択します。 構成の詳細については、 こちらを参照してください

random

string

ノード グループを異なる方法でスケーリングする必要がない場合に使用されます。

ExtendedLocation

拡張場所の複合型。

名前 説明
name

string

拡張場所の名前。

type

ExtendedLocationTypes

拡張場所の型。

ExtendedLocationTypes

拡張場所の型。

名前 説明
EdgeZone

string

GPUInstanceProfile

サポートされている GPU VM SKU の GPU MIG インスタンス プロファイルを指定するために使用する GPUInstanceProfile。

名前 説明
MIG1g

string

MIG2g

string

MIG3g

string

MIG4g

string

MIG7g

string

Identity

リソースの ID。

名前 説明
principalId

string

リソース ID のプリンシパル ID。 値は UUID である必要があります。

tenantId

string

リソースのテナント ID。 値は UUID である必要があります。

type

ResourceIdentityType

ID の種類。

ipFamily

クラスターで使用できる IP バージョンを指定するために使用される IP ファミリ。

名前 説明
IPv4

string

IPv6

string

IPTag

オブジェクトに関連付けられている IPTag を格納します。

名前 説明
ipTagType

string

IP タグの種類。 例: RoutingPreference。

tag

string

パブリック IP に関連付けられている IP タグの値。 例: インターネット。

IstioCertificateAuthority

Istio Service Mesh 証明機関 (CA) の構成。 現時点では、こちらの説明に従ってプラグイン証明書のみをサポートしています https://aka.ms/asm-plugin-ca

名前 説明
plugin

IstioPluginCertificateAuthority

Service Mesh のプラグイン証明書情報。

IstioComponents

Istio コンポーネントの構成。

名前 説明
egressGateways

IstioEgressGateway[]

Istio エグレス ゲートウェイ。

ingressGateways

IstioIngressGateway[]

Istio イングレス ゲートウェイ。

IstioEgressGateway

Istio エグレス ゲートウェイの構成。

名前 説明
enabled

boolean

エグレス ゲートウェイを有効にするかどうか。

IstioIngressGateway

Istio イングレス ゲートウェイの構成。 ここでは、 という名前の外部イングレス ゲートウェイと という名前aks-istio-ingressgateway-externalaks-istio-ingressgateway-internalの内部イングレス ゲートウェイを最大 1 つサポートしています。

名前 説明
enabled

boolean

イングレス ゲートウェイを有効にするかどうか。

mode

IstioIngressGatewayMode

イングレス ゲートウェイのモード。

IstioIngressGatewayMode

イングレス ゲートウェイのモード。

名前 説明
External

string

イングレス ゲートウェイにはパブリック IP アドレスが割り当てられ、パブリックにアクセスできます。

Internal

string

イングレス ゲートウェイには内部 IP アドレスが割り当てられ、パブリックにアクセスすることはできません。

IstioPluginCertificateAuthority

Service Mesh のプラグイン証明書情報。

名前 説明
certChainObjectName

string

Azure Key Vaultの証明書チェーン オブジェクト名。

certObjectName

string

Azure Key Vaultの中間証明書オブジェクト名。

keyObjectName

string

Azure Key Vaultの中間証明書秘密キー オブジェクト名。

keyVaultId

string

Key Vaultのリソース ID。

rootCertObjectName

string

Azure Key Vaultのルート証明書オブジェクト名。

IstioServiceMesh

Istio サービス メッシュの構成。

名前 説明
certificateAuthority

IstioCertificateAuthority

Istio Service Mesh Certificate Authority (CA) の構成。 現時点では、ここで説明するようにプラグイン証明書のみをサポートしています https://aka.ms/asm-plugin-ca

components

IstioComponents

Istio コンポーネントの構成。

revisions

string[]

Istio コントロール プレーンのリビジョンの一覧。 アップグレードが進行中でない場合、これは 1 つの値を保持します。 カナリア アップグレードが進行中の場合、これは連続する 2 つの値のみを保持できます。 詳細については、「https://learn.microsoft.com/en-us/azure/aks/istio-upgrade」を参照してください。

KeyVaultNetworkAccessTypes

キー コンテナーのネットワーク アクセス

名前 説明
Private

string

Public

string

KubeletConfig

エージェント ノードの Kubelet 構成。

名前 説明
allowedUnsafeSysctls

string[]

安全でない sysctl または安全でない sysctl パターンの許可された一覧 (で *終わる)。

containerLogMaxFiles

integer

コンテナーに表示できるコンテナー ログ ファイルの最大数。 数値は 2 ≥する必要があります。

containerLogMaxSizeMB

integer

コンテナー ログ ファイルがローテーションされる前の最大サイズ (10Mi など)。

cpuCfsQuota

boolean

CPU 制限を指定するコンテナーに対して CPU CFS クォータの適用が有効になっている場合。
既定値は true です。

cpuCfsQuotaPeriod

string

CPU CFS クォータ期間の値。
既定値は '100ms' です。 有効な値は、省略可能な分数と単位サフィックスを持つ 10 進数のシーケンスです。 たとえば、'300ms'、'2h45m' などです。 サポートされているユニットは、'ns'、'us'、'ms'、's'、'm'、および 'h' です。

cpuManagerPolicy

string

使用する CPU マネージャー ポリシー。
既定値は 'none' です。 詳細については、「 Kubernetes CPU 管理ポリシー 」を参照してください。 使用できる値は、'none' と 'static' です。

failSwapOn

boolean

true に設定すると、ノードでスワップが有効になっている場合、Kubelet の起動に失敗します。

imageGcHighThreshold

integer

イメージ ガベージ コレクションが常に実行されるようになる、ディスク使用量の割合。
イメージ ガベージ コレクションを無効にするには、100 に設定します。 既定値は 85% です

imageGcLowThreshold

integer

イメージ ガベージ コレクションを実行できるようになる、ディスク使用量の割合。
これは imageGcHighThreshold より高く設定できません。 既定値は 80% です

podMaxPids

integer

ポッドあたりのプロセスの最大数。

topologyManagerPolicy

string

使用するトポロジ マネージャー ポリシー。
詳細については、「 Kubernetes Topology Manager」を参照してください。 既定値は 'none' です。 使用できる値は、'none'、'best-effort'、'restricted'、および 'single-numa-node' です。

KubeletDiskType

emptyDir ボリューム、コンテナー ランタイム データ ルート、Kubelet エフェメラル ストレージの配置を決定します。

名前 説明
OS

string

Kubelet は、データに OS ディスクを使用します。

Temporary

string

Kubelet は、そのデータに一時ディスクを使用します。

KubernetesSupportPlan

AKS マネージド クラスターのさまざまなサポート層

名前 説明
AKSLongTermSupport

string

バージョンのサポートは、1 年間の KubernetesOfficial サポートを超えて拡張されました。 AKS は、さらに 1 年間、合計 2 年間のサポートのために CVE にパッチを適用し続けます。

KubernetesOfficial

string

バージョンのサポートは、オープンソース Kubernetes オファリングの場合と同じです。 公式 Kubernetes オープンソース コミュニティ サポート バージョンは、リリース後 1 年間です。

licenseType

Windows VM に使用するライセンスの種類。 詳細については、「 Azure ハイブリッド ユーザー特典 」を参照してください。

名前 説明
None

string

追加のライセンスは適用されません。

Windows_Server

string

Windows VM の Azure ハイブリッド ユーザー特典を有効にします。

LinuxOSConfig

Linux エージェント ノードの OS 構成。

名前 説明
swapFileSizeMB

integer

各ノードに作成されるスワップ ファイルのサイズ (MB)。

sysctls

SysctlConfig

Linux エージェント ノードの Sysctl 設定。

transparentHugePageDefrag

string

カーネルがメモリ圧縮を積極的に使用して、より多くの巨大なページを使用できるようにする必要があるかどうか。
有効な値は、'always'、'defer'、'defer+madvise'、'madvise'、'never' です。 既定値は 'madvise' です。 詳細については、「 Transparent Hugepages」を参照してください。

transparentHugePageEnabled

string

透過的な巨大ページが有効になっているかどうか。
有効な値は、'always'、'madvise'、および 'never' です。 既定値は 'always' です。 詳細については、「 Transparent Hugepages」を参照してください。

loadBalancerSku

マネージド クラスターのロード バランサー SKU。

名前 説明
basic

string

機能が制限された基本的なLoad Balancerを使用します。

standard

string

標準のLoad Balancerを使用します。 これは推奨されるLoad Balancer SKU です。 マネージド クラスターでのロード バランサーの操作の詳細については、標準のLoad Balancerに関する記事を参照してください。

ManagedCluster

マネージド クラスター。

名前 説明
extendedLocation

ExtendedLocation

仮想マシンの拡張された場所。

id

string

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedClusterIdentity

マネージド クラスターの ID (構成されている場合)。

location

string

リソースが保存されている地理的な場所

name

string

リソースの名前

properties.aadProfile

ManagedClusterAADProfile

AADProfile は、Azure Active Directory 統合の属性を指定します。
Azure Active Directory の構成。

properties.addonProfiles

<string,  ManagedClusterAddonProfile>

マネージド クラスター アドオンのプロファイル。

properties.agentPoolProfiles

ManagedClusterAgentPoolProfile[]

エージェント プールのプロパティ。

properties.apiServerAccessProfile

ManagedClusterAPIServerAccessProfile

マネージド クラスター API サーバーのアクセス プロファイル。

properties.autoScalerProfile

AutoScalerProfile

有効にした場合にクラスター オートスケーラーに適用されるパラメーター

properties.autoUpgradeProfile

ManagedClusterAutoUpgradeProfile

自動アップグレード構成。

properties.azureMonitorProfile

ManagedClusterAzureMonitorProfile

マネージド クラスターを監視するための Azure Monitor アドオン プロファイル。

properties.azurePortalFQDN

string

マネージド クラスターにアクセスするために Azure Portal によって使用される特別な FQDN。 この FQDN は Azure Portal でのみ使用されるため、他のクライアントでは使用しないでください。
Azure Portal では、一部の応答で特定のクロスオリジン リソース共有 (CORS) ヘッダーを送信する必要があります。このヘッダーは、Kubernetes APIServer では既定では処理されません。 この特別な FQDN では CORS がサポートされており、Azure Portal が正しく機能します。

properties.currentKubernetesVersion

string

マネージド クラスターが実行されている Kubernetes のバージョン。
kubernetesVersion が完全に指定されたバージョン <の major.minor.patch> の場合、このフィールドは完全に同じになります。 kubernetesVersion が major.minor> の<場合、このフィールドには、使用されている完全な <major.minor.patch> バージョンが含まれます。

properties.disableLocalAccounts

boolean

マネージド クラスターでローカル アカウントを無効にする必要がある場合。
true に設定すると、このクラスターで静的資格情報の取得は無効になります。 これは、AAD が有効になっているマネージド クラスターでのみ使用する必要があります。 詳細については、「 ローカル アカウントを無効にする」を参照してください。

properties.diskEncryptionSetID

string

保存時の暗号化を有効にするために使用するディスク暗号化セットのリソース ID。
これは次の形式です: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'

properties.dnsPrefix

string

マネージド クラスターの DNS プレフィックス。
これは、マネージド クラスターが作成された後は更新できません。

properties.enablePodSecurityPolicy

boolean

(非推奨)Kubernetes ポッド セキュリティ ポリシー (プレビュー) を有効にするかどうか。 PodSecurityPolicy は Kubernetes v1.21 で非推奨となり、v1.25 の Kubernetes から削除されました。 詳細情報: https://aka.ms/k8s/psp および https://aka.ms/aks/psp

properties.enableRBAC

boolean

Kubernetes Role-Based Access Control を有効にするかどうか。

properties.fqdn

string

マスター プールの FQDN。

properties.fqdnSubdomain

string

カスタム プライベート DNS ゾーンを持つプライベート クラスターの FQDN サブドメイン。
これは、マネージド クラスターが作成された後は更新できません。

properties.httpProxyConfig

ManagedClusterHTTPProxyConfig

HTTP プロキシ サーバーを使用してクラスターをプロビジョニングするための構成。

properties.identityProfile

<string,  UserAssignedIdentity>

クラスターに関連付けられている ID。

properties.ingressProfile

ManagedClusterIngressProfile

マネージド クラスターのイングレス プロファイル。

properties.kubernetesVersion

string

ユーザーによって指定された Kubernetes のバージョン。
パッチ バージョン <major.minor.patch> (例: 1.20.13) と <major.minor> (例: 1.20) の両方がサポートされています。 major.minor> を指定すると<、サポートされている最新の GA パッチ バージョンが自動的に選択されます。 クラスターの作成後に同じ <major.minor> を使用してクラスターを更新しても (例: 1.14.x -> 1.14)、新しいパッチ バージョンが使用可能な場合でも、アップグレードはトリガーされません。 サポートされている AKS クラスターをアップグレードする際に、Kubernetes マイナー バージョンをスキップすることはできません。 すべてのアップグレードは、メジャー バージョン番号で順番に実行する必要があります。 たとえば、1.14.x -> 1.15.x または 1.15.x -> 1.16.x の間のアップグレードは許可されますが、1.14.x -> 1.16.x は許可されません。 詳細については、「 AKS クラスターのアップグレード 」を参照してください。

properties.linuxProfile

ContainerServiceLinuxProfile

マネージド クラスター内の Linux VM のプロファイル。

properties.maxAgentPools

integer

マネージド クラスターのエージェント プールの最大数。

properties.metricsProfile

ManagedClusterMetricsProfile

オプションのクラスター メトリック構成。

properties.networkProfile

ContainerServiceNetworkProfile

ネットワーク構成プロファイル。

properties.nodeResourceGroup

string

エージェント プール ノードを含むリソース グループの名前。

properties.oidcIssuerProfile

ManagedClusterOIDCIssuerProfile

マネージド クラスターの OIDC 発行者プロファイル。

properties.podIdentityProfile

ManagedClusterPodIdentityProfile

マネージド クラスターのポッド ID プロファイル。
AAD ポッド ID の統合の詳細については、「AAD ポッド ID の使用」を参照してください。

properties.powerState

PowerState

クラスターの電源状態。

properties.privateFQDN

string

プライベート クラスターの FQDN。

properties.privateLinkResources

PrivateLinkResource[]

クラスターに関連付けられているプライベート リンク リソース。

properties.provisioningState

string

現在のプロビジョニング状態。

properties.publicNetworkAccess

PublicNetworkAccess

managedCluster の PublicNetworkAccess
AKS のパブリック ネットワーク アクセスを許可または拒否する

properties.resourceUID

string

resourceUID は、ARM ResourceId を再利用する ManagedCluster を一意に識別します (つまり、シーケンスの作成、削除、作成)

properties.securityProfile

ManagedClusterSecurityProfile

マネージド クラスターのセキュリティ プロファイル。

properties.serviceMeshProfile

ServiceMeshProfile

マネージド クラスターのサービス メッシュ プロファイル。

properties.servicePrincipalProfile

ManagedClusterServicePrincipalProfile

Azure API の操作に使用するクラスターのサービス プリンシパル ID に関する情報。

properties.storageProfile

ManagedClusterStorageProfile

マネージド クラスターのストレージ プロファイル。

properties.supportPlan

KubernetesSupportPlan

マネージド クラスターのサポート プラン。 指定しない場合、既定値は 'KubernetesOfficial' です。

properties.upgradeSettings

ClusterUpgradeSettings

クラスターをアップグレードするための設定。

properties.windowsProfile

ManagedClusterWindowsProfile

マネージド クラスター内の Windows VM のプロファイル。

properties.workloadAutoScalerProfile

ManagedClusterWorkloadAutoScalerProfile

マネージド クラスターのワークロード自動スケーラー プロファイル。

sku

ManagedClusterSKU

マネージド クラスター SKU。

systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。

tags

object

リソース タグ。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ManagedClusterAADProfile

AADProfile は、Azure Active Directory 統合の属性を指定します。

名前 説明
adminGroupObjectIDs

string[]

クラスターの管理者ロールを持つ AAD グループ オブジェクト ID の一覧。

clientAppID

string

(非推奨)クライアント AAD アプリケーション ID。 詳細については、https://aka.ms/aks/aad-legacy をご覧ください。

enableAzureRBAC

boolean

Kubernetes 承認に対して Azure RBAC を有効にするかどうか。

managed

boolean

マネージド AAD を有効にするかどうか。

serverAppID

string

(非推奨)サーバー AAD アプリケーション ID。 詳細については、https://aka.ms/aks/aad-legacy をご覧ください。

serverAppSecret

string

(非推奨)サーバー AAD アプリケーション シークレット。 詳細については、https://aka.ms/aks/aad-legacy をご覧ください。

tenantID

string

認証に使用する AAD テナント ID。 指定しない場合、 はデプロイ サブスクリプションのテナントを使用します。

ManagedClusterAddonProfile

マネージド クラスターの Kubernetes アドオン プロファイル。

名前 説明
config

object

アドオンを構成するためのキーと値のペア。

enabled

boolean

アドオンが有効かどうか。

identity

Identity

このアドオンで使用されるユーザー割り当て ID の情報。

ManagedClusterAgentPoolProfile

コンテナー サービス エージェント プールのプロファイル。

名前 既定値 説明
availabilityZones

string[]

ノードに使用する可用性ゾーンの一覧。 これは、AgentPoolType プロパティが 'VirtualMachineScaleSets' の場合にのみ指定できます。

capacityReservationGroupID

string

Virtual Machinesの予約グループから仮想マシンを提供する容量予約グループの完全修飾リソース ID。
AKS は、指定されたエージェント プールを容量予約グループに関連付けます。

count

integer

Docker コンテナーをホストするエージェント (VM) の数。 使用できる値は、ユーザー プールの場合は 0 から 1000 (含む) の範囲、システム プールの場合は 1 から 1000 (含む) の範囲である必要があります。 既定値は 1 です。

creationData

CreationData

スナップショットを使用してノード プールを作成またはアップグレードする場合に、ソース スナップショット ID を指定するために使用する CreationData。

currentOrchestratorVersion

string

エージェント プールが実行されている Kubernetes のバージョン。
orchestratorVersion が完全に指定されたバージョン <の major.minor.patch> の場合、このフィールドは完全に同じになります。 orchestratorVersion が major.minor> の<場合、このフィールドには、使用されている完全な <major.minor.patch> バージョンが含まれます。

enableAutoScaling

boolean

自動スケーラーを有効にするかどうか

enableEncryptionAtHost

boolean

ホスト ベースの OS とデータ ドライブの暗号化を有効にするかどうか。
これは、特定の VM サイズと特定の Azure リージョンでのみサポートされます。 詳細については、「https://docs.microsoft.com/azure/aks/enable-host-encryption」を参照してください。

enableFIPS

boolean

FIPS 対応 OS を使用するかどうか。
詳細については 、「FIPS 対応ノード プールの追加 」を参照してください。

enableNodePublicIP

boolean

各ノードに独自のパブリック IP が割り当てられているかどうか。
シナリオによっては、ノード プール内のノードが独自の専用パブリック IP アドレスを受信する必要がある場合があります。 一般的なシナリオとしては、ゲームのワークロードがあります。この場合、ホップを最小限に抑えるために、コンソールをクラウド仮想マシンに直接接続する必要があります。 詳細については、「 ノードごとにパブリック IP を割り当てる」を参照してください。 既定値は false です。

enableUltraSSD

boolean

UltraSSD を有効にするかどうか

gpuInstanceProfile

GPUInstanceProfile

サポートされている GPU VM SKU の GPU MIG インスタンス プロファイルを指定するために使用する GPUInstanceProfile。

hostGroupID

string

仮想マシンをプロビジョニングする専用ホスト グループの完全修飾リソース ID。作成シナリオでのみ使用され、設定後の変更は許可されません。
これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName} の形式です。 詳細については、「 Azure 専用ホスト」を参照してください。

kubeletConfig

KubeletConfig

エージェント ノードの Kubelet 構成。
エージェント プール ノードの Kubelet 構成。

kubeletDiskType

KubeletDiskType

emptyDir ボリューム、コンテナー ランタイム データ ルート、Kubelet エフェメラル ストレージの配置を決定します。

linuxOSConfig

LinuxOSConfig

Linux エージェント ノードの OS 構成。
Linux エージェント ノードの OS 構成。

maxCount

integer

自動スケーリングのノードの最大数

maxPods

integer

ノードで実行できるポッドの最大数。

minCount

integer

自動スケーリング用のノードの最小数

mode

AgentPoolMode

エージェント プールのモード。
クラスターには、常に少なくとも 1 つの "システム" エージェント プールが必要です。 エージェント プールの制限とベスト プラクティスの詳細については、次を参照してください。 https://docs.microsoft.com/azure/aks/use-system-pools

name

string

サブスクリプションとリソース グループのコンテキストにおけるエージェント プール プロファイルの一意の名前。
Windows エージェント プール名は 6 文字以下にする必要があります。

networkProfile

AgentPoolNetworkProfile

エージェント プールのネットワーク関連の設定。

nodeImageVersion

string

ノード イメージのバージョン

nodeLabels

object

エージェント プール内のすべてのノードにわたって永続化されるノード ラベル。

nodePublicIPPrefixID

string

VM ノードが IP を使用する必要があるパブリック IP プレフィックス ID。
これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} の形式です。

nodeTaints

string[]

ノード プールの作成とスケーリング中に新しいノードに追加されたテイント。 たとえば、key=value:NoSchedule です。

orchestratorVersion

string

ユーザーによって指定された Kubernetes のバージョン。
パッチ バージョン <major.minor.patch> (例: 1.20.13) と <major.minor> (例: 1.20) の両方がサポートされています。 major.minor> を指定すると<、サポートされている最新の GA パッチ バージョンが自動的に選択されます。 クラスターの作成後に同じ <major.minor> を使用してクラスターを更新しても (例: 1.14.x -> 1.14)、新しいパッチ バージョンが使用可能な場合でも、アップグレードはトリガーされません。 AKS クラスター内のノード プールは、すべて同じ Kubernetes のバージョンにアップグレードするのがベスト プラクティスです。 ノード プールのバージョンは、コントロール プレーンと同じメジャー バージョンである必要があります。 ノード プールの "マイナー" バージョンは、コントロール プレーンのバージョンの 2 つ以内の "マイナー" バージョンでなければなりません。 ノード プールのバージョンをコントロール プレーンのバージョンより大きくすることはできません。 詳細については、「 ノード プールのアップグレード」を参照してください。

osDiskSizeGB

integer

マスター/エージェント プール内のすべてのマシンのディスク サイズを指定するために使用する OS ディスク サイズ (GB)。 0 を指定すると、指定した vmSize に従って既定の osDisk サイズが適用されます。

osDiskType

OSDiskType

エージェント プール内のマシンに使用する OS ディスクの種類。
VM でサポートされ、要求された OSDiskSizeGB より大きいキャッシュ ディスクがある場合、既定値は "エフェメラル" です。 それ以外の場合、既定値は 'Managed' です。 作成後は変更できない場合があります。 詳細については、「 エフェメラル OS」を参照してください。

osSKU

OSSKU

エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。 既定値は、Kubernetes <= 1.24 の場合は Windows2019、OSType が Windows の場合は Kubernetes >= 1.25 の場合は Windows2022 です。

osType

OSType

Linux

オペレーティング システムの種類。 既定値は Linux です。

podSubnetID

string

起動時にポッドが参加するサブネットの ID。
省略すると、ポッド IP はノード サブネットに静的に割り当てられます (詳細については、「vnetSubnetID」を参照してください)。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。

powerState

PowerState

エージェント プールが実行されているか停止されているか。
エージェント プールが最初に作成されると、最初は実行中です。 エージェント プールは、このフィールドを [停止済み] に設定することで停止できます。 停止したエージェント プールは、すべての VM を停止し、課金料金は発生しません。 エージェント プールは、実行中でプロビジョニング状態が [成功] の場合にのみ停止できます

provisioningState

string

現在のデプロイまたはプロビジョニングの状態。

proximityPlacementGroupID

string

近接配置グループの ID。

scaleDownMode

ScaleDownMode

エージェント プールのスケーリング時に使用するスケール ダウン モード。
これは、クラスターオートスケーラーの動作にも影響します。 指定しない場合、既定では Delete になります。

scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

使用する仮想マシン スケール セットの削除ポリシー。
scaleSetPriority が 'Spot' でない限り、これは指定できません。 指定しない場合、既定値は 'Delete' です。

scaleSetPriority

ScaleSetPriority

Regular

仮想マシン スケール セットの優先度。 指定しない場合、既定値は 'Regular' です。

spotMaxPrice

number

-1

スポット インスタンスに対して支払う最大価格 (米ドル)。 使用できる値は、既定の価格がオンデマンドであることを示す 0 または -1 より大きい任意の 10 進値です。
使用できる値は、0 または -1 より大きい任意の 10 進値です。これは、オンデマンド価格を支払う意欲を示します。 スポット価格の詳細については、「スポット VM の価格」を参照してください。

tags

object

エージェント プール仮想マシン スケール セットに保持されるタグ。

type

AgentPoolType

エージェント プールの種類。

upgradeSettings

AgentPoolUpgradeSettings

エージェント プールをアップグレードするための設定

vmSize

string

エージェント プール VM のサイズ。
VM サイズの可用性はリージョンによって異なります。 ノードに十分なコンピューティング リソース (メモリ、cpu など) が含まれている場合、ポッドが正しく実行されない可能性があります。 制限付き VM サイズの詳細については、次を参照してください。 https://docs.microsoft.com/azure/aks/quotas-skus-regions

vnetSubnetID

string

エージェント プール ノードと必要に応じてポッドが起動時に参加するサブネットの ID。
これが指定されていない場合は、VNET とサブネットが生成されて使用されます。 podSubnetID が指定されていない場合、これはノードとポッドに適用され、それ以外の場合はノードのみに適用されます。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} の形式です。

windowsProfile

AgentPoolWindowsProfile

Windows エージェント プールの特定のプロファイル。

workloadRuntime

WorkloadRuntime

ノードが実行できるワークロードの種類を決定します。

ManagedClusterAPIServerAccessProfile

マネージド クラスター API サーバーのアクセス プロファイル。

名前 説明
authorizedIPRanges

string[]

Kubernetes API サーバーへのアクセスが許可されている IP 範囲。
IP 範囲は CIDR 形式で指定されます (例: 137.117.106.88/29)。 この機能は、ノードあたりのパブリック IP を使用するクラスター、または Basic Load Balancerを使用しているクラスターとは互換性がありません。 詳細については、 API サーバーの承認された IP 範囲に関するページを参照してください。

disableRunCommand

boolean

クラスターの実行コマンドを無効にするかどうか。

enablePrivateCluster

boolean

クラスターをプライベート クラスターとして作成するかどうか。
詳細については、「 プライベート AKS クラスターの作成」を参照してください。

enablePrivateClusterPublicFQDN

boolean

プライベート クラスター用に追加のパブリック FQDN を作成するかどうか。

privateDNSZone

string

クラスターのプライベート DNS ゾーン モード。
既定値は [システム] です。 詳細については、「 プライベート DNS ゾーンを構成する」を参照してください。 使用できる値は、'system' と 'none' です。

ManagedClusterAutoUpgradeProfile

マネージド クラスターの自動アップグレード プロファイル。

名前 説明
nodeOSUpgradeChannel

nodeOSUpgradeChannel

ノード OS アップグレード チャネル
ノード上の OS が更新される方法。 既定値は NodeImage です。

upgradeChannel

upgradeChannel

自動アップグレードのアップグレード チャネル。 既定値は 'none' です。
詳細については、「 AKS クラスターの自動アップグレード チャネルの設定」を参照してください。

ManagedClusterAzureMonitorProfile

マネージド クラスターを監視するための Azure Monitor アドオン プロファイル。

名前 説明
metrics

ManagedClusterAzureMonitorProfileMetrics

Prometheus アドオンの Azure Monitor マネージド サービスのメトリック プロファイル。 すぐに使用できる Kubernetes インフラストラクチャ メトリックを収集して Azure Monitor ワークスペースに送信し、カスタム ターゲットの追加スクレイピングを構成します。 概要については、「aka.ms/AzureManagedPrometheus」を参照してください。

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure Managed Prometheus アドオンの Kube State Metrics プロファイル。 これらのオプションの設定は、アドオンと共にデプロイされる kube-state-metrics ポッド用です。 詳細については、「aka.ms/AzureManagedPrometheus-optional-parameters」を参照してください。

名前 説明
metricAnnotationsAllowList

string

リソースのラベル メトリックで使用される Kubernetes 注釈キーのコンマ区切りの一覧 (例: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...')。 既定では、メトリックにはリソース名と名前空間ラベルのみが含まれます。

metricLabelsAllowlist

string

リソースのラベル メトリックで使用される追加の Kubernetes ラベル キーのコンマ区切りの一覧 (例: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...')。 既定では、メトリックにはリソース名と名前空間ラベルのみが含まれます。

ManagedClusterAzureMonitorProfileMetrics

Prometheus アドオンの Azure Monitor マネージド サービスのメトリック プロファイル。 すぐに使用できる Kubernetes インフラストラクチャ メトリックを収集して Azure Monitor ワークスペースに送信し、カスタム ターゲットの追加スクレイピングを構成します。 概要については、「aka.ms/AzureManagedPrometheus」を参照してください。

名前 説明
enabled

boolean

Prometheus 監視用の Azure Managed Prometheus アドオンを有効または無効にするかどうか。 有効化と無効化の詳細については、「aka.ms/AzureManagedPrometheus-aks-enable」を参照してください。

kubeStateMetrics

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure Managed Prometheus アドオンの Kube State Metrics プロファイル。 これらのオプション設定は、アドオンと共にデプロイされる kube-state-metrics ポッド用です。 詳細については、「aka.ms/AzureManagedPrometheus-optional-parameters」を参照してください。

ManagedClusterCostAnalysis

クラスターのコスト分析構成

名前 説明
enabled

boolean

コスト分析を有効にするかどうか
この機能を有効にするには、マネージド クラスター sku.tier を 'Standard' または 'Premium' に設定する必要があります。 これを有効にすると、Kubernetes 名前空間とデプロイの詳細がAzure portalの [コスト分析] ビューに追加されます。 指定しない場合、既定値は false です。 詳細については、「aka.ms/aks/docs/cost-analysis」を参照してください。

ManagedClusterHTTPProxyConfig

クラスター HTTP プロキシの構成。

名前 説明
httpProxy

string

使用する HTTP プロキシ サーバー エンドポイント。

httpsProxy

string

使用する HTTPS プロキシ サーバー エンドポイント。

noProxy

string[]

プロキシを経由しないエンドポイント。

trustedCa

string

プロキシ サーバーへの接続に使用する代替 CA 証明書。

ManagedClusterIdentity

マネージド クラスターの ID。

名前 説明
delegatedResources

<string,  DelegatedResource>

このマネージド クラスターに割り当てられた委任された ID リソース。 これは別の Azure リソース プロバイダーでのみ設定でき、マネージド クラスターは委任された ID リソースを 1 つだけ受け入れます。 内部使用のみです。

principalId

string

マスター コンポーネントによって使用されるシステム割り当て ID のプリンシパル ID。

tenantId

string

マスター コンポーネントによって使用されるシステム割り当て ID のテナント ID。

type

ResourceIdentityType

マネージド クラスターに使用される ID の種類。
詳細については、「 AKS でマネージド ID を使用する」を参照してください。

userAssignedIdentities

UserAssignedIdentities

マネージド クラスターに関連付けられているユーザー ID。 この ID はコントロール プレーンで使用されます。 許可されるユーザー割り当て ID は 1 つだけです。
キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID である必要があります。

ManagedClusterIngressProfile

コンテナー サービス クラスターのイングレス プロファイル。

名前 説明
webAppRouting

ManagedClusterIngressProfileWebAppRouting

イングレス プロファイルのアプリ ルーティング設定。 この機能の概要とオンボード ガイドについては、 を参照してください https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default

ManagedClusterIngressProfileWebAppRouting

イングレス プロファイルのアプリケーション ルーティング アドオン設定。

名前 説明
dnsZoneResourceIds

string[]

アプリケーション ルーティング アドオンに関連付ける DNS ゾーンのリソース ID。 アプリケーション ルーティング アドオンが有効になっている場合にのみ使用されます。 パブリック DNS ゾーンとプライベート DNS ゾーンは異なるリソース グループに含めることができますが、すべてのパブリック DNS ゾーンが同じリソース グループ内にあり、すべてのプライベート DNS ゾーンが同じリソース グループに存在する必要があります。

enabled

boolean

アプリケーション ルーティング アドオンを有効にするかどうか。

identity

UserAssignedIdentity

アプリケーション ルーティング アドオンのマネージド ID。 これは、関連付けられている Azure DNS リソースを管理し、Azure Key Vaultから証明書を取得するためのアクセス許可を付与する必要がある ID です。 詳細な手順については 、アドオンの概要に関 するページを参照してください。

ManagedClusterLoadBalancerProfile

マネージド クラスター ロード バランサーのプロファイル。

名前 既定値 説明
allocatedOutboundPorts

integer

0

VM ごとに割り当てられた SNAT ポートの必要な数。 使用できる値は、0 ~ 64000 (含む) の範囲です。 既定値は 0 で、Azure でポートが動的に割り当てられます。

backendPoolType

BackendPoolType

NodeIPConfiguration

BackendPool Load Balancerマネージド受信の型。

effectiveOutboundIPs

ResourceReference[]

クラスター ロード バランサーの有効な送信 IP リソース。

enableMultipleStandardLoadBalancers

boolean

AKS クラスターごとに複数の標準ロード バランサーを有効にするかどうか。

idleTimeoutInMinutes

integer

30

必要な送信フローのアイドル タイムアウト (分単位)。 使用できる値は、4 ~ 120 (含む) の範囲です。 既定値は 30 分です。

managedOutboundIPs

ManagedOutboundIPs

クラスター ロード バランサーに必要なマネージド送信 IP。

outboundIPPrefixes

OutboundIPPrefixes

クラスター ロード バランサーの必要な送信 IP プレフィックス リソース。

outboundIPs

OutboundIPs

クラスター ロード バランサーに必要な送信 IP リソース。

ManagedClusterManagedOutboundIPProfile

マネージド クラスターのマネージド送信 IP リソースのプロファイル。

名前 既定値 説明
count

integer

1

Azure によって作成または管理される送信 IP の必要な数。 使用できる値は、1 ~ 16 (含む) の範囲である必要があります。 既定値は 1 です。

ManagedClusterMetricsProfile

ManagedCluster のメトリック プロファイル。

名前 説明
costAnalysis

ManagedClusterCostAnalysis

Kubernetes ごとのリソース コスト分析の詳細な構成。
クラスターのコスト分析構成

ManagedClusterNATGatewayProfile

マネージド クラスター NAT ゲートウェイのプロファイル。

名前 既定値 説明
effectiveOutboundIPs

ResourceReference[]

クラスター NAT ゲートウェイの有効な送信 IP リソース。

idleTimeoutInMinutes

integer

4

必要な送信フローのアイドル タイムアウト (分単位)。 使用できる値は、4 ~ 120 (含む) の範囲です。 既定値は 4 分です。

managedOutboundIPProfile

ManagedClusterManagedOutboundIPProfile

クラスター NAT ゲートウェイのマネージド送信 IP リソースのプロファイル。

ManagedClusterOIDCIssuerProfile

マネージド クラスターの OIDC 発行者プロファイル。

名前 説明
enabled

boolean

OIDC 発行者が有効になっているかどうか。

issuerURL

string

マネージド クラスターの OIDC 発行者 URL。

ManagedClusterPodIdentity

マネージド クラスターに割り当てられたポッド ID の詳細。

名前 説明
bindingSelector

string

AzureIdentityBinding リソースに使用するバインド セレクター。

identity

UserAssignedIdentity

ユーザー割り当て ID の詳細。

name

string

ポッド ID の名前。

namespace

string

ポッド ID の名前空間。

provisioningInfo

ProvisioningInfo

provisioningState

ManagedClusterPodIdentityProvisioningState

ポッド ID の現在のプロビジョニング状態。

ManagedClusterPodIdentityException

ポッド ID 例外。特定のラベルを持つポッドは、ノード マネージド ID (NMI) サーバーによってインターセプトされることなく、Azure Instance Metadata Service (IMDS) エンドポイントにアクセスできます。

名前 説明
name

string

ポッド ID 例外の名前。

namespace

string

ポッド ID 例外の名前空間。

podLabels

object

一致するポッド ラベル。

ManagedClusterPodIdentityProfile

マネージド クラスターのポッド ID プロファイル。

名前 説明
allowNetworkPluginKubenet

boolean

Kubenet ネットワークを使用したクラスターでのポッド ID の実行を許可するかどうか。
Kubenet での実行は、AAD ポッド ID のセキュリティ関連の性質と IP スプーフィングのリスクにより、既定で無効になっています。 詳細については、 AAD ポッド ID での Kubenet ネットワーク プラグインの使用 に関するページを参照してください。

enabled

boolean

ポッド ID アドオンが有効になっているかどうか。

userAssignedIdentities

ManagedClusterPodIdentity[]

クラスターで使用するポッド ID。

userAssignedIdentityExceptions

ManagedClusterPodIdentityException[]

許可するポッド ID の例外。

ManagedClusterPodIdentityProvisioningError

ポッド ID プロビジョニングからのエラー応答。

名前 説明
error

ManagedClusterPodIdentityProvisioningErrorBody

エラーの詳細。

ManagedClusterPodIdentityProvisioningErrorBody

ポッド ID プロビジョニングからのエラー応答。

名前 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

details

ManagedClusterPodIdentityProvisioningErrorBody[]

エラーに関する追加の詳細の一覧。

message

string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

target

string

特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

ManagedClusterPodIdentityProvisioningState

ポッド ID の現在のプロビジョニング状態。

名前 説明
Assigned

string

Canceled

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ManagedClusterSecurityProfile

コンテナー サービス クラスターのセキュリティ プロファイル。

名前 説明
azureKeyVaultKms

AzureKeyVaultKms

セキュリティ プロファイルの Azure Key Vaultキー管理サービスの設定。

defender

ManagedClusterSecurityProfileDefender

セキュリティ プロファイルの設定をMicrosoft Defenderします。

imageCleaner

ManagedClusterSecurityProfileImageCleaner

セキュリティ プロファイルのイメージ クリーナー設定。

workloadIdentity

ManagedClusterSecurityProfileWorkloadIdentity

セキュリティ プロファイルのワークロード ID 設定。 ワークロード ID を使用すると、Kubernetes アプリケーションは Azure AD を使用して Azure クラウド リソースに安全にアクセスできます。 詳細については、 https://aka.ms/aks/wi をご覧ください。

ManagedClusterSecurityProfileDefender

セキュリティ プロファイルの設定をMicrosoft Defenderします。

名前 説明
logAnalyticsWorkspaceResourceId

string

Microsoft Defenderに関連付ける Log Analytics ワークスペースのリソース ID。 Microsoft Defenderが有効になっている場合、このフィールドは必須であり、有効なワークスペース リソース ID である必要があります。 Microsoft Defenderが無効になっている場合は、フィールドを空のままにします。

securityMonitoring

ManagedClusterSecurityProfileDefenderSecurityMonitoring

セキュリティ プロファイルのクラウド設定の脅威検出をMicrosoft Defenderします。

ManagedClusterSecurityProfileDefenderSecurityMonitoring

セキュリティ プロファイルの脅威検出の設定をMicrosoft Defenderします。

名前 説明
enabled

boolean

Defender 脅威検出を有効にするかどうか

ManagedClusterSecurityProfileImageCleaner

イメージ クリーナーは、ノードから未使用のイメージを削除し、ディスク領域を解放し、攻撃対象領域を減らすのに役立ちます。 セキュリティ プロファイルの設定を次に示します。

名前 説明
enabled

boolean

AKS クラスターでイメージ クリーナーを有効にするかどうか。

intervalHours

integer

イメージ クリーナーのスキャン間隔 (時間単位)。

ManagedClusterSecurityProfileWorkloadIdentity

セキュリティ プロファイルのワークロード ID 設定。

名前 説明
enabled

boolean

ワークロード ID を有効にするかどうか。

ManagedClusterServicePrincipalProfile

Azure API の操作に使用するクラスターのサービス プリンシパル ID に関する情報。

名前 説明
clientId

string

サービス プリンシパルの ID。

secret

string

プレーン テキストでサービス プリンシパルに関連付けられているシークレット パスワード。

ManagedClusterSKU

マネージド クラスターの SKU。

名前 説明
name

ManagedClusterSKUName

マネージド クラスター SKU の名前。

tier

ManagedClusterSKUTier

マネージド クラスター SKU の層。
指定しない場合、既定値は 'Free' です。 詳細については、 AKS の価格レベル に関するページを参照してください。

ManagedClusterSKUName

マネージド クラスター SKU の名前。

名前 説明
Base

string

AKS コントロール プレーンの基本オプション。

ManagedClusterSKUTier

マネージド クラスター SKU の層。

名前 説明
Free

string

クラスター管理は無料ですが、VM、ストレージ、ネットワークの使用に対して課金されます。 ノード数が 10 未満の実験、学習、単純なテスト、またはワークロードに最適です。 運用環境のユース ケースにはお勧めしません。

Premium

string

クラスターには、'Standard' に含まれるすべての機能に加えて、Premium 機能があります。 Premium では、特定の Kubernetes バージョンに対して LongTermSupport (aka.ms/aks/lts) を選択できます。

Standard

string

ミッション クリティカルなワークロードと運用ワークロードに推奨されます。 Kubernetes コントロール プレーンの自動スケーリング、ワークロード集中型テスト、クラスターあたり最大 5,000 ノードが含まれます。 Availability Zonesを使用するクラスターの Kubernetes API サーバー エンドポイントの可用性が 99.95%、Availability Zonesを使用しないクラスターの可用性の 99.9% が保証されます。

ManagedClusterStorageProfile

コンテナー サービス クラスターのストレージ プロファイル。

名前 説明
blobCSIDriver

ManagedClusterStorageProfileBlobCSIDriver

ストレージ プロファイルの AzureBlob CSI ドライバー設定。

diskCSIDriver

ManagedClusterStorageProfileDiskCSIDriver

ストレージ プロファイルの AzureDisk CSI ドライバー設定。

fileCSIDriver

ManagedClusterStorageProfileFileCSIDriver

ストレージ プロファイルの AzureFile CSI ドライバー設定。

snapshotController

ManagedClusterStorageProfileSnapshotController

ストレージ プロファイルのスナップショット コントローラー設定。

ManagedClusterStorageProfileBlobCSIDriver

ストレージ プロファイルの AzureBlob CSI ドライバー設定。

名前 説明
enabled

boolean

AzureBlob CSI ドライバーを有効にするかどうか。 既定値は false です。

ManagedClusterStorageProfileDiskCSIDriver

ストレージ プロファイルの AzureDisk CSI ドライバー設定。

名前 説明
enabled

boolean

AzureDisk CSI ドライバーを有効にするかどうか。 既定値は、true です。

ManagedClusterStorageProfileFileCSIDriver

ストレージ プロファイルの AzureFile CSI ドライバー設定。

名前 説明
enabled

boolean

AzureFile CSI ドライバーを有効にするかどうか。 既定値は、true です。

ManagedClusterStorageProfileSnapshotController

ストレージ プロファイルのスナップショット コントローラー設定。

名前 説明
enabled

boolean

スナップショット コントローラーを有効にするかどうか。 既定値は、true です。

ManagedClusterWindowsProfile

マネージド クラスター内の Windows VM のプロファイル。

名前 説明
adminPassword

string

管理者アカウントのパスワードを指定します。

最小長: 8 文字

最大長: 123 文字

複雑さの要件: 以下の 4 つの条件のうち 3 つを満たす必要がある
文字が小さい
上の文字を含む
数字を含む
特殊文字があります (Regex match [\W_])

許可されていない値: "abc@123"、"P@$$w 0rd"、"P@ssw0rd"、"P@ssword123"、"Pa$$word"、"pass@word1"、"Password!"、"Password1"、"Password22"、"iloveyou!"

adminUsername

string

管理者アカウントの名前を指定します。

制限: "." で終わることはできません。

許可されていない値: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1"、"123"、"a"、"actuser"、"adm"、"admin2"、"aspnet"、"backup"、"console"、"david"、"guest"、"john"、"owner"、"root"、"server"、"sql"、"support"、"support_388945a0"、"sys"、"test2"、"test3"、"user4"、"user5"。

最小長: 1 文字

最大長: 20 文字

enableCSIProxy

boolean

CSI プロキシを有効にするかどうか。
CSI プロキシの詳細については、 CSI プロキシの GitHub リポジトリを参照してください。

gmsaProfile

WindowsGmsaProfile

マネージド クラスター内の Windows gMSA プロファイル。

licenseType

licenseType

Windows VM に使用するライセンスの種類。 詳細については、「 Azure ハイブリッド ユーザー特典 」を参照してください。

ManagedClusterWorkloadAutoScalerProfile

マネージド クラスターのワークロード自動スケーラー プロファイル。

名前 説明
keda

ManagedClusterWorkloadAutoScalerProfileKeda

ワークロード自動スケーラー プロファイルの KEDA (Kubernetes イベント ドリブン自動スケーリング) 設定。

verticalPodAutoscaler

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

ワークロード自動スケーラー プロファイルの VPA (Vertical Pod Autoscaler) 設定。

ManagedClusterWorkloadAutoScalerProfileKeda

ワークロード自動スケーラー プロファイルの KEDA (Kubernetes イベント ドリブン自動スケーリング) 設定。

名前 説明
enabled

boolean

KEDA を有効にするかどうか。

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

ワークロード自動スケーラー プロファイルの VPA (Vertical Pod Autoscaler) 設定。

名前 既定値 説明
enabled

boolean

False

VPA を有効にするかどうか。 既定値は false です。

ManagedOutboundIPs

クラスター ロード バランサーに必要なマネージド送信 IP。

名前 既定値 説明
count

integer

1

クラスター ロード バランサー用に Azure によって作成または管理される IPv4 送信 IP の必要な数。 使用できる値は、1 ~ 100 (含む) の範囲である必要があります。 既定値は 1 です。

countIPv6

integer

0

クラスター ロード バランサー用に Azure によって作成または管理される IPv6 送信 IP の必要な数。 使用できる値は、1 ~ 100 (含む) の範囲である必要があります。 既定値は、単一スタックの場合は 0、デュアルスタックの場合は 1 です。

networkDataplane

Kubernetes クラスターで使用されるネットワーク データプレーン。

名前 説明
azure

string

Azure ネットワーク データプレーンを使用します。

cilium

string

Cilium ネットワーク データプレーンを使用します。 詳細については、「 Azure CNI Powered by Cilium 」を参照してください。

networkMode

ネットワーク モードの Azure CNI は で構成されています。

名前 説明
bridge

string

これはサポートされなくなりました

transparent

string

ブリッジは作成されません。 ポッド間の VM 内通信は、Azure CNI によって作成された IP ルートを介して行われます。 詳細については、「 透過モード 」を参照してください。

NetworkPlugin

Kubernetes ネットワークの構築に使用されるネットワーク プラグイン。

名前 説明
azure

string

Azure CNI ネットワーク プラグインを使用します。 詳細については、「 Azure CNI (高度な) ネットワーク」 を参照してください。

kubenet

string

Kubenet ネットワーク プラグインを使用します。 詳細については、「 Kubenet (basic) ネットワーク」 を参照してください。

none

string

CNI プラグインはプレインストールされていません。 詳細については 、BYO CNI に関するページを参照してください。

NetworkPluginMode

ネットワーク プラグインで使用する必要があるモード。

名前 説明
overlay

string

networkPlugin=azure で使用されるポッドには、PodCIDR アドレス空間からの IP が与えられますが、Kubenet のルート テーブルの方法ではなく、Azure ルーティング ドメインを使用します。 詳細については、 を参照してください https://aka.ms/aks/azure-cni-overlay

NetworkPolicy

Kubernetes ネットワークの構築に使用されるネットワーク ポリシー。

名前 説明
azure

string

Azure ネットワーク ポリシーを使用します。 詳細については、「 Azure ポリシーと Calico ポリシーの違い 」を参照してください。

calico

string

Calico ネットワーク ポリシー を使用している。 詳細については、「 Azure ポリシーと Calico ポリシーの違い 」を参照してください。

cilium

string

Cilium を使用してネットワーク ポリシーを適用します。 これには、networkDataplane が "cilium" である必要があります。

nodeOSUpgradeChannel

ノード OS アップグレード チャネル

名前 説明
NodeImage

string

AKS は、毎週の頻度でセキュリティ修正とバグ修正を含む新しく修正された VHD でノードを更新します。 VHD 更新プログラム のマシンは、メンテナンス期間とサージ設定に従って、その VHD に再イメージ化されます。 このオプションを選択すると、AKS によってイメージがホストされるため、追加の VHD コストは発生しません。

None

string

OS またはローリング VHD によって、マシンの OS を更新する試みは行われません。 つまり、セキュリティ更新プログラムに責任を負います

Unmanaged

string

OS 更新プログラムは、OS 組み込みのパッチ適用インフラストラクチャを通じて自動的に適用されます。 マシンで新しくスケーリングされた場合、最初はパッチが適用されません。また、OS のインフラストラクチャによってある時点で修正プログラムが適用されます。 このオプションの動作は、問題の OS によって異なります。 Ubuntu と Mariner は、06:00 UTC 頃に 1 日に 1 回、無人アップグレードを通じてセキュリティ パッチを適用します。 Windows はセキュリティ パッチを自動的に適用しないため、このオプションは今後の通知まで None と同等です

OSDiskType

エージェント プール内のマシンに使用する OS ディスクの種類。

名前 説明
Ephemeral

string

エフェメラル OS ディスクは、一時ディスクと同様に、ホスト コンピューターにのみ格納されます。 これにより、読み取り/書き込みの待機時間が短縮され、ノードのスケーリングやクラスターのアップグレードが高速になります。

Managed

string

Vm を別のホストに再配置する必要がある場合にデータが失われるのを防ぐために、Azure は仮想マシンのオペレーティング システム ディスクを Azure Storage にレプリケートします。 コンテナーはローカル状態を保持するように設計されていないため、この動作では限られた値が提供されますが、ノードのプロビジョニングが遅く、読み取り/書き込みの待機時間が長くなるなど、いくつかの欠点があります。

OSSKU

エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。 既定値は、Kubernetes <= 1.24 の場合は Windows2019、OSType が Windows の場合は Kubernetes >= 1.25 の場合は Windows2022 です。

名前 説明
AzureLinux

string

ノード イメージの OS として AzureLinux を使用します。 Azure Linux は、Microsoft によって構築されたコンテナー最適化 Linux ディストリビューションです。詳細については、を参照してください https://aka.ms/azurelinux

CBLMariner

string

非推奨の OSSKU。 新しいデプロイでは、代わりに "AzureLinux" を選択することをお勧めします。

Ubuntu

string

ノード イメージの OS として Ubuntu を使用します。

Windows2019

string

ノード イメージの OS として Windows2019 を使用します。 システム ノード プールではサポートされていません。 Windows2019 では、Windows2019 コンテナーのみがサポートされます。Windows2022 コンテナーを実行することはできません。その逆も同様です。

Windows2022

string

ノード イメージの OS として Windows2022 を使用します。 システム ノード プールではサポートされていません。 Windows2022 では、Windows2022 コンテナーのみがサポートされます。Windows2019 コンテナーを実行することはできません。その逆も同様です。

OSType

オペレーティング システムの種類。 既定値は Linux です。

名前 説明
Linux

string

Linux を使用します。

Windows

string

Windows を使用します。

OutboundIPPrefixes

クラスター ロード バランサーの必要な送信 IP プレフィックス リソース。

名前 説明
publicIPPrefixes

ResourceReference[]

パブリック IP プレフィックス リソースの一覧。

OutboundIPs

クラスター ロード バランサーに必要な送信 IP リソース。

名前 説明
publicIPs

ResourceReference[]

パブリック IP リソースの一覧。

outboundType

送信 (エグレス) ルーティング方法。

名前 説明
loadBalancer

string

ロード バランサーは、AKS に割り当てられたパブリック IP を経由したエグレスに使用されます。 これにより、型 'loadBalancer' の Kubernetes サービスがサポートされます。 詳細については、「 送信型の loadbalancer」を参照してください。

managedNATGateway

string

AKS マネージド NAT ゲートウェイはエグレスに使用されます。

userAssignedNATGateway

string

クラスター サブネットに関連付けられているユーザー割り当て NAT ゲートウェイがエグレスに使用されます。 これは高度なシナリオであり、適切なネットワーク構成が必要です。

userDefinedRouting

string

エグレス パスは、ユーザーが定義する必要があります。 これは高度なシナリオであり、適切なネットワーク構成が必要です。 詳細については、「 送信の種類 userDefinedRouting」を参照してください。

PortRange

ポート範囲。

名前 説明
portEnd

integer

範囲に含まれる最大ポート。 範囲は 1 から 65535 で、portStart 以上である必要があります。

portStart

integer

範囲に含まれる最小ポート。 範囲は 1 から 65535 で、portEnd 以下である必要があります。

protocol

Protocol

ポートのネットワーク プロトコル。

PowerState

クラスターの電源状態について説明します

名前 説明
code

code

クラスターが実行中か停止かを示します

PrivateLinkResource

プライベート リンク リソース

名前 説明
groupId

string

リソースのグループ ID。

id

string

プライベート リンク リソースの ID。

name

string

プライベート リンク リソースの名前。

privateLinkServiceID

string

リソースのプライベート リンク サービス ID。このフィールドは内部的に NRP にのみ公開されます。

requiredMembers

string[]

リソースの RequiredMembers

type

string

リソースの種類。

Protocol

ポートのネットワーク プロトコル。

名前 説明
TCP

string

TCP プロトコル。

UDP

string

UDP プロトコル。

ProvisioningInfo

名前 説明
error

ManagedClusterPodIdentityProvisioningError

ポッド ID の割り当てエラー (存在する場合)。

PublicNetworkAccess

managedCluster の PublicNetworkAccess

名前 説明
Disabled

string

Enabled

string

ResourceIdentityType

マネージド クラスターに使用される ID の種類。

名前 説明
None

string

マネージド クラスターにはマネージド ID を使用しないでください。代わりにサービス プリンシパルが使用されます。

SystemAssigned

string

クラスター リソースを管理するには、暗黙的に作成されたシステム割り当てマネージド ID を使用します。 kube-controller-manager などのコントロール プレーンのマスター コンポーネントは、システム割り当てマネージド ID を使用して Azure リソースを操作します。

UserAssigned

string

ユーザー指定の ID を使用してクラスター リソースを管理します。 kube-controller-manager などのコントロール プレーンのマスター コンポーネントは、指定されたユーザー割り当てマネージド ID を使用して Azure リソースを操作します。

ResourceReference

Azure リソースへの参照。

名前 説明
id

string

完全修飾 Azure リソース ID。

ScaleDownMode

エージェント プールに対して VM を追加または削除する方法について説明します。 課金の状態を参照してください。

名前 説明
Deallocate

string

スケールアップ中に割り当て解除されたインスタンス (存在する場合) を開始し、スケール ダウン中にインスタンスの割り当てを解除します。

Delete

string

スケールアップ中に新しいインスタンスを作成し、スケールダウン中にインスタンスを削除します。

ScaleSetEvictionPolicy

仮想マシン スケール セットの削除ポリシー。

名前 説明
Deallocate

string

ノード プールの基になるスケール セット内のノードは、削除時に停止された割り当て解除状態に設定されます。 停止済み/割り当て解除済み状態のノードはコンピューティング クォータには含まれず、クラスターのスケーリングやアップグレードで問題を発生させる場合があります。

Delete

string

ノード プールの基になるスケール セット内のノードは、削除されると削除されます。

ScaleSetPriority

仮想マシン スケール セットの優先度。

名前 説明
Regular

string

通常の VM が使用されます。

Spot

string

スポット優先度 VM が使用されます。 スポット ノードの SLA はありません。 詳細については、 AKS のスポットに関 するページを参照してください。

ServiceMeshMode

サービス メッシュのモード。

名前 説明
Disabled

string

メッシュが無効になっています。

Istio

string

AKS アドオンとしてデプロイされた Istio。

ServiceMeshProfile

マネージド クラスターのサービス メッシュ プロファイル。

名前 説明
istio

IstioServiceMesh

Istio サービス メッシュの構成。

mode

ServiceMeshMode

サービス メッシュのモード。

SysctlConfig

Linux エージェント ノードの Sysctl 設定。

名前 説明
fsAioMaxNr

integer

Sysctl setting fs.aio-max-nr.

fsFileMax

integer

Sysctl setting fs.file-max.

fsInotifyMaxUserWatches

integer

sysctl setting fs.inotify.max_user_watches.

fsNrOpen

integer

Sysctl の設定fs.nr_open。

kernelThreadsMax

integer

sysctl setting kernel.threads-max.

netCoreNetdevMaxBacklog

integer

Sysctl 設定net.core.netdev_max_backlog。

netCoreOptmemMax

integer

Sysctl 設定net.core.optmem_max。

netCoreRmemDefault

integer

Sysctl 設定net.core.rmem_default。

netCoreRmemMax

integer

Sysctl 設定net.core.rmem_max。

netCoreSomaxconn

integer

Sysctl setting net.core.somaxconn。

netCoreWmemDefault

integer

Sysctl 設定net.core.wmem_default。

netCoreWmemMax

integer

Sysctl 設定net.core.wmem_max。

netIpv4IpLocalPortRange

string

Sysctl の設定net.ipv4.ip_local_port_range。

netIpv4NeighDefaultGcThresh1

integer

Sysctl の設定net.ipv4.neigh.default.gc_thresh1。

netIpv4NeighDefaultGcThresh2

integer

Sysctl の設定net.ipv4.neigh.default.gc_thresh2。

netIpv4NeighDefaultGcThresh3

integer

Sysctl の設定net.ipv4.neigh.default.gc_thresh3。

netIpv4TcpFinTimeout

integer

Sysctl 設定net.ipv4.tcp_fin_timeout。

netIpv4TcpKeepaliveProbes

integer

Sysctl 設定net.ipv4.tcp_keepalive_probes。

netIpv4TcpKeepaliveTime

integer

Sysctl 設定net.ipv4.tcp_keepalive_time。

netIpv4TcpMaxSynBacklog

integer

Sysctl 設定net.ipv4.tcp_max_syn_backlog。

netIpv4TcpMaxTwBuckets

integer

Sysctl 設定net.ipv4.tcp_max_tw_buckets。

netIpv4TcpTwReuse

boolean

Sysctl 設定net.ipv4.tcp_tw_reuse。

netIpv4TcpkeepaliveIntvl

integer

Sysctl 設定net.ipv4.tcp_keepalive_intvl。

netNetfilterNfConntrackBuckets

integer

Sysctl の設定net.netfilter.nf_conntrack_buckets。

netNetfilterNfConntrackMax

integer

Sysctl の設定net.netfilter.nf_conntrack_max。

vmMaxMapCount

integer

sysctl setting vm.max_map_count.

vmSwappiness

integer

Sysctl setting vm.swappiness.

vmVfsCachePressure

integer

Sysctl 設定vm.vfs_cache_pressure。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

TagsObject

パッチ操作用のタグ オブジェクト。

名前 説明
tags

object

リソース タグ。

upgradeChannel

自動アップグレードのアップグレード チャネル。 既定値は 'none' です。

名前 説明
node-image

string

ノード イメージを使用可能な最新バージョンに自動的にアップグレードします。 代わりに nodeOSUpgradeChannel を使用することを検討してください。これにより、Kubernetes バージョンの修正プログラムとは別にノード OS の修正プログラムを構成できます

none

string

自動アップグレードを無効にし、クラスターを現在のバージョンの Kubernetes に保持します。

patch

string

マイナー バージョンを同じままにしたまま、クラスターが使用可能になったときに、サポートされている最新のパッチ バージョンにクラスターを自動的にアップグレードします。 たとえば、クラスターでバージョン 1.17.7 とバージョン 1.17.9、1.18.4、1.18.6、1.19.1 が実行されている場合、クラスターは 1.17.9 にアップグレードされます。

rapid

string

サポートされている最新のマイナー バージョンで、クラスターを最新のサポートされているパッチ リリースに自動的にアップグレードします。 クラスターの Kubernetes バージョンが N-2 マイナー バージョンの位置にある場合 (N はサポートされる最新のマイナー バージョン)、クラスターはまず、N-1 マイナー バージョンでサポートされる最新のパッチ バージョンにアップグレードされます。 たとえば、クラスターでバージョン 1.17.7 を実行しているとき、バージョン 1.17.9、1.18.4、1.18.6、1.19.1 が利用できる場合、クラスターはまず 1.18.6 にアップグレードされ、その後、1.19.1 にアップグレードされます。

stable

string

マイナー バージョン N-1 でサポートされている最新のパッチ リリースにクラスターを自動的にアップグレードします。N は、サポートされている最新のマイナー バージョンです。 たとえば、クラスターでバージョン 1.17.7 を実行しているとき、バージョン 1.17.9、1.18.4、1.18.6、1.19.1 が利用できる場合、クラスターは 1.18.6 にアップグレードされます。

UpgradeOverrideSettings

クラスターをアップグレードするときのオーバーライドの設定。

名前 説明
forceUpgrade

boolean

クラスターを強制的にアップグレードするかどうか。 このオプションは、非推奨の API 使用状況の確認などのアップグレード保護をバイパスするようにアップグレード操作に指示します。 このオプションは注意して有効にしてください。

until

string

オーバーライドが有効になるまで。 これはアップグレードの開始時刻にのみ一致し、アップグレードが進むにつれて有効期限が切れた場合 until でも、アップグレードが開始されると有効性は変わらないことに注意してください。 このフィールドは既定では設定されていません。 オーバーライドを有効にするには、設定する必要があります。

UserAssignedIdentities

マネージド クラスターに関連付けられているユーザー ID。 この ID はコントロール プレーンで使用されます。 許可されるユーザー割り当て ID は 1 つだけです。

名前 説明

UserAssignedIdentity

ユーザー割り当て ID の詳細。

名前 説明
clientId

string

ユーザー割り当て ID のクライアント ID。

objectId

string

ユーザー割り当て ID のオブジェクト ID。

resourceId

string

ユーザー割り当て ID のリソース ID。

WindowsGmsaProfile

マネージド クラスター内の Windows gMSA プロファイル。

名前 説明
dnsServer

string

Windows gMSA の DNS サーバーを指定します。

マネージド クラスターの作成に使用される vnet で DNS サーバーを構成している場合は、空に設定します。

enabled

boolean

Windows gMSA を有効にするかどうか。
マネージド クラスターで Windows gMSA を有効にするかどうかを指定します。

rootDomainName

string

Windows gMSA のルート ドメイン名を指定します。

マネージド クラスターの作成に使用される vnet で DNS サーバーを構成している場合は、空に設定します。

WorkloadRuntime

ノードが実行できるワークロードの種類を決定します。

名前 説明
OCIContainer

string

ノードは Kubelet を使用して、標準の OCI コンテナー ワークロードを実行します。

WasmWasi

string

ノードでは、WASI プロバイダー (プレビュー) を使用して、Krustlet を使用して WASM ワークロードを実行します。