Get-SqlAgentJobHistory
SQL エージェントのターゲット インスタンスに存在するジョブ履歴を取得します。
構文
Get-SqlAgentJobHistory
[-StartRunDate <DateTime>]
[-EndRunDate <DateTime>]
[-JobID <Guid>]
[-JobName <String>]
[-MinimumRetries <Int32>]
[-MinimumRunDurationInSeconds <Int32>]
[-OldestFirst]
[-OutcomesType <CompletionResult>]
[-SqlMessageID <Int32>]
[-SqlSeverity <Int32>]
[-Since <SinceType>]
[[-Path] <String[]>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>] Get-SqlAgentJobHistory
[-StartRunDate <DateTime>]
[-EndRunDate <DateTime>]
[-JobID <Guid>]
[-JobName <String>]
[-MinimumRetries <Int32>]
[-MinimumRunDurationInSeconds <Int32>]
[-OldestFirst]
[-OutcomesType <CompletionResult>]
[-SqlMessageID <Int32>]
[-SqlSeverity <Int32>]
[-Since <SinceType>]
[[-ServerInstance] <String[]>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>] Get-SqlAgentJobHistory
[-StartRunDate <DateTime>]
[-EndRunDate <DateTime>]
[-JobID <Guid>]
[-JobName <String>]
[-MinimumRetries <Int32>]
[-MinimumRunDurationInSeconds <Int32>]
[-OldestFirst]
[-OutcomesType <CompletionResult>]
[-SqlMessageID <Int32>]
[-SqlSeverity <Int32>]
[-Since <SinceType>]
[-InputObject] <JobServer[]>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>] 説明
Get-SqlAgentJobHistory コマンドレットは、SQL エージェントのターゲット インスタンスに存在する JobHistory オブジェクトを取得します。
このコマンドレットは、JobHistory オブジェクトを取得するための次の操作モードをサポートしています。
- SQL エージェント インスタンスのパスを指定します。
- 入力で SQL エージェントのインスタンスを渡します。
- 有効なコンテキストで コマンドレットを呼び出します。
例
例 1: 指定したサーバー インスタンスからジョブ履歴全体を取得する
PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" | Format-Table
InstanceID SqlMessageID Message
---------- ------------ -------
34 0 The job succeeded. The Job was invoked by Schedule 8 (syspolicy_purge_history_schedule). T...
33 0 Executed as user: DOMAIN\Machine1$. The step did not generate any output. Process Exitこのコマンドは、MyServerInstance という名前のサーバー インスタンス内のジョブ履歴全体を取得し、出力を書式設定します。
例 2: 指定したサーバー インスタンスからジョブ履歴を取得する
PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" -JobID 187112d7-84e1-4b66-b093-e97201c441ed
JobID : 187112d7-84e1-4b66-b093-e97201c441ed
JobName : Job_73cc6990-6386-49f9-9826-96c318ad8afa
RunStatus : 3このコマンドは、'MyServerInstance' という名前のサーバー インスタンス内の ID '187112d7-84e1-4b66-b093-e97201c441ed' を持つジョブ オブジェクトのジョブ履歴を取得します。
例 3: 指定されたサーバー インスタンスから期間からジョブ履歴を取得する
PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" -Since Yesterday
InstanceID : 4
SqlMessageID : 0
Message : The job was stopped prior to completion by User admin. The Job was invoked by User
admin. The last step to run was step 1 (JobStep_3e4cd4ba-3433-4311-a6a2-816884101504).このコマンドは、'MyServerInstance' という名前のサーバー インスタンスで前日からジョブ履歴を返します。
パラメーター
-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 |
-ConnectionTimeout
タイムアウトエラーが発生するまでのサーバー接続を待機する秒数を指定します。 タイムアウト値は、0 ~ 65534 の整数値である必要があります。 0 を指定した場合、接続の試行はタイムアウトしません。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
この操作を実行する権限を持つSQL Server ログインの資格情報を指定するために使用される PSCredential オブジェクトを指定します。
| Type: | PSCredential |
| 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 |
-EndRunDate
ジョブが完了した日付に返される値を制限するジョブ フィルター制約を指定します。
| Type: | DateTime |
| 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
対象となるSQL Server エージェントを表す SQL Server 管理オブジェクト (SMO) オブジェクトの配列を指定します。
| Type: | JobServer[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JobID
ジョブ ID 値で指定されたジョブに返される値を制限するジョブ フィルター制約を指定します。
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobName
ジョブの名前で指定されたジョブに返される値を制限するジョブ フィルター制約を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MinimumRetries
失敗し、最小回数再試行されたジョブに返される値を制限するジョブ フィルター制約を指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MinimumRunDurationInSeconds
指定された最小時間で完了したジョブに返される値を秒単位で制限するジョブ フィルター制約を指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OldestFirst
このコマンドレットは、最も古い順にジョブを一覧表示することを示します。 このパラメーターを指定しない場合、コマンドレットは最新の最初の順序を使用します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutcomesType
完了時に指定した結果を持つジョブに返される値を制限するジョブ フィルター制約を指定します。
このパラメーターの有効値は、次のとおりです。
-- Failed -- Succeeded -- Retry -- Cancelled -- InProgress -- Unknown
| Type: | CompletionResult |
| Accepted values: | Failed, Succeeded, Retry, Cancelled, InProgress, Unknown |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
このコマンドレットが操作を実行するSQL Serverのエージェントへのパスを配列として指定します。 このパラメーターの値を指定しない場合、コマンドレットは現在の作業場所を使用します。
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServerInstance
SQL エージェントが実行される配列として、SQL Serverのインスタンスの名前を指定します。 既定のインスタンスの場合は、コンピューター名 MyComputer のみを指定します。 名前付きインスタンスの場合は、ComputerName\InstanceName という形式を使用します。
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Since
StartRunDate パラメーターの代わりに使用できる省略形を指定します。
EndRunDate パラメーターを使用して指定できます。
このパラメーターを使用する場合は、StartRunDate パラメーターを使用できません。
このパラメーターの有効値は、次のとおりです。
- 午前 0 時 (午前 0 時以降に生成されたすべてのジョブ履歴情報を取得します)
- 昨日 (過去 24 時間以内に生成されたすべてのジョブ履歴情報を取得します)
- LastWeek (先週に生成されたすべてのジョブ履歴情報を取得します)
- LastMonth (先月に生成されたすべてのジョブ履歴情報を取得します)
| Type: | SinceType |
| Accepted values: | Midnight, Yesterday, LastWeek, LastMonth |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SqlMessageID
実行時に指定されたメッセージを生成したジョブに返される値を制限するジョブ フィルター制約を指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SqlSeverity
実行時に指定された重大度のエラーを生成したジョブに返される値を制限するジョブ フィルター制約を指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartRunDate
ジョブが開始された日付に返される値を制限するジョブ フィルター制約を指定します。
| Type: | DateTime |
| Position: | Named |
| 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 |
入力
System.String[]
Microsoft.SqlServer.Management.Smo.Agent.JobServer[]
出力
System.Object