Get-SqlAgentJobSchedule
SQL エージェント ジョブのターゲット インスタンスに存在する各スケジュールのジョブ スケジュール オブジェクトを取得します。
構文
ByPath (既定)
Get-SqlAgentJobSchedule
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
ByObject
Get-SqlAgentJobSchedule
[[-Name] <String>]
[-InputObject] <Job>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
説明
Get-SqlAgentJobSchedule コマンドレットは、SQL エージェント ジョブのターゲット インスタンスに存在する各ステップの SQL JobStepSchedule オブジェクトを取得します。 ジョブ スケジュールの名前が指定されている場合、コマンドレットはこの特定の JobSchedule オブジェクトのみを取得します。
このコマンドレットでは、JobSchedule オブジェクトのコレクションを取得するための次の操作モードがサポートされています。
- 入力で SQL エージェント ジョブのインスタンスを渡します。
- ジョブ インスタンスの Path パラメーターを指定します。
- 有効なコンテキストでコマンドレットを呼び出します。
例
例 1: 指定されたサーバー インスタンス内のすべての JobSchedule オブジェクト インスタンスを取得する
PS C:\> Get-SqlAgent -ServerInstance "MyServerInstance" | Get-SqlAgentJob | Get-SqlAgentJobSchedule
Name Jobs Enabled DateCreated ActiveStartDate ActiveEndDate ID
---- ---- ------- ----------- --------------- ------------- --
Schedule1 1 False 6/2/2016 10:21:44 AM 6/14/2016 12:00:00 AM 12/31/9999 12:00:00 AM 10
Schedule2 1 True 6/9/2016 4:35:25 PM 6/9/2016 12:00:00 AM 12/31/9999 12:00:00 AM 58
Schedule3 1 True 6/9/2016 4:35:25 PM 6/9/2016 12:00:00 AM 12/31/9999 12:00:00 AM 59
このコマンドは、パイプラインによって渡されたジョブ インスタンス内のすべての JobSchedule オブジェクト インスタンスを取得します。
例 2: 指定されたサーバー インスタンス内の JobSchedule オブジェクト インスタンスを取得する
PS C:\> Get-SqlAgentJob -ServerInstance "MyServer" | Get-SqlAgentJobSchedule -Name "Schedule1"
このコマンドは、パイプラインによって渡されたジョブ インスタンスから、'Schedule1' という名前の JobSchedule オブジェクト インスタンスを取得します。
パラメーター
-AccessToken
ユーザー/パスワードまたは Windows 認証の代わりに、SQL Server に対する認証に使用されるアクセス トークン。
これは、たとえば、SQL Azure DBまたはSQL Azure Managed Instanceを使用してService Principalに接続してManaged Identityするために使用できます。
使用するパラメーターには、トークンを表す文字列、または PSAccessToken を実行して返されるGet-AzAccessToken -ResourceUrl https://database.windows.net オブジェクトのいずれかを指定できます。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
| 型: | PSObject |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Encrypt
SQL Server に接続するときに使用する暗号化の種類。
この値は、Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの Encrypt プロパティ SqlConnectionEncryptOption にマップされます。
モジュールの v22 では、既定値は Optional です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "必須" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| 指定可能な値: | Mandatory, Optional, Strict |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-HostNameInCertificate
SQL Server TLS/SSL 証明書の検証に使われるホスト名。 SQL Server インスタンスで Force Encryption が有効になっていて、ホスト名/短縮名を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっている SQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InputObject
ターゲット インスタンスの Job オブジェクトを指定します。
パラメーターのプロパティ
| 型: | Job |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByObject
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
このコマンドレットが取得する JobSchedule オブジェクトの名前を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Path
このコマンドレットが操作を実行する Job オブジェクトへのパスを指定します。 このパラメーターの値を指定しない場合、コマンドレットは現在の作業場所を使用します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByPath
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TrustServerCertificate
信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。