Stop-AzAksCluster
これは、Azure 仮想マシン スケール セットに基づくクラスターでのみ実行できます。
クラスターを停止すると、すべてのオブジェクトとクラスターの状態を維持しながら、コントロール プレーンとエージェント ノードが完全に停止します。
クラスターが停止している間は、料金は発生しません。
クラスターの停止の詳細については、「 クラスターの停止 」を参照してください。
構文
Stop (既定)
Stop-AzAksCluster
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
StopViaIdentity
Stop-AzAksCluster
-InputObject <IAksIdentity>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
これは、Azure 仮想マシン スケール セットに基づくクラスターでのみ実行できます。
クラスターを停止すると、すべてのオブジェクトとクラスターの状態を維持しながら、コントロール プレーンとエージェント ノードが完全に停止します。
クラスターが停止している間は、料金は発生しません。
クラスターの停止の詳細については、「 クラスターの停止 」を参照してください。
例
例 1: リソース グループ名とクラスター名を使用して Aks クラスターを停止する
Stop-AzAksCluster -ResourceGroupName group -Name myCluster
リソース グループ名とクラスター名を使用して Aks クラスターを停止します。
例 2: パイプラインを使用して Aks クラスターを停止する
Get-AzAksCluster -ResourceGroupName group -Name myCluster | Stop-AzAksCluster
パイプラインを使用して Aks クラスターを停止します。
パラメーター
-AsJob
コマンドをジョブとして実行する
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
DefaultProfile パラメーターは機能しません。
別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。
パラメーターのプロパティ
| 型: | PSObject
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
IDENTITY パラメーター
StopViaIdentity
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
管理対象クラスター・リソースの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | クラスター名 |
パラメーター セット
Stop
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoWait
コマンドを非同期的に実行する
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PassThru
コマンドが成功したときに true を返します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前。
名前は大文字と小文字が区別されます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Stop
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SubscriptionId
ターゲット サブスクリプションの ID。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | (Get-AzContext).Subscription.Id |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Stop
| 配置: | 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を参照してください。
出力
