ManagedCluster interface

パッケージ:

@azure/arm-containerservice

マネージドクラスター。

Extends

TrackedResource

プロパティ

aadProfile	Azure Active Directory の構成。
addonProfiles	マネージド クラスター アドオンのプロファイル。
agentPoolProfiles	エージェント プールのプロパティ。
aiToolchainOperatorProfile	クラスター全体に適用される AI ツールチェーン演算子の設定。
apiServerAccessProfile	マネージド クラスター API サーバーのアクセス プロファイル。
autoScalerProfile	有効な場合にクラスター オートスケーラーに適用されるパラメーター
autoUpgradeProfile	自動アップグレードの構成。
azureMonitorProfile	マネージド クラスターを監視するための Azure Monitor アドオン プロファイル。
azurePortalFqdn	マネージド クラスターにアクセスするために Azure Portal によって使用される特別な FQDN。 この FQDN は Azure Portal でのみ使用されるため、他のクライアントでは使用しないでください。 Azure Portal では、一部の応答で特定のクロスオリジン リソース共有 (CORS) ヘッダーを送信する必要があります。このヘッダーは、Kubernetes APIServer では既定では処理されません。 この特殊な FQDN は CORS をサポートし、Azure Portal が正常に機能できるようにします。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
bootstrapProfile	クラスター ブートストラップ構成のプロファイル。
currentKubernetesVersion	マネージド クラスターが実行されている Kubernetes のバージョン。 kubernetesVersion が major.minor.patch<>完全に指定されたバージョンであった場合、このフィールドは完全に同じになります。 kubernetesVersion が major.minor<>されていた場合、このフィールドには、使用されている major.minor.patch< バージョン >完全なバージョンが含まれます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
disableLocalAccounts	マネージド クラスターでローカル アカウントを無効にする必要がある場合。 true に設定すると、このクラスターで静的資格情報の取得が無効になります。 これは、AAD が有効になっているマネージド クラスターでのみ使用する必要があります。 詳細については、ローカル アカウントを無効にする を参照してください。
diskEncryptionSetID	保存時の暗号化を有効にするために使用するディスク暗号化セットのリソース ID。 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}" の形式です。
dnsPrefix	マネージド クラスターの DNS プレフィックス。 これは、マネージド クラスターが作成された後は更新できません。
enableRbac	Kubernetes Role-Based アクセス制御を有効にするかどうかを指定します。
eTag	オプティミスティック コンカレンシーを実装するために使用される一意の読み取り専用文字列。 リソースが更新されると、eTag 値が変更されます。 後続のリクエストの eTag 値を含む if-match または if-none-match ヘッダーを指定して、通常の eTag 規則に従ってオプティミスティック同時実行を有効にします。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
extendedLocation	仮想マシンの拡張された場所。
fqdn	マスター プールの FQDN。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
fqdnSubdomain	カスタム プライベート DNS ゾーンを持つプライベート クラスターの FQDN サブドメイン。 これは、マネージド クラスターが作成された後は更新できません。
httpProxyConfig	HTTP プロキシ サーバーを使用してクラスターをプロビジョニングするための構成。
identity	マネージド クラスターの ID (構成されている場合)。
identityProfile	マネージド クラスターに関連付けられているユーザー ID。 この ID は kubelet によって使用されます。 許可されるユーザー割り当て ID は 1 つだけです。 受け入れられる唯一のキーは "kubeletidentity" で、値は "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" です。
ingressProfile	マネージド クラスターのイングレス プロファイル。
kind	これは主に、さまざまな種類のポータルでさまざまな UI エクスペリエンスを公開するために使用されます
kubernetesVersion	ユーザーによって指定された 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 クラスター のアップグレード を参照してください。
linuxProfile	マネージド クラスター内の Linux VM のプロファイル。
maxAgentPools	マネージド クラスターのエージェント プールの最大数。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
metricsProfile	オプションのクラスター メトリック構成。
networkProfile	ネットワーク構成プロファイル。
nodeProvisioningProfile	クラスター全体に適用されるノード プロビジョニング設定。
nodeResourceGroup	エージェント プール ノードを含むリソース グループの名前。
nodeResourceGroupProfile	ノード リソース グループ構成のプロファイル。
oidcIssuerProfile	マネージド クラスターの OIDC 発行者プロファイル。
podIdentityProfile	マネージド クラスターのポッド ID プロファイル。 AAD ポッド ID の統合 詳細については、AAD ポッド ID の使用に関するページを参照してください。
powerState	クラスターの電源状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
privateFqdn	プライベート クラスターの FQDN。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
privateLinkResources	クラスターに関連付けられているプライベート リンク リソース。
provisioningState	現在のプロビジョニング状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
publicNetworkAccess	managedCluster の PublicNetworkAccess です。 AKS のパブリック ネットワーク アクセスを許可または拒否する
resourceUID	resourceUID は、ARM ResourceId を再利用する ManagedCluster を一意に識別します (作成、削除、シーケンスの作成など)。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
securityProfile	マネージド クラスターのセキュリティ プロファイル。
serviceMeshProfile	マネージド クラスターのサービス メッシュ プロファイル。
servicePrincipalProfile	Azure API の操作に使用するクラスターのサービス プリンシパル ID に関する情報。
sku	マネージド クラスター SKU。
status	マネージド クラスターに関する読み取り専用情報が含まれています。
storageProfile	マネージド クラスターのストレージ プロファイル。
supportPlan	マネージド クラスターのサポート プラン。 指定しない場合、既定値は 'KubernetesOfficial' です。
upgradeSettings	クラスターをアップグレードするための設定。
windowsProfile	マネージド クラスター内の Windows VM のプロファイル。
workloadAutoScalerProfile	マネージド クラスターのワークロード 自動スケーラー プロファイル。

継承されたプロパティ

id	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
location	リソースが存在する地理的な場所
name	リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
tags	リソース タグ。
type	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

aadProfile

Azure Active Directory の構成。

aadProfile?: ManagedClusterAADProfile

プロパティ値

ManagedClusterAADProfile

addonProfiles

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

addonProfiles?: {[propertyName: string]: ManagedClusterAddonProfile}

プロパティ値

{[propertyName: string]: ManagedClusterAddonProfile}

agentPoolProfiles

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

agentPoolProfiles?: ManagedClusterAgentPoolProfile[]

プロパティ値

ManagedClusterAgentPoolProfile[]

aiToolchainOperatorProfile

クラスター全体に適用される AI ツールチェーン演算子の設定。

aiToolchainOperatorProfile?: ManagedClusterAIToolchainOperatorProfile

プロパティ値

ManagedClusterAIToolchainOperatorProfile

apiServerAccessProfile

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

apiServerAccessProfile?: ManagedClusterAPIServerAccessProfile

プロパティ値

ManagedClusterAPIServerAccessProfile

autoScalerProfile

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

autoScalerProfile?: ManagedClusterPropertiesAutoScalerProfile

プロパティ値

ManagedClusterPropertiesAutoScalerProfile

autoUpgradeProfile

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

autoUpgradeProfile?: ManagedClusterAutoUpgradeProfile

プロパティ値

ManagedClusterAutoUpgradeProfile

azureMonitorProfile

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

azureMonitorProfile?: ManagedClusterAzureMonitorProfile

プロパティ値

ManagedClusterAzureMonitorProfile

azurePortalFqdn

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

azurePortalFqdn?: string

プロパティ値

string

bootstrapProfile

クラスター ブートストラップ構成のプロファイル。

bootstrapProfile?: ManagedClusterBootstrapProfile

プロパティ値

ManagedClusterBootstrapProfile

currentKubernetesVersion

マネージド クラスターが実行されている Kubernetes のバージョン。 kubernetesVersion が major.minor.patch<>完全に指定されたバージョンであった場合、このフィールドは完全に同じになります。 kubernetesVersion が major.minor<>されていた場合、このフィールドには、使用されている major.minor.patch< バージョン >完全なバージョンが含まれます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

currentKubernetesVersion?: string

プロパティ値

string

disableLocalAccounts

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

disableLocalAccounts?: boolean

プロパティ値

boolean

diskEncryptionSetID

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

diskEncryptionSetID?: string

プロパティ値

string

dnsPrefix

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

dnsPrefix?: string

プロパティ値

string

enableRbac

Kubernetes Role-Based アクセス制御を有効にするかどうかを指定します。

enableRbac?: boolean

プロパティ値

boolean

eTag

オプティミスティック コンカレンシーを実装するために使用される一意の読み取り専用文字列。 リソースが更新されると、eTag 値が変更されます。 後続のリクエストの eTag 値を含む if-match または if-none-match ヘッダーを指定して、通常の eTag 規則に従ってオプティミスティック同時実行を有効にします。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

eTag?: string

プロパティ値

string

extendedLocation

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

extendedLocation?: ExtendedLocation

プロパティ値

ExtendedLocation

fqdn

マスター プールの FQDN。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

fqdn?: string

プロパティ値

string

fqdnSubdomain

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

fqdnSubdomain?: string

プロパティ値

string

httpProxyConfig

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

httpProxyConfig?: ManagedClusterHttpProxyConfig

プロパティ値

ManagedClusterHttpProxyConfig

identity

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

identity?: ManagedClusterIdentity

プロパティ値

ManagedClusterIdentity

identityProfile

マネージド クラスターに関連付けられているユーザー ID。 この ID は kubelet によって使用されます。 許可されるユーザー割り当て ID は 1 つだけです。 受け入れられる唯一のキーは "kubeletidentity" で、値は "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" です。

identityProfile?: {[propertyName: string]: UserAssignedIdentity}

プロパティ値

{[propertyName: string]: UserAssignedIdentity}

ingressProfile

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

ingressProfile?: ManagedClusterIngressProfile

プロパティ値

ManagedClusterIngressProfile

kind

これは主に、さまざまな種類のポータルでさまざまな UI エクスペリエンスを公開するために使用されます

kind?: string

プロパティ値

string

kubernetesVersion

ユーザーによって指定された 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 クラスター のアップグレード を参照してください。

kubernetesVersion?: string

プロパティ値

string

linuxProfile

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

linuxProfile?: ContainerServiceLinuxProfile

プロパティ値

ContainerServiceLinuxProfile

maxAgentPools

マネージド クラスターのエージェント プールの最大数。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

maxAgentPools?: number

プロパティ値

number

metricsProfile

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

metricsProfile?: ManagedClusterMetricsProfile

プロパティ値

ManagedClusterMetricsProfile

networkProfile

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

networkProfile?: ContainerServiceNetworkProfile

プロパティ値

ContainerServiceNetworkProfile

nodeProvisioningProfile

クラスター全体に適用されるノード プロビジョニング設定。

nodeProvisioningProfile?: ManagedClusterNodeProvisioningProfile

プロパティ値

ManagedClusterNodeProvisioningProfile

nodeResourceGroup

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

nodeResourceGroup?: string

プロパティ値

string

nodeResourceGroupProfile

ノード リソース グループ構成のプロファイル。

nodeResourceGroupProfile?: ManagedClusterNodeResourceGroupProfile

プロパティ値

ManagedClusterNodeResourceGroupProfile

oidcIssuerProfile

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

oidcIssuerProfile?: ManagedClusterOidcIssuerProfile

プロパティ値

ManagedClusterOidcIssuerProfile

podIdentityProfile

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

podIdentityProfile?: ManagedClusterPodIdentityProfile

プロパティ値

ManagedClusterPodIdentityProfile

powerState

クラスターの電源状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

powerState?: PowerState

プロパティ値

PowerState

privateFqdn

プライベート クラスターの FQDN。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

privateFqdn?: string

プロパティ値

string

privateLinkResources

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

privateLinkResources?: PrivateLinkResource[]

プロパティ値

PrivateLinkResource[]

provisioningState

現在のプロビジョニング状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningState?: string

プロパティ値

string

publicNetworkAccess

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

publicNetworkAccess?: string

プロパティ値

string

resourceUID

resourceUID は、ARM ResourceId を再利用する ManagedCluster を一意に識別します (作成、削除、シーケンスの作成など)。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

resourceUID?: string

プロパティ値

string

securityProfile

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

securityProfile?: ManagedClusterSecurityProfile

プロパティ値

ManagedClusterSecurityProfile

serviceMeshProfile

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

serviceMeshProfile?: ServiceMeshProfile

プロパティ値

ServiceMeshProfile

servicePrincipalProfile

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

servicePrincipalProfile?: ManagedClusterServicePrincipalProfile

プロパティ値

ManagedClusterServicePrincipalProfile

sku

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

sku?: ManagedClusterSKU

プロパティ値

ManagedClusterSKU

status

マネージド クラスターに関する読み取り専用情報が含まれています。

status?: ManagedClusterStatus

プロパティ値

ManagedClusterStatus

storageProfile

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

storageProfile?: ManagedClusterStorageProfile

プロパティ値

ManagedClusterStorageProfile

supportPlan

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

supportPlan?: string

プロパティ値

string

upgradeSettings

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

upgradeSettings?: ClusterUpgradeSettings

プロパティ値

ClusterUpgradeSettings

windowsProfile

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

windowsProfile?: ManagedClusterWindowsProfile

プロパティ値

ManagedClusterWindowsProfile

workloadAutoScalerProfile

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

workloadAutoScalerProfile?: ManagedClusterWorkloadAutoScalerProfile

プロパティ値

ManagedClusterWorkloadAutoScalerProfile

継承されたプロパティの詳細

id

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

継承元TrackedResource.id

location

リソースが存在する地理的な場所

location: string

プロパティ値

string

継承元TrackedResource.location

name

リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

継承元TrackedResource.name

systemData

createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

systemData?: SystemData

プロパティ値

SystemData

trackedResource.systemData から継承

tags

リソース タグ。

tags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

継承元TrackedResource.tags

type

リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

継承元TrackedResource.type