Set-SmaSchedule
SMA でスケジュールを作成または変更します。
構文
Set-SmaSchedule
-Name <String>
[-Description <String>]
-ScheduleType <String>
-StartTime <DateTime>
-ExpiryTime <DateTime>
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Set-SmaSchedule コマンドレットは、Service Management Automation (SMA) でスケジュールを作成または変更します。 スケジュールの名前と種類、開始時刻と終了時刻を指定します。
既存のスケジュールに対してこのコマンドレットを実行する場合は、説明のみを変更できます。 開始時刻、有効期限、および日間隔は、このコマンドレットを使用してスケジュールを作成するときにのみ設定できます。
例
例 1: スケジュールを作成する
PS C:\> $StartDate = Get-Date
PS C:\> $EndDate = Get-Date -Day 12 -Month 6 -Year 2023
PS C:\> Set-SmaSchedule -StartTime $StartDate -ExpiryTime $EndDate -Name "Schedule01" -ScheduleType "DailySchedule" -WebServiceEndpoint "https://contoso.com/app01"最初のコマンドは 、Get-Date コマンドレットを使用して日付オブジェクトを作成し、そのオブジェクトを $StartDate 変数に格納します。 このオブジェクトは現在の時刻を反映します。
2 番目のコマンドは 、Get-Date コマンドレットを使用して日付オブジェクトを作成し、そのオブジェクトを $EndDate 変数に格納します。
コマンドは、将来の時刻を指定します。
詳細を表示するには「Get-Help Get-Date」を入力します。
最後のコマンドは、Schedule01 という名前のスケジュールを、$StartDateに格納された時刻に開始し、$EndDateに格納された時刻に終了するように設定します。
パラメーター
-AuthenticationType
認証の種類を指定します。 有効な値は次のとおりです。
- Basic
- Windows
このパラメーターの既定値は Windows です。 基本認証を使用する場合は、 Credential パラメーターを使用して資格情報を指定する必要があります。
| Type: | String |
| Accepted values: | Basic, Windows |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
SMA Web サービスへの接続の PSCredential オブジェクトを指定します。
資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。
詳細を表示するには「Get-Help Get-Credential」を入力します。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
スケジュールの説明を提供します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpiryTime
DateTime オブジェクトとしてスケジュールを終了するタイミングを指定します。
DateTime オブジェクトを取得するには、Get-Date コマンドレットを使用します。
詳細を表示するには「Get-Help Get-Date」を入力します。
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
スケジュールの名前を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
SMA Web サービスのポート番号を指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScheduleType
スケジュールの種類を指定します。 このパラメーターの有効な値は次のとおりです。
- OneTimeSchedule
- DailySchedule
| Type: | String |
| Accepted values: | OneTimeSchedule, DailySchedule |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartTime
DateTime オブジェクトとしてスケジュールを開始するタイミングを指定します。 DateTime オブジェクトを取得するには、Get-Date コマンドレットを使用します。
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WebServiceEndpoint
SMA Web サービスのエンドポイントを URL として指定します。 プロトコル (http:// や https:// など) を含める必要があります。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |