Set-AzAksCluster

リファレンス

モジュール:: Az.Aks

マネージド Kubernetes クラスターを更新または作成します。

構文

Set-AzAksCluster
   [-NodePoolMode <String>]
   [-AcrNameToDetach <String>]
   [-NodeImageOnly]
   [-ControlPlaneOnly]
   [-AutoScalerProfile <ManagedClusterPropertiesAutoScalerProfile>]
   [-EnableUptimeSLA]
   [-EnableOidcIssuer]
   [-ResourceGroupName] <String>
   [-Name] <String>
   [[-ServicePrincipalIdAndSecret] <PSCredential>]
   [-Location <String>]
   [-LinuxProfileAdminUserName <String>]
   [-DnsNamePrefix <String>]
   [-KubernetesVersion <String>]
   [-NodeName <String>]
   [-NodeMinCount <Int32>]
   [-NodeMaxCount <Int32>]
   [-EnableNodeAutoScaling]
   [-NodeCount <Int32>]
   [-NodeOsDiskSize <Int32>]
   [-NodeVmSize <String>]
   [-NodePoolLabel <Hashtable>]
   [-NodePoolTag <Hashtable>]
   [-SshKeyValue <String>]
   [-AcrNameToAttach <String>]
   [-AsJob]
   [-Tag <Hashtable>]
   [-LoadBalancerAllocatedOutboundPort <Int32>]
   [-LoadBalancerManagedOutboundIpCount <Int32>]
   [-LoadBalancerOutboundIp <String[]>]
   [-LoadBalancerOutboundIpPrefix <String[]>]
   [-LoadBalancerIdleTimeoutInMinute <Int32>]
   [-ApiServerAccessAuthorizedIpRange <String[]>]
   [-EnableApiServerAccessPrivateCluster]
   [-ApiServerAccessPrivateDnsZone <String>]
   [-EnableApiServerAccessPrivateClusterPublicFQDN]
   [-FqdnSubdomain <String>]
   [-EnableManagedIdentity]
   [-AssignIdentity <String>]
   [-AutoUpgradeChannel <String>]
   [-DiskEncryptionSetID <String>]
   [-DisableLocalAccount]
   [-HttpProxy <String>]
   [-HttpsProxy <String>]
   [-HttpProxyConfigNoProxyEndpoint <String[]>]
   [-HttpProxyConfigTrustedCa <String>]
   [-AksCustomHeader <Hashtable>]
   [-AadProfile <ManagedClusterAADProfile>]
   [-WindowsProfileAdminUserPassword <SecureString>]
   [-EnableAHUB]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzAksCluster
   -InputObject <PSKubernetesCluster>
   [-NodePoolMode <String>]
   [-AcrNameToDetach <String>]
   [-NodeImageOnly]
   [-ControlPlaneOnly]
   [-AutoScalerProfile <ManagedClusterPropertiesAutoScalerProfile>]
   [-EnableUptimeSLA]
   [-EnableOidcIssuer]
   [-Location <String>]
   [-LinuxProfileAdminUserName <String>]
   [-DnsNamePrefix <String>]
   [-KubernetesVersion <String>]
   [-NodeName <String>]
   [-NodeMinCount <Int32>]
   [-NodeMaxCount <Int32>]
   [-EnableNodeAutoScaling]
   [-NodeCount <Int32>]
   [-NodeOsDiskSize <Int32>]
   [-NodeVmSize <String>]
   [-NodePoolLabel <Hashtable>]
   [-NodePoolTag <Hashtable>]
   [-SshKeyValue <String>]
   [-AcrNameToAttach <String>]
   [-AsJob]
   [-Tag <Hashtable>]
   [-LoadBalancerAllocatedOutboundPort <Int32>]
   [-LoadBalancerManagedOutboundIpCount <Int32>]
   [-LoadBalancerOutboundIp <String[]>]
   [-LoadBalancerOutboundIpPrefix <String[]>]
   [-LoadBalancerIdleTimeoutInMinute <Int32>]
   [-ApiServerAccessAuthorizedIpRange <String[]>]
   [-EnableApiServerAccessPrivateCluster]
   [-ApiServerAccessPrivateDnsZone <String>]
   [-EnableApiServerAccessPrivateClusterPublicFQDN]
   [-FqdnSubdomain <String>]
   [-EnableManagedIdentity]
   [-AssignIdentity <String>]
   [-AutoUpgradeChannel <String>]
   [-DiskEncryptionSetID <String>]
   [-DisableLocalAccount]
   [-HttpProxy <String>]
   [-HttpsProxy <String>]
   [-HttpProxyConfigNoProxyEndpoint <String[]>]
   [-HttpProxyConfigTrustedCa <String>]
   [-AksCustomHeader <Hashtable>]
   [-AadProfile <ManagedClusterAADProfile>]
   [-WindowsProfileAdminUserPassword <SecureString>]
   [-EnableAHUB]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzAksCluster
   [-NodePoolMode <String>]
   [-AcrNameToDetach <String>]
   [-NodeImageOnly]
   [-ControlPlaneOnly]
   [-Id] <String>
   [-AutoScalerProfile <ManagedClusterPropertiesAutoScalerProfile>]
   [-EnableUptimeSLA]
   [-EnableOidcIssuer]
   [-Location <String>]
   [-LinuxProfileAdminUserName <String>]
   [-DnsNamePrefix <String>]
   [-KubernetesVersion <String>]
   [-NodeName <String>]
   [-NodeMinCount <Int32>]
   [-NodeMaxCount <Int32>]
   [-EnableNodeAutoScaling]
   [-NodeCount <Int32>]
   [-NodeOsDiskSize <Int32>]
   [-NodeVmSize <String>]
   [-NodePoolLabel <Hashtable>]
   [-NodePoolTag <Hashtable>]
   [-SshKeyValue <String>]
   [-AcrNameToAttach <String>]
   [-AsJob]
   [-Tag <Hashtable>]
   [-LoadBalancerAllocatedOutboundPort <Int32>]
   [-LoadBalancerManagedOutboundIpCount <Int32>]
   [-LoadBalancerOutboundIp <String[]>]
   [-LoadBalancerOutboundIpPrefix <String[]>]
   [-LoadBalancerIdleTimeoutInMinute <Int32>]
   [-ApiServerAccessAuthorizedIpRange <String[]>]
   [-EnableApiServerAccessPrivateCluster]
   [-ApiServerAccessPrivateDnsZone <String>]
   [-EnableApiServerAccessPrivateClusterPublicFQDN]
   [-FqdnSubdomain <String>]
   [-EnableManagedIdentity]
   [-AssignIdentity <String>]
   [-AutoUpgradeChannel <String>]
   [-DiskEncryptionSetID <String>]
   [-DisableLocalAccount]
   [-HttpProxy <String>]
   [-HttpsProxy <String>]
   [-HttpProxyConfigNoProxyEndpoint <String[]>]
   [-HttpProxyConfigTrustedCa <String>]
   [-AksCustomHeader <Hashtable>]
   [-AadProfile <ManagedClusterAADProfile>]
   [-WindowsProfileAdminUserPassword <SecureString>]
   [-EnableAHUB]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

説明

マネージド Kubernetes クラスターを更新または作成します。

例

例 1

Get-AzAksCluster -ResourceGroupName group -Name myCluster | Set-AzAksCluster -NodeCount 5

Kubernetes クラスター内のノードの数を 5 に設定します。

AutoScalerProfile を使用して AKS クラスターを更新します。

AKS クラスターを更新するときに、クラスター全体の自動スケーラープロファイルの既定値を変更することで、クラスターオートスケーラーの詳細な詳細を構成できます。

$AutoScalerProfile=@{
    ScanInterval="40s"
    Expander="priority"
}
$AutoScalerProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedClusterPropertiesAutoScalerProfile]$AutoScalerProfile

Get-AzAksCluster -ResourceGroupName group -Name myCluster | Set-AzAksCluster -AutoScalerProfile $AutoScalerProfile

AadProfile を使用して AKS クラスターを更新します。

AKS クラスターを更新するときに、AAD プロファイルを構成できます。

$AKSAdminGroup=New-AzADGroup -DisplayName myAKSAdminGroup -MailNickname myAKSAdminGroup
$AadProfile=@{
    managed=$true
    enableAzureRBAC=$false
    adminGroupObjectIDs=[System.Collections.Generic.List[string]]@($AKSAdminGroup.Id)
}
$AadProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedClusterAADProfile]$AadProfile

Set-AzAksCluster -ResourceGroupName myResourceGroup -Name myAKSCluster -AadProfile $AadProfile

パラメーター

-AadProfile

Azure Active Directory の構成。

Type:	ManagedClusterAADProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AcrNameToAttach

指定した ACR の 'acrpull' ロールを AKS サービスプリンシパルに付与します (例: myacr)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AcrNameToDetach

名前またはリソース ID で指定された ACR への "acrpull" ロールの割り当てを無効にする (例: myacr)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AksCustomHeader

Kubernetes ネットワークの構築に使用される Aks カスタムヘッダー。

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ApiServerAccessAuthorizedIpRange

Kubernetes API サーバーへのアクセスが許可されている IP 範囲。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ApiServerAccessPrivateDnsZone

クラスターのプライベート DNS ゾーンモード。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

バックグラウンドでコマンドレットを実行する

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AssignIdentity

クラスターのユーザー割り当てマネージド ID の ResourceId。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AutoScalerProfile

クラスターオートスケーラーに適用するパラメーター。

Type:	ManagedClusterPropertiesAutoScalerProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AutoUpgradeChannel

自動アップグレードのアップグレードチャネル。詳細については、https://learn.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel をご覧ください。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ControlPlaneOnly

コントロールプレーンをターゲットバージョンにのみアップグレードします。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableLocalAccount

マネージドクラスターでは、ローカルアカウントを無効にする必要があります。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DiskEncryptionSetID

暗号化を有効にするために使用するディスク暗号化セットのリソース ID。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DnsNamePrefix

クラスターの DNS 名プレフィックス。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableAHUB

Windows VM に対して Azure ハイブリッドユーザー特典 (AHUB) を有効にするかどうかを指定します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableApiServerAccessPrivateCluster

クラスターをプライベートクラスターとして作成するかどうか。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableApiServerAccessPrivateClusterPublicFQDN

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableManagedIdentity

マネージド ID を使用してクラスターリソースグループを管理する。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableNodeAutoScaling

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableOidcIssuer

OIDC 発行者機能を適用するかどうかを指定します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableUptimeSLA

アップタイム SLA を使用するかどうか。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FqdnSubdomain

カスタムプライベート DNS ゾーンを持つプライベートクラスターの FQDN サブドメインメイン。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpProxy

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpProxyConfigNoProxyEndpoint

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpProxyConfigTrustedCa

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpsProxy

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

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

Type:	String
Aliases:	ResourceId
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

通常はパイプラインを通過する PSKubernetesCluster オブジェクト。

Type:	PSKubernetesCluster
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-KubernetesVersion

クラスターの作成に使用する Kubernetes のバージョン。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LinuxProfileAdminUserName

Linux Virtual Machines のユーザー名。

Type:	String
Aliases:	AdminUserName
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerAllocatedOutboundPort

VM ごとに割り当てられた SNAT ポートの必要な数。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerIdleTimeoutInMinute

必要な送信フローのアイドルタイムアウト (分単位)。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerManagedOutboundIpCount

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerOutboundIp

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerOutboundIpPrefix

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

クラスターの Azure の場所。既定値は、リソースグループの場所です。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Kubernetes マネージドクラスター名。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeCount

ノードプールの既定のノード数。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeImageOnly

エージェントプールのノードイメージのみをアップグレードします。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeMaxCount

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeMinCount

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeName

サブスクリプションとリソースグループのコンテキストにおけるエージェントプールプロファイルの一意の名前。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeOsDiskSize

オペレーティングシステムディスクのサイズを GB 単位で指定します。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodePoolLabel

Kubernetes ネットワークの構築に使用されるノードプールラベル。

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodePoolMode

NodePoolMode は、ノードプールのモードを表します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodePoolTag

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

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeVmSize

仮想マシンのサイズ。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

リソースグループ名。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ServicePrincipalIdAndSecret

AAD アプリケーション/サービスプリンシパルに関連付けられているクライアント ID とクライアントシークレット。

Type:	PSCredential
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SshKeyValue

SSH キーファイルの値またはキーファイルのパス。既定値は {HOME}/.ssh/id_rsa.pub です。

Type:	String
Aliases:	SshKeyPath
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

サブスクリプションの ID です。既定では、コマンドレットは現在のコンテキストで設定されているサブスクリプションで実行されます。ユーザーが別のサブスクリプションを指定した場合、現在のコマンドレットはユーザーが指定したサブスクリプションで実行されます。サブスクリプションのオーバーライドは、現在のコマンドレットのライフサイクル中にのみ有効になります。コンテキスト内のサブスクリプションは変更されず、後続のコマンドレットには影響しません。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

リソースに適用するタグ

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WindowsProfileAdminUserPassword

Windows VM に使用する管理者パスワード。パスワードの要件:少なくとも 1 つの小文字、1 つの大文字、1 つの特殊文字 !@#$%^>*()、最小 lenth は 12 です。

Type:	SecureString
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSKubernetesCluster

String

出力