Start-Sleep
指定された期間、スクリプトまたはセッションでアクティビティを中断します。
構文
Seconds (既定)
Start-Sleep
[-Seconds] <Double>
[<CommonParameters>]
Milliseconds
Start-Sleep
-Milliseconds <Int32>
[<CommonParameters>]
FromTimeSpan
Start-Sleep
-Duration <TimeSpan>
[<CommonParameters>]
説明
Start-Sleep
コマンドレットは、指定した期間、スクリプトまたはセッションのアクティビティを中断します。 操作の完了を待機したり、操作を繰り返す前に一時停止したりするなど、多くのタスクに使用できます。
例
例 1: 実行を 1.5 秒間一時停止する
この例では、コマンドの実行が 1 秒半一時停止します。
Start-Sleep -Seconds 1.5
例 2: コマンド ラインで実行を一時停止する
この例は、コマンド ラインから実行すると、実行が 5 秒間一時停止されることを示しています。
PS> Get-Date; Start-Sleep -Seconds 5; Get-Date
Friday, May 13, 2022 9:38:15 AM
Friday, May 13, 2022 9:38:20 AM
PowerShell は、スリープ タイマーの有効期限が切れるまで、2 番目の Get-Date
コマンドを実行できません。
例 3: **TimeSpan** を使用するスリープ コマンド
この例では、セッション内のすべてのコマンドを 30 秒間スリープ状態にします。
Start-Sleep -Duration (New-TimeSpan -Seconds 30)
パラメーター
-Duration
TimeSpan オブジェクトを使用して、リソースのスリープ時間をミリ秒単位で指定します。 この値を負の TimeSpan 値にすることはできません。また、[int]::MaxValue
ミリ秒を超える値にすることはできません。
このパラメーターは PowerShell 7.3 で追加されました。
パラメーターのプロパティ
型: | TimeSpan |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | ts |
パラメーター セット
FromTimeSpan
配置: | Named |
必須: | True |
パイプラインからの値: | True |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-Milliseconds
リソースのスリープ時間をミリ秒単位で指定します。 このパラメーターは、mと省略できます。
パラメーターのプロパティ
型: | Int32 |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | ms |
パラメーター セット
Milliseconds
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-Seconds
リソースのスリープ時間を秒単位で指定します。 パラメーター名は省略することも、
パラメーターのプロパティ
型: | Double |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
Seconds
配置: | 0 |
必須: | True |
パイプラインからの値: | True |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
Int32
このコマンドレットには、秒数をパイプ処理できます。
出力
None
このコマンドレットは出力を返しません。
メモ
PowerShell には、Start-Sleep
の次のエイリアスが含まれています。
ウィンドウズ:
sleep
Ctrl+C
キーを押すと、Start-Sleep
状態が終了します。Ctrl+C
は[Threading.Thread]::Sleep
から抜け出しません。 詳細については、「Thread.Sleep メソッドの」を参照してください。