Stop-AzAksCluster

これは、Azure 仮想マシン スケール セットに基づくクラスターでのみ実行できます。 クラスターを停止すると、すべてのオブジェクトとクラスターの状態が保持メイン、コントロール プレーンとエージェント ノードが完全に停止します。 クラスターが停止している間は、料金は発生しません。 クラスターの停止の詳細については 、クラスター の停止を参照してください。

構文

Stop-AzAksCluster
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
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

コマンドをジョブとして実行する

Type:SwitchParameter
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

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

ID パラメーターを構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

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

-Name

マネージド クラスター リソースの名前。

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

-NoWait

コマンドを非同期的に実行する

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

-PassThru

コマンドが成功したときに true を返します。

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

-ResourceGroupName

リソース グループの名前。 名前の大文字と小文字は区別されます。

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

-SubscriptionId

ターゲット サブスクリプションの ID。

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
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

入力

IAksIdentity

出力

Boolean

メモ

別名

複合パラメーターのプロパティ

以下で説明するパラメーターを作成するには、適切なプロパティを含むハッシュ テーブルを作成します。 ハッシュ テーブルの詳細については、Get-Help about_Hash_Tablesを実行します。

INPUTOBJECT <IAksIdentity>: IDENTITY パラメーター

  • [AgentPoolName <String>]: エージェント プールの名前。
  • [CommandId <String>]: コマンドの ID。
  • [ConfigName <String>]: メインテナント構成の名前。
  • [Id <String>]: リソース ID パス
  • [Location <String>]: Azure リージョンの名前。
  • [PrivateEndpointConnectionName <String>]: プライベート エンドポイント接続の名前。
  • [ResourceGroupName <String>]: リソース グループの名前。 名前の大文字と小文字は区別されます。
  • [ResourceName <String>]: マネージド クラスター リソースの名前。
  • [RoleName <String>]: マネージド クラスター accessProfile リソースのロールの名前。
  • [SubscriptionId <String>]: ターゲット サブスクリプションの ID。