Get-SqlBackupHistory
データベースに関するバックアップ情報を取得し、このコマンドレットに指定されたパラメーターに基づいて見つかった各 Backup レコードの SMO BackupSet オブジェクトを返します。
構文
Get-SqlBackupHistory
[-Since <SinceType>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-BackupType <BackupSetType>]
[-IncludeSnapshotBackups]
[-TimeSpan <TimeSpan>]
[-IgnoreProviderContext]
[-SuppressProviderContextWarning]
[[-Path] <String[]>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-DatabaseName <System.Collections.Generic.List`1[System.String]>]
[<CommonParameters>] Get-SqlBackupHistory
[-Since <SinceType>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-BackupType <BackupSetType>]
[-IncludeSnapshotBackups]
[-TimeSpan <TimeSpan>]
[-IgnoreProviderContext]
[-SuppressProviderContextWarning]
[[-ServerInstance] <String[]>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-DatabaseName <System.Collections.Generic.List`1[System.String]>]
[<CommonParameters>] Get-SqlBackupHistory
[-Since <SinceType>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-BackupType <BackupSetType>]
[-IncludeSnapshotBackups]
[-TimeSpan <TimeSpan>]
[-IgnoreProviderContext]
[-SuppressProviderContextWarning]
[-InputObject] <Server[]>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[-DatabaseName <System.Collections.Generic.List`1[System.String]>]
[<CommonParameters>] 説明
このコマンドレットは、サーバー インスタンスを検索し、指定されたパラメーターに一致するすべてのレコードのバックアップ レコードを SMO BackupSet オブジェクトとして取得します。
例
例 1
PS C:\> Get-SqlBackupHistory -ServerInstance test-server -DatabaseName AdventureWorks2014
Name Type Backup Start Date Backup Finish Date
---- ---- ----------------- ------------------
AdventureWorks2014-Full Database Backup Database 2/21/2017 7:52:39 PM 2/21/2017 7:52:40 PM
AdventureWorks2014-Full Database Backup Database 3/20/2017 2:41:39 PM 3/20/2017 2:41:39 PM
AdventureWorks2014-Full-2017-07-24T22:22 Database 7/24/2017 3:23:11 PM 7/24/2017 3:23:11 PMこの例では、test-server SQL インスタンス上の AdventureWorks2014 データベースのすべてのバックアップの種類のレコードを取得します。
パラメーター
-AccessToken
ユーザー/パスワードまたは Windows 認証の代わりに、SQL Server に対する認証に使用されるアクセス トークン。
これは、たとえば、Service Principal または Managed Identityを使用して SQL Azure DB と SQL Azure Managed Instance に接続するために使用できます。
使用するパラメーターには、トークンを表す文字列、または Get-AzAccessToken -ResourceUrl https://database.windows.netを実行して返される PSAccessToken オブジェクトを指定できます。
このパラメーターは、モジュールの v22 の新機能です。
| 型: | PSObject |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-BackupType
フィルター処理するバックアップの種類。 指定されていない場合は、すべてのバックアップの種類を取得します。 受け入れ可能な値を以下に定義します。
| 型: | BackupSetType |
| 指定可能な値: | Database, Differential, Incremental, Log, FileOrFileGroup, FileOrFileGroupDifferential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ConnectionTimeout
接続が確立され、動的に生成された -DatabaseName パラメーターが設定されるまでの待機時間 (秒単位)。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Credential
SQL インスタンスへの接続に使用されるユーザー名フィールドとパスワード フィールドを持つ PSCredential オブジェクト。
| 型: | PSCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DatabaseName
バックアップ レコードを取得するデータベースの名前。 これは動的に設定されるフィールドであるため、データベース名に関するオートコンプリート候補が提供されます。
| 型: | System.Collections.Generic.List`1[System.String] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Encrypt
SQL Server に接続するときに使用する暗号化の種類。
この値は、Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの Encrypt プロパティ SqlConnectionEncryptOption にマップされます。
モジュールの v22 では、既定値は Optional です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "必須" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
| 型: | String |
| 指定可能な値: | Mandatory, Optional, Strict |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-EndTime
取得するすべてのバックアップ レコードが完了するまでの時間。
| 型: | DateTime |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-HostNameInCertificate
SQL Server TLS/SSL 証明書の検証に使用するホスト名。 SQL Server インスタンスで Force Encryption が有効になっていて、ホスト名/短縮名を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっている SQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。
このパラメーターは、モジュールの v22 の新機能です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-IgnoreProviderContext
このコマンドレットは、現在のコンテキストを使用して、ServerInstanceDatabaseName パラメーターの値をオーバーライドしないことを示します。 このパラメーターを指定しない場合、コマンドレットは、コマンドレットを実行するコンテキストを優先して、可能であれば、これらのパラメーターの値を無視します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-IncludeSnapshotBackups
この切り替えにより、コマンドレットはスナップショット バックアップのレコードも取得します。 既定では、このようなバックアップは取得されません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
バックアップ レコードを取得する SMO サーバー オブジェクトを指定します。
| 型: | Server[] |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Path
BackupSet の取得に使用する、このコマンドレットのサーバー インスタンスまたはデータベースへの SQL プロバイダー パスを指定します。 指定しない場合は、現在の作業場所を使用します。
| 型: | String[] |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ProgressAction
スクリプト、コマンドレット、またはプロバイダーによって生成された進行状況の更新 (Write-Progress コマンドレットによって生成された進行状況バーなど) に対する PowerShell の応答方法を決定します。 Write-Progress コマンドレットは、コマンドの状態を示す進行状況バーを作成します。
| 型: | ActionPreference |
| Aliases: | proga |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ServerInstance
このコマンドレットの対象となるサーバー インスタンスの名前。
| 型: | String[] |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Since
StartTime パラメーターの代わりに使用できる省略形を指定します。
EndTime パラメーターを使用して指定できます。
このパラメーターを使用する場合は、StartTime パラメーターを使用できません。
このパラメーターに使用できる値は次のとおりです。
- 午前 0 時 (午前 0 時以降に生成されたすべてのジョブ履歴情報を取得します)
- 昨日 (過去 24 時間以内に生成されたすべてのジョブ履歴情報を取得します)
- LastWeek (過去 1 週間に生成されたすべてのジョブ履歴情報を取得します)
- LastMonth (先月に生成されたすべてのジョブ履歴情報を取得します)
| 型: | SinceType |
| 指定可能な値: | Midnight, Yesterday, LastWeek, LastMonth |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-StartTime
この指定した時刻より後に開始されたバックアップ レコードを取得します。
| 型: | DateTime |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-SuppressProviderContextWarning
コマンドレットがプロバイダー コンテキストを使用している場合に警告を抑制します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TimeSpan
指定した場合、コマンドレットは、"Timespan" より前に生成されたレコードをフィルター処理します。
| 型: | TimeSpan |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TrustServerCertificate
信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
System.String[]
Microsoft.SqlServer.Management.Smo.Server[]
出力
System.Object
関連リンク
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示