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>]
[-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>]
[-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>]
[-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の認証に使用されるアクセス トークン。
これは、たとえば、 または 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 |
-BackupType
フィルター処理するバックアップの種類。 指定されていない場合は、すべてのバックアップの種類を取得します。 受け入れ可能な値を以下に定義します。
Type: | BackupSetType |
Accepted values: | Database, Differential, Incremental, Log, FileOrFileGroup, FileOrFileGroupDifferential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionTimeout
接続が確立され、動的に生成された -DatabaseName パラメーターが設定されるまでの待機時間 (秒単位)。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
ユーザー名フィールドとパスワード フィールドを使用して SQL インスタンスに接続する PSCredential オブジェクト。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DatabaseName
バックアップ レコードを取得するデータベースの名前。 これは動的に設定されたフィールドであるため、データベース名に関するオートコンプリート候補が提供されます。
Type: | System.Collections.Generic.List`1[System.String] |
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 |
-EndTime
取得するすべてのバックアップ レコードが完了するまでの時間。
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 |
-IgnoreProviderContext
このコマンドレットが現在のコンテキストを使用して ServerInstance、 DatabaseName パラメーターの値をオーバーライドしないことを示します。 このパラメーターを指定しない場合、コマンドレットは、コマンドレットを実行するコンテキストを優先して、可能であれば、これらのパラメーターの値を無視します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IncludeSnapshotBackups
このスイッチを使用すると、コマンドレットはスナップショットバックアップのレコードも取得します。 既定では、このようなバックアップは取得されません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
バックアップ レコードを取得する SMO Server オブジェクトを指定します。
Type: | Server[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
BackupSets の取得に使用するサーバー インスタンスまたはデータベースへの SQL プロバイダー パスを指定します。 指定しない場合は、現在の作業場所が使用されます。
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServerInstance
このコマンドレットの対象となるサーバー インスタンスの名前。
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Since
StartTime パラメーターの代わりに使用できる省略形を指定します。
EndTime パラメーターを使用して指定できます。
このパラメーターを使用する場合は、StartTime パラメーターを使用できません。
このパラメーターの有効値は、次のとおりです。
- 午前 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 |
-StartTime
この指定時刻より後に開始されたバックアップ レコードを取得します。
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SuppressProviderContextWarning
コマンドレットがプロバイダー コンテキストを使用している場合に警告を抑制します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TimeSpan
指定した場合、コマンドレットは'Timespan' より前に生成されたレコードをフィルター処理します。
Type: | TimeSpan |
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.Server[]
出力
System.Object