Managed Clusters - Get

サービス:

AKS

API バージョン:

2024-09-01

マネージド クラスターを取得します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。 名前では大文字と小文字が区別されません。
resourceName	path	True	string	マネージド クラスター リソースの名前。 正規表現パターン: ^[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 バージョン。

応答

名前	型	説明
200 OK	ManagedCluster	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Get Managed Cluster

要求のサンプル

HTTP

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

Java

/**
 * Samples for ManagedClusters GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/
     * ManagedClustersGet.json
     */
    /**
     * Sample code: Get Managed Cluster.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getManagedCluster(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getManagedClusters().getByResourceGroupWithResponse("rg1",
            "clustername1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python managed_clusters_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_clusters.get(
        resource_group_name="rg1",
        resource_name="clustername1",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet.json
func ExampleManagedClustersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedClustersClient().Get(ctx, "rg1", "clustername1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedCluster = armcontainerservice.ManagedCluster{
	// 	Name: to.Ptr("clustername1"),
	// 	Type: to.Ptr("Microsoft.ContainerService/ManagedClusters"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1"),
	// 	Location: to.Ptr("location1"),
	// 	Tags: map[string]*string{
	// 		"archv2": to.Ptr(""),
	// 		"tier": to.Ptr("production"),
	// 	},
	// 	ETag: to.Ptr("beywbwei"),
	// 	Properties: &armcontainerservice.ManagedClusterProperties{
	// 		AgentPoolProfiles: []*armcontainerservice.ManagedClusterAgentPoolProfile{
	// 			{
	// 				AvailabilityZones: []*string{
	// 					to.Ptr("1"),
	// 					to.Ptr("2"),
	// 					to.Ptr("3")},
	// 					Count: to.Ptr[int32](3),
	// 					CurrentOrchestratorVersion: to.Ptr("1.9.6"),
	// 					ETag: to.Ptr("nvewbvoi"),
	// 					MaxPods: to.Ptr[int32](110),
	// 					NodeImageVersion: to.Ptr("AKSUbuntu:1604:2020.03.11"),
	// 					OrchestratorVersion: to.Ptr("1.9.6"),
	// 					OSType: to.Ptr(armcontainerservice.OSTypeLinux),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 					UpgradeSettings: &armcontainerservice.AgentPoolUpgradeSettings{
	// 						MaxSurge: to.Ptr("33%"),
	// 					},
	// 					VMSize: to.Ptr("Standard_DS1_v2"),
	// 					Name: to.Ptr("nodepool1"),
	// 			}},
	// 			AzurePortalFQDN: to.Ptr("dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io"),
	// 			CurrentKubernetesVersion: to.Ptr("1.9.6"),
	// 			DiskEncryptionSetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des"),
	// 			DNSPrefix: to.Ptr("dnsprefix1"),
	// 			EnableRBAC: to.Ptr(false),
	// 			Fqdn: to.Ptr("dnsprefix1-abcd1234.hcp.eastus.azmk8s.io"),
	// 			KubernetesVersion: to.Ptr("1.9.6"),
	// 			LinuxProfile: &armcontainerservice.LinuxProfile{
	// 				AdminUsername: to.Ptr("azureuser"),
	// 				SSH: &armcontainerservice.SSHConfiguration{
	// 					PublicKeys: []*armcontainerservice.SSHPublicKey{
	// 						{
	// 							KeyData: to.Ptr("keydata"),
	// 					}},
	// 				},
	// 			},
	// 			MaxAgentPools: to.Ptr[int32](1),
	// 			NetworkProfile: &armcontainerservice.NetworkProfile{
	// 				DNSServiceIP: to.Ptr("10.0.0.10"),
	// 				IPFamilies: []*armcontainerservice.IPFamily{
	// 					to.Ptr(armcontainerservice.IPFamilyIPv4)},
	// 					LoadBalancerProfile: &armcontainerservice.ManagedClusterLoadBalancerProfile{
	// 						AllocatedOutboundPorts: to.Ptr[int32](2000),
	// 						EffectiveOutboundIPs: []*armcontainerservice.ResourceReference{
	// 							{
	// 								ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"),
	// 							},
	// 							{
	// 								ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"),
	// 						}},
	// 						IdleTimeoutInMinutes: to.Ptr[int32](10),
	// 						OutboundIPs: &armcontainerservice.ManagedClusterLoadBalancerProfileOutboundIPs{
	// 							PublicIPs: []*armcontainerservice.ResourceReference{
	// 								{
	// 									ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1"),
	// 								},
	// 								{
	// 									ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2"),
	// 							}},
	// 						},
	// 					},
	// 					LoadBalancerSKU: to.Ptr(armcontainerservice.LoadBalancerSKUStandard),
	// 					NetworkPlugin: to.Ptr(armcontainerservice.NetworkPluginKubenet),
	// 					OutboundType: to.Ptr(armcontainerservice.OutboundTypeLoadBalancer),
	// 					PodCidr: to.Ptr("10.244.0.0/16"),
	// 					PodCidrs: []*string{
	// 						to.Ptr("10.244.0.0/16")},
	// 						ServiceCidr: to.Ptr("10.0.0.0/16"),
	// 						ServiceCidrs: []*string{
	// 							to.Ptr("10.0.0.0/16")},
	// 						},
	// 						NodeResourceGroup: to.Ptr("MC_rg1_clustername1_location1"),
	// 						ProvisioningState: to.Ptr("Succeeded"),
	// 						ServicePrincipalProfile: &armcontainerservice.ManagedClusterServicePrincipalProfile{
	// 							ClientID: to.Ptr("clientid"),
	// 						},
	// 						UpgradeSettings: &armcontainerservice.ClusterUpgradeSettings{
	// 							OverrideSettings: &armcontainerservice.UpgradeOverrideSettings{
	// 								ForceUpgrade: to.Ptr(true),
	// 								Until: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T13:00:00.000Z"); return t}()),
	// 							},
	// 						},
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a managed cluster.
 *
 * @summary Gets a managed cluster.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet.json
 */
async function getManagedCluster() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.get(resourceGroupName, resourceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
  "location": "location1",
  "name": "clustername1",
  "tags": {
    "archv2": "",
    "tier": "production"
  },
  "type": "Microsoft.ContainerService/ManagedClusters",
  "eTag": "beywbwei",
  "properties": {
    "provisioningState": "Succeeded",
    "maxAgentPools": 1,
    "kubernetesVersion": "1.9.6",
    "currentKubernetesVersion": "1.9.6",
    "dnsPrefix": "dnsprefix1",
    "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
    "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io",
    "agentPoolProfiles": [
      {
        "name": "nodepool1",
        "count": 3,
        "vmSize": "Standard_DS1_v2",
        "maxPods": 110,
        "osType": "Linux",
        "eTag": "nvewbvoi",
        "provisioningState": "Succeeded",
        "orchestratorVersion": "1.9.6",
        "currentOrchestratorVersion": "1.9.6",
        "availabilityZones": [
          "1",
          "2",
          "3"
        ],
        "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
        "upgradeSettings": {
          "maxSurge": "33%"
        }
      }
    ],
    "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",
    "networkProfile": {
      "networkPlugin": "kubenet",
      "podCidr": "10.244.0.0/16",
      "serviceCidr": "10.0.0.0/16",
      "dnsServiceIP": "10.0.0.10",
      "loadBalancerSku": "standard",
      "outboundType": "loadBalancer",
      "podCidrs": [
        "10.244.0.0/16"
      ],
      "serviceCidrs": [
        "10.0.0.0/16"
      ],
      "ipFamilies": [
        "IPv4"
      ],
      "loadBalancerProfile": {
        "allocatedOutboundPorts": 2000,
        "idleTimeoutInMinutes": 10,
        "outboundIPs": {
          "publicIPs": [
            {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1"
            },
            {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2"
            }
          ]
        },
        "effectiveOutboundIPs": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
          }
        ]
      }
    },
    "upgradeSettings": {
      "overrideSettings": {
        "forceUpgrade": true,
        "until": "2022-11-01T13:00:00Z"
      }
    }
  }
}

定義

名前	説明
AdvancedNetworking	クラスターで可観測性とセキュリティ機能スイートを有効にするための高度なネットワーク プロファイル。 詳細については、aka.ms/aksadvancednetworking を参照してください。
AdvancedNetworkingObservability	履歴コンテキストを使用して高度なネットワーク メトリックとフロー ログを有効にする可観測性プロファイル。
AdvancedNetworkingSecurity	cilium ベースのクラスターでセキュリティ機能を有効にするセキュリティ プロファイル。
AgentPoolMode	エージェント プールのモード。
AgentPoolNetworkProfile	エージェント プールのネットワーク設定。
AgentPoolSecurityProfile	エージェント プールのセキュリティ設定。
AgentPoolType	エージェント プールの種類。
AgentPoolUpgradeSettings	エージェント プールをアップグレードするための設定
AgentPoolWindowsProfile	Windows エージェント プールの特定のプロファイル。
AutoScalerProfile	有効な場合にクラスター オートスケーラーに適用されるパラメーター
AzureKeyVaultKms	セキュリティ プロファイルの Azure Key Vault キー管理サービスの設定。
BackendPoolType	マネージド受信ロード バランサー BackendPool の種類。
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 Certificate Authority (CA) の構成。 現時点では、ここで説明するプラグイン証明書のみがサポート https://aka.ms/asm-plugin-ca
IstioComponents	Istio コンポーネントの構成。
IstioEgressGateway	Istio エグレス ゲートウェイの構成。
IstioIngressGateway	Istio イングレス ゲートウェイの構成。 現時点では、aks-istio-ingressgateway-external という名前の外部イングレス ゲートウェイと、aks-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 ゲートウェイのプロファイル。
ManagedClusterNodeResourceGroupProfile	マネージド クラスターのノード リソース グループのロックダウン プロファイル。
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	Image Cleaner は、ノードから未使用のイメージを削除し、ディスク領域を解放し、攻撃対象領域を減らすのに役立ちます。 セキュリティ プロファイルの設定を次に示します。
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 (垂直ポッド オートスケーラー) 設定。
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 の場合は Windows 2019、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 リソースへの参照。
RestrictionLevel	クラスターのノード リソース グループに適用される制限レベル。 指定しない場合、既定値は 'Unrestricted' です
ScaleDownMode	VM をエージェント プールに追加またはエージェント プールから削除する方法について説明します。 課金状態 を参照してください。
ScaleSetEvictionPolicy	仮想マシン スケール セットの削除ポリシー。
ScaleSetPriority	仮想マシン スケール セットの優先順位。
ServiceMeshMode	サービス メッシュのモード。
ServiceMeshProfile	マネージド クラスターのサービス メッシュ プロファイル。
SysctlConfig	Linux エージェント ノードの Sysctl 設定。
systemData	リソースの作成と最後の変更に関連するメタデータ。
upgradeChannel	自動アップグレードのアップグレード チャネル。 既定値は 'none' です。
UpgradeOverrideSettings	クラスターをアップグレードするときのオーバーライドの設定。
UserAssignedIdentities	マネージド クラスターに関連付けられているユーザー ID。 この ID はコントロール プレーンで使用されます。 許可されるユーザー割り当て ID は 1 つだけです。
UserAssignedIdentity	ユーザー割り当て ID の詳細。
WindowsGmsaProfile	マネージド クラスター内の Windows gMSA プロファイル。
WorkloadRuntime	ノードが実行できるワークロードの種類を決定します。

AdvancedNetworking

クラスターで可観測性とセキュリティ機能スイートを有効にするための高度なネットワーク プロファイル。 詳細については、aka.ms/aksadvancednetworking を参照してください。

名前	型	説明
enabled	boolean	AKS クラスターでの監視とセキュリティの高度なネットワーク機能の有効化を示します。 これを true に設定すると、明示的に無効にしない限り、すべての監視機能とセキュリティ機能が有効に設定されます。 指定しない場合、既定値は false です。
observability	AdvancedNetworkingObservability	履歴コンテキストを使用して高度なネットワーク メトリックとフロー ログを有効にする可観測性プロファイル。
security	AdvancedNetworkingSecurity	cilium ベースのクラスターでセキュリティ機能を有効にするセキュリティ プロファイル。

AdvancedNetworkingObservability

履歴コンテキストを使用して高度なネットワーク メトリックとフロー ログを有効にする可観測性プロファイル。

名前	型	説明
enabled	boolean	クラスターでの高度なネットワーク監視機能の有効化を示します。

AdvancedNetworkingSecurity

cilium ベースのクラスターでセキュリティ機能を有効にするセキュリティ プロファイル。

名前	型	説明
enabled	boolean	この機能により、ユーザーは DNS (FQDN) 名に基づいてネットワーク ポリシーを構成できます。 これは、cilium ベースのクラスターでのみ有効にすることができます。 指定しない場合、既定値は false です。

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 タグ。

AgentPoolSecurityProfile

エージェント プールのセキュリティ設定。

名前	型	説明
enableSecureBoot	boolean	セキュア ブートは、署名されたオペレーティング システムとドライバーのみが起動できるようにする、トラステッド起動の機能です。 詳細については、aka.ms/aks/trustedlaunch を参照してください。 指定しない場合、既定値は false です。
enableVTPM	boolean	vTPM は、ノード上でローカルに保持されているキーと測定用に専用のセキュリティで保護されたコンテナーを構成するための信頼できる起動機能です。 詳細については、aka.ms/aks/trustedlaunch を参照してください。 指定しない場合、既定値は false です。

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' です
daemonset-eviction-for-empty-nodes	boolean	DaemonSet ポッドは空のノードから正常に終了されます true に設定すると、ノードを削除する前に、空のノード上のすべてのデーモンセット ポッドが削除されます。 デーモンセット ポッドを削除できない場合は、スケーリングのために別のノードが選択されます。 false に設定すると、デーモンセット ポッドが確実に削除または削除されることなく、ノードが削除されます。
daemonset-eviction-for-occupied-nodes	boolean	DaemonSet ポッドは空でないノードから正常に終了します true に設定すると、占有ノード上のすべてのデーモンセット ポッドは、ノードを削除する前に削除されます。 デーモンセット ポッドを削除できない場合は、スケーリングのために別のノードが選択されます。 false に設定すると、デーモンセット ポッドが確実に削除または削除されることなく、ノードが削除されます。
expander	expander	スケールアップ時に使用するエキスパンダー 指定しない場合、既定値は 'random' です。 詳細については、エキスパンダーの を参照してください。
ignore-daemonsets-utilization	boolean	スケールダウンのためのリソース使用率を計算するときに、CA が DaemonSet ポッドを無視する必要がある true に設定すると、スケールダウンの決定を行うときにデーモンセットによって使用されるリソースが考慮されます。
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 の種類。

名前	型	説明
NodeIP	string	マネージド受信ロード バランサー BackendPool の種類。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend.
NodeIPConfiguration	string	マネージド受信ロード バランサー BackendPool の種類。 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

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

名前	型	規定値	説明
advancedNetworking	AdvancedNetworking		クラスターで可観測性とセキュリティ機能スイートを有効にするための高度なネットワーク プロファイル。 詳細については、aka.ms/aksadvancednetworking を参照してください。
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		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 ファミリ (IPv4/IPv6) に 1 つ) が必要です。
serviceCidr	string	10.0.0.0/16	サービス クラスター IP を割り当てる CIDR 表記 IP 範囲。 サブネット IP 範囲と重複しないようにする必要があります。
serviceCidrs	string[]		サービス クラスター IP の割り当て元となる CIDR 表記 IP 範囲。 単一スタック ネットワークでは、1 つの IPv4 CIDR が必要です。 デュアルスタック ネットワークでは、2 つの CIDR (各 IP ファミリ (IPv4/IPv6) に 1 つ) が必要です。 サブネット 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 Certificate Authority (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-external という名前の外部イングレス ゲートウェイと、aks-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 クォータ期間の値。 既定値は '100 ミリ秒' です。 有効な値は、省略可能な分数と単位サフィックスを持つ 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	透過的な hugepages が有効になっているかどうか。 有効な値は、'always'、'madvise'、および 'never' です。 既定値は "always" です。 詳細については、「Transparent Hugepages」を参照してください。

loadBalancerSku

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

名前	型	説明
basic	string	機能が制限された基本的なロード バランサーを使用します。
standard	string	標準のロード バランサーを使用します。 これが推奨される Load Balancer SKU です。 マネージド クラスターでのロード バランサーの操作の詳細については、標準の Load Balancer に関する記事を参照してください。

ManagedCluster

マネージド クラスター。

名前	型	説明
eTag	string	オプティミスティック コンカレンシーを実装するために使用される一意の読み取り専用文字列。 リソースが更新されると、eTag 値が変更されます。 通常の etag 規則に従ってオプティミスティック コンカレンシーを有効にするには、後続の要求の eTag 値を持つ if-match ヘッダーまたは if-none-match ヘッダーを指定します。
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 アクセス制御を有効にするかどうかを指定します。
properties.fqdn	string	マスター プールの FQDN。
properties.fqdnSubdomain	string	カスタム プライベート DNS ゾーンを持つプライベート クラスターの FQDN サブドメイン。 これは、マネージド クラスターが作成された後は更新できません。
properties.httpProxyConfig	ManagedClusterHTTPProxyConfig	HTTP プロキシ サーバーを使用してクラスターをプロビジョニングするための構成。
properties.identityProfile	<string,  UserAssignedIdentity>	マネージド クラスターに関連付けられているユーザー ID。 この ID は kubelet によって使用されます。 許可されるユーザー割り当て ID は 1 つだけです。 受け入れられる唯一のキーは "kubeletidentity" で、値は "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" です。
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.nodeResourceGroupProfile	ManagedClusterNodeResourceGroupProfile	ノード リソース グループ構成のプロファイル。
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		仮想マシンの予約グループから仮想マシンを提供する容量予約グループの完全修飾リソース 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> バージョン全体 <含まれます。
eTag	string		オプティミスティック コンカレンシーを実装するために使用される一意の読み取り専用文字列。 リソースが更新されると、eTag 値が変更されます。 通常の etag 規則に従ってオプティミスティック コンカレンシーを有効にするには、後続の要求の eTag 値を持つ if-match ヘッダーまたは if-none-match ヘッダーを指定します。
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 の場合は Windows 2019、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' です。
securityProfile	AgentPoolSecurityProfile		エージェント プールのセキュリティ設定。
spotMaxPrice	number	-1	スポット インスタンスに対して支払う最大価格 (米ドル)。 使用できる値は、0 より大きい任意の 10 進値、または既定の価格がオンデマンドで up-to されることを示す -1 です。 指定できる値は、0 より大きい任意の 10 進値またはオンデマンド価格を支払う意欲を示す -1 です。 スポット価格の詳細については、スポット 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 ゾーン モード。 既定値は System です。 詳細については、プライベート 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	コスト分析を有効にするかどうか この機能を有効にするには、Managed Cluster sku.tier を 'Standard' または 'Premium' に設定する必要があります。 これを有効にすると、Azure portal の Cost Analysis ビューに Kubernetes 名前空間とデプロイの詳細が追加されます。 指定しない場合、既定値は 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 の種類。
effectiveOutboundIPs	ResourceReference[]		クラスター ロード バランサーの有効な送信 IP リソース。
enableMultipleStandardLoadBalancers	boolean		AKS クラスターごとに複数の Standard ロード バランサーを有効にするかどうか。
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 リソースのプロファイル。

ManagedClusterNodeResourceGroupProfile

マネージド クラスターのノード リソース グループのロックダウン プロファイル。

名前	型	説明
restrictionLevel	RestrictionLevel	クラスターのノード リソース グループに適用される制限レベル。 指定しない場合、既定値は 'Unrestricted' です

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 の実行を許可するかどうか。 AAD ポッド ID のセキュリティ関連の性質と IP スプーフィングのリスクにより、Kubenet での実行は既定で無効になっています。 詳細については、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

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

名前	型	説明
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 ノードが含まれます。 可用性ゾーンを使用するクラスターに対する 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 (垂直ポッド オートスケーラー) 設定。

ManagedClusterWorkloadAutoScalerProfileKeda

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

名前	型	説明
enabled	boolean	KEDA を有効にするかどうか。

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

ワークロード 自動スケーラー プロファイルの VPA (垂直ポッド オートスケーラー) 設定。

名前	型	規定値	説明
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 ネットワーク データプレーンを使用します。 詳細については、Cilium を使用した Azure CNI の に関するページを参照してください。

networkMode

Azure CNI が構成されているネットワーク モード。

名前	型	説明
bridge	string	これはサポートされなくなりました
transparent	string	ブリッジは作成されません。 ポッド間の通信 Intra-VM は、Azure CNI によって作成された IP ルートを介して行われます。 詳細については、「透過モードの」を参照してください。

NetworkPlugin

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

名前	型	説明
azure	string	Azure CNI ネットワーク プラグインを使用します。 詳細については、Azure CNI (高度な) ネットワーク の を参照してください。
kubenet	string	Kubenet ネットワーク プラグインを使用します。 詳細については、Kubenet (基本) ネットワーク の を参照してください。
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' である必要があります。
none	string	ネットワーク ポリシーは適用されません。 これは、NetworkPolicy が指定されていない場合の既定値です。

nodeOSUpgradeChannel

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

名前	型	説明
NodeImage	string	AKS は、毎週のセキュリティ修正とバグ修正を含む新しくパッチが適用された VHD でノードを更新します。 VHD 更新プログラム のマシンは、メンテナンス期間とサージ設定に従って、その VHD に再イメージ化されます。 AKS でイメージがホストされるため、このオプションを選択しても、追加の VHD コストは発生しません。
None	string	OS によって、または VHD をローリングすることによって、マシン OS を更新する試みは行われません。 つまり、セキュリティ更新プログラムの責任はユーザーが負います。
SecurityPatch	string	AKS は、テスト済みのセキュリティ更新プログラムを使用してノードをダウンロードして更新します。 これらの更新プログラムでは、メンテナンス期間の設定が適用され、新しいノードで使用される新しい VHD が生成されます。 場合によっては、更新プログラムを適用できない場合があります。このような場合、変更を適用するために、既存のノードも新しく生成された VHD に再イメージ化されます。 このオプションでは、リソース グループで新しいセキュリティ パッチ VHD をホストするコストが、ジャスト イン タイムで発生します。
Unmanaged	string	OS の更新プログラムは、OS 組み込みの修正プログラム適用インフラストラクチャを通じて自動的に適用されます。 新しくスケールインされたマシンは、最初はパッチが適用されず、OS のインフラストラクチャによってある時点で修正プログラムが適用されます。 このオプションの動作は、対象の OS によって異なります。 Ubuntu と Mariner は、1 日に約 1 回、UTC の 6:00 頃に無人アップグレードを通じてセキュリティ パッチを適用します。 Windows ではセキュリティ パッチが自動的に適用されないため、このオプションはそれ以降の通知まで None に相当します

OSDiskType

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

名前	型	説明
Ephemeral	string	エフェメラル OS ディスクは、一時ディスクと同様に、ホスト コンピューターにのみ格納されます。 これにより、読み取り/書き込みの待機時間が短くなり、ノードのスケーリングとクラスターのアップグレードが高速化されます。
Managed	string	AZURE は、VM を別のホストに再配置する必要がある場合にデータ損失を回避するために、仮想マシンのオペレーティング システム ディスクを Azure Storage にレプリケートします。 コンテナーはローカル状態を保持するように設計されていないため、この動作では値が制限されますが、ノードのプロビジョニング速度の低下や読み取り/書き込みの待機時間の長さなど、いくつかの欠点があります。

OSSKU

エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は Ubuntu です。 既定値は、Kubernetes <= 1.24 の場合は Windows 2019、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 コンテナーのみがサポートされます。Windows 2022 コンテナーを実行することはできません。その逆も同様です。
Windows2022	string	ノード イメージの OS として Windows2022 を使用します。 システム ノード プールではサポートされていません。 Windows2022 では、Windows2022 コンテナーのみがサポートされます。Windows 2019 コンテナーを実行することはできません。その逆も同様です。

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 サービスがサポートされます。 詳細については、アウトバウンド・タイプのロードバランサーを参照してください。
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。

RestrictionLevel

クラスターのノード リソース グループに適用される制限レベル。 指定しない場合、既定値は 'Unrestricted' です

名前	型	説明
ReadOnly	string	マネージド ノード リソース グループで許可されている */read RBAC アクセス許可のみ
Unrestricted	string	すべての RBAC アクセス許可は、マネージド ノード リソース グループで許可されます

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 の種類。

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	サポートされている最新のマイナー バージョンで、クラスターをサポートされている最新のパッチ リリースに自動的にアップグレードします。 クラスターが N-2 マイナー バージョンである Kubernetes のバージョンで、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 プロバイダー (プレビュー) を使用して WASM ワークロードを実行するために、クルースレットを使用します。