Get-SqlAgentJobSchedule
SQL エージェント ジョブのターゲット インスタンスに存在する各スケジュールのジョブ スケジュール オブジェクトを取得します。
構文
Get-SqlAgentJobSchedule
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
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の認証に使用されるアクセス トークン。
これは、たとえば、 または Managed Identity
に接続SQL Azure DB
して SQL Azure Managed Instance
使用するために使用Service Principal
できます。
使用するパラメーターには、 を実行Get-AzAccessToken -ResourceUrl https://database.windows.net
して返されるトークンまたはオブジェクトをPSAccessToken
表す文字列を指定できます。
このパラメーターは、モジュールの v22 の新機能です。
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Encrypt
SQL Serverに接続するときに使用する暗号化の種類。
この値は、 Encrypt
Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの プロパティ SqlConnectionEncryptOption
にマップされます。
モジュールの v22 では、既定値は Optional
(v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "必須" になります。これにより、既存のスクリプトに破壊的変更が発生する可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | String |
Accepted values: | Mandatory, Optional, Strict |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostNameInCertificate
SQL Server TLS/SSL 証明書の検証に使われるホスト名。 SQL Server インスタンスが Force Encryption に対して有効になっており、hostname/shortname を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっているSQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
ターゲット インスタンスの Job オブジェクトを指定します。
Type: | Job |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
このコマンドレットが取得する JobSchedule オブジェクトの名前を指定します。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
このコマンドレットが操作を実行する Job オブジェクトへのパスを指定します。 このパラメーターの値を指定しない場合、コマンドレットは現在の作業場所を使用します。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TrustServerCertificate
信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true
(v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに破壊的変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
Microsoft.SqlServer.Management.Smo.Agent.Job
出力
System.Object