Update-AzNetworkCloudAgentPool
指定された Kubernetes クラスター エージェント プールのプロパティにパッチを適用するか、Kubernetes クラスター エージェント プールに関連付けられているタグを更新します。
プロパティとタグの更新は、個別に行うことができます。
構文
UpdateExpanded (既定)
Update-AzNetworkCloudAgentPool
-KubernetesClusterName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AdministratorConfigurationSshPublicKey <ISshPublicKey[]>]
[-Count <Int64>]
[-Tag <Hashtable>]
[-UpgradeSettingDrainTimeout <Int64>]
[-UpgradeSettingMaxSurge <String>]
[-UpgradeSettingMaxUnavailable <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonString
Update-AzNetworkCloudAgentPool
-KubernetesClusterName <String>
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaJsonFilePath
Update-AzNetworkCloudAgentPool
-KubernetesClusterName <String>
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityKubernetesClusterExpanded
Update-AzNetworkCloudAgentPool
-Name <String>
-KubernetesClusterInputObject <INetworkCloudIdentity>
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AdministratorConfigurationSshPublicKey <ISshPublicKey[]>]
[-Count <Int64>]
[-Tag <Hashtable>]
[-UpgradeSettingDrainTimeout <Int64>]
[-UpgradeSettingMaxSurge <String>]
[-UpgradeSettingMaxUnavailable <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzNetworkCloudAgentPool
-InputObject <INetworkCloudIdentity>
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AdministratorConfigurationSshPublicKey <ISshPublicKey[]>]
[-Count <Int64>]
[-Tag <Hashtable>]
[-UpgradeSettingDrainTimeout <Int64>]
[-UpgradeSettingMaxSurge <String>]
[-UpgradeSettingMaxUnavailable <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
指定された Kubernetes クラスター エージェント プールのプロパティにパッチを適用するか、Kubernetes クラスター エージェント プールに関連付けられているタグを更新します。
プロパティとタグの更新は、個別に行うことができます。
例
例 1: Kubernetes クラスターのエージェント プールを更新する
Update-AzNetworkCloudAgentPool -Name agentPoolName -KubernetesClusterName clusterName -ResourceGroupName resourceGroup -Count updatedCount -Tag @{tags = "newTag"} -UpgradeSettingMaxSurge updatedMaxSurge
Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy
-------- ---- ------------------- ------------------- ----------------------- ------------------------ --
westus3 agentpool1 07/17/2023 18:14:59 <identity> Application 07/18/2023 17:06:24 <identity>
このコマンドは、Kubernetes クラスター エージェント プールのプロパティを更新します。
パラメーター
-AdministratorConfigurationSshPublicKey
SshPublicKey は、SSH 経由でリソースで認証するために使用される公開キーを表します。
パラメーターのプロパティ
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityKubernetesClusterExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AsJob
コマンドをジョブとして実行する
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Count
この構成を使用する仮想マシンの数。
パラメーターのプロパティ
| 型: | Int64
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityKubernetesClusterExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
DefaultProfile パラメーターは機能しません。
別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。
パラメーターのプロパティ
| 型: | PSObject
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IfMatch
変換の ETag。
現在のリソースを常に上書きするには、この値を省略します。
同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IfNoneMatch
新しいレコード セットの作成を許可するが、既存のリソースを更新できないようにするには、'*' に設定します。
その他の値はサポートされていないため、サーバーからエラーが発生します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
IDENTITY パラメーター
UpdateViaIdentityExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-JsonFilePath
更新操作に指定された Json ファイルのパス
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateViaJsonFilePath
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-JsonString
更新操作に指定された Json 文字列
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateViaJsonString
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
IDENTITY パラメーター
UpdateViaIdentityKubernetesClusterExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-KubernetesClusterName
Kubernetes クラスターの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaJsonString
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaJsonFilePath
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
Kubernetes クラスター エージェント プールの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AgentPoolName |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaJsonString
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaJsonFilePath
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityKubernetesClusterExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoWait
コマンドを非同期的に実行する
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前。
名前の大文字と小文字は区別されません。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaJsonString
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaJsonFilePath
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SubscriptionId
ターゲット サブスクリプションの ID。
値は UUID である必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | (Get-AzContext).Subscription.Id |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaJsonString
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaJsonFilePath
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Tag
既存のものを置き換えるAzureリソース タグ。
パラメーターのプロパティ
| 型: | Hashtable
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityKubernetesClusterExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UpgradeSettingDrainTimeout
エージェント プールのアップグレードに進む前にノードドレインが完了するまでに許容される最大時間 (秒)。
作成時に指定しない場合は、1800 秒の値が使用されます。
パラメーターのプロパティ
| 型: | Int64
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityKubernetesClusterExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UpgradeSettingMaxSurge
アップグレード中に急増したノードの最大数または割合。
これは、整数 (例: '5') またはパーセンテージ (例: '50%') に設定できます。
パーセンテージを指定すると、アップグレード時のエージェント・プール・サイズの合計に対するパーセンテージになります。
パーセンテージの場合、小数部のノードは切り上げられます。
作成時に指定しない場合は、値 1 が使用されます。
MaxSurge と MaxUnavailable の 1 つが 0 より大きい必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityKubernetesClusterExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UpgradeSettingMaxUnavailable
アップグレード中に使用できないノードの最大数または割合。
これは、整数 (例: '5') またはパーセンテージ (例: '50%') に設定できます。
パーセンテージを指定すると、アップグレード時のエージェント・プール・サイズの合計に対するパーセンテージになります。
パーセンテージの場合、小数部のノードは切り上げられます。
作成時に指定しない場合は、値 0 が使用されます。
MaxSurge と MaxUnavailable の 1 つが 0 より大きい必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityKubernetesClusterExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
