Backup-SqlDatabase
SQL Server データベース オブジェクトをバックアップします。
構文
ByPath (既定)
Backup-SqlDatabase
[-Database] <String>
[[-BackupFile] <String[]>]
[-BackupContainer <String>]
[-MirrorDevices <BackupDeviceList[]>]
[-BackupAction <BackupActionType>]
[-BackupSetName <String>]
[-BackupSetDescription <String>]
[-CompressionOption <BackupCompressionOptions>]
[-CopyOnly]
[-ExpirationDate <DateTime>]
[-FormatMedia]
[-Incremental]
[-Initialize]
[-LogTruncationType <BackupTruncateLogType>]
[-MediaDescription <String>]
[-RetainDays <Int32>]
[-SkipTapeHeader]
[-UndoFileName <String>]
[-EncryptionOption <BackupEncryptionOptions>]
[-StatementTimeout <Int32>]
[-Path <String[]>]
[-SqlCredential <PSObject>]
[-BackupDevice <BackupDeviceItem[]>]
[-PassThru]
[-Checksum]
[-ContinueAfterError]
[-NoRewind]
[-Restart]
[-UnloadTapeAfter]
[-NoRecovery]
[-DatabaseFile <String[]>]
[-DatabaseFileGroup <String[]>]
[-BlockSize <Int32>]
[-BufferCount <Int32>]
[-MaxTransferSize <Int32>]
[-MediaName <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByDBObject
Backup-SqlDatabase
[-DatabaseObject] <Database>
[[-BackupFile] <String[]>]
[-BackupContainer <String>]
[-MirrorDevices <BackupDeviceList[]>]
[-BackupAction <BackupActionType>]
[-BackupSetName <String>]
[-BackupSetDescription <String>]
[-CompressionOption <BackupCompressionOptions>]
[-CopyOnly]
[-ExpirationDate <DateTime>]
[-FormatMedia]
[-Incremental]
[-Initialize]
[-LogTruncationType <BackupTruncateLogType>]
[-MediaDescription <String>]
[-RetainDays <Int32>]
[-SkipTapeHeader]
[-UndoFileName <String>]
[-EncryptionOption <BackupEncryptionOptions>]
[-StatementTimeout <Int32>]
[-SqlCredential <PSObject>]
[-BackupDevice <BackupDeviceItem[]>]
[-PassThru]
[-Checksum]
[-ContinueAfterError]
[-NoRewind]
[-Restart]
[-UnloadTapeAfter]
[-NoRecovery]
[-DatabaseFile <String[]>]
[-DatabaseFileGroup <String[]>]
[-BlockSize <Int32>]
[-BufferCount <Int32>]
[-MaxTransferSize <Int32>]
[-MediaName <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByName
Backup-SqlDatabase
[-Database] <String>
[[-BackupFile] <String[]>]
-ServerInstance <String[]>
[-BackupContainer <String>]
[-MirrorDevices <BackupDeviceList[]>]
[-BackupAction <BackupActionType>]
[-BackupSetName <String>]
[-BackupSetDescription <String>]
[-CompressionOption <BackupCompressionOptions>]
[-CopyOnly]
[-ExpirationDate <DateTime>]
[-FormatMedia]
[-Incremental]
[-Initialize]
[-LogTruncationType <BackupTruncateLogType>]
[-MediaDescription <String>]
[-RetainDays <Int32>]
[-SkipTapeHeader]
[-UndoFileName <String>]
[-EncryptionOption <BackupEncryptionOptions>]
[-StatementTimeout <Int32>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[-SqlCredential <PSObject>]
[-BackupDevice <BackupDeviceItem[]>]
[-PassThru]
[-Checksum]
[-ContinueAfterError]
[-NoRewind]
[-Restart]
[-UnloadTapeAfter]
[-NoRecovery]
[-DatabaseFile <String[]>]
[-DatabaseFileGroup <String[]>]
[-BlockSize <Int32>]
[-BufferCount <Int32>]
[-MaxTransferSize <Int32>]
[-MediaName <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObject
Backup-SqlDatabase
[-Database] <String>
[[-BackupFile] <String[]>]
-InputObject <Server[]>
[-BackupContainer <String>]
[-MirrorDevices <BackupDeviceList[]>]
[-BackupAction <BackupActionType>]
[-BackupSetName <String>]
[-BackupSetDescription <String>]
[-CompressionOption <BackupCompressionOptions>]
[-CopyOnly]
[-ExpirationDate <DateTime>]
[-FormatMedia]
[-Incremental]
[-Initialize]
[-LogTruncationType <BackupTruncateLogType>]
[-MediaDescription <String>]
[-RetainDays <Int32>]
[-SkipTapeHeader]
[-UndoFileName <String>]
[-EncryptionOption <BackupEncryptionOptions>]
[-StatementTimeout <Int32>]
[-SqlCredential <PSObject>]
[-BackupDevice <BackupDeviceItem[]>]
[-PassThru]
[-Checksum]
[-ContinueAfterError]
[-NoRewind]
[-Restart]
[-UnloadTapeAfter]
[-NoRecovery]
[-DatabaseFile <String[]>]
[-DatabaseFileGroup <String[]>]
[-BlockSize <Int32>]
[-BufferCount <Int32>]
[-MaxTransferSize <Int32>]
[-MediaName <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByBackupContainer
Backup-SqlDatabase
[[-BackupFile] <String[]>]
[-BackupContainer <String>]
[-MirrorDevices <BackupDeviceList[]>]
[-BackupAction <BackupActionType>]
[-BackupSetName <String>]
[-BackupSetDescription <String>]
[-CompressionOption <BackupCompressionOptions>]
[-CopyOnly]
[-ExpirationDate <DateTime>]
[-FormatMedia]
[-Incremental]
[-Initialize]
[-LogTruncationType <BackupTruncateLogType>]
[-MediaDescription <String>]
[-RetainDays <Int32>]
[-SkipTapeHeader]
[-UndoFileName <String>]
[-EncryptionOption <BackupEncryptionOptions>]
[-StatementTimeout <Int32>]
[-SqlCredential <PSObject>]
[-BackupDevice <BackupDeviceItem[]>]
[-PassThru]
[-Checksum]
[-ContinueAfterError]
[-NoRewind]
[-Restart]
[-UnloadTapeAfter]
[-NoRecovery]
[-DatabaseFile <String[]>]
[-DatabaseFileGroup <String[]>]
[-BlockSize <Int32>]
[-BufferCount <Int32>]
[-MaxTransferSize <Int32>]
[-MediaName <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Backup-SqlDatabase コマンドレットは、SQL Server データベースに対してバックアップ操作を実行します。
これには、データベースの完全バックアップ、トランザクション ログ バックアップ、データベース ファイルのバックアップが含まれます。
このコマンドレットは、Microsoft.SqlServer.Management.Smo.Backup クラスの後にモデル化されています。
このクラスのパラメーターは、通常、その Smo オブジェクトのプロパティに対応します。
サーバー インスタンスのパスとデータベース名でデータベースをバックアップするには、Path パラメーターにサーバー インスタンス パスを指定し、データベース パラメーターにデータベース名を指定します。
Smo.Server オブジェクトとデータベース名を使用してデータベースをバックアップするには、InputObject パラメーターに Smo.Server オブジェクトを直接指定するか、パイプライン演算子を使用して指定し、データベース パラメーターにデータベース名を指定します。
サーバー インスタンスとデータベース名でデータベースをバックアップするには、ServerInstance パラメーターにサーバー インスタンスを指定し、データベース パラメーターにデータベース名を指定します。
Smo.Database オブジェクトを使用してデータベースをバックアップするには、DatabaseObject パラメーターに Smo.Database オブジェクトを直接指定するか、パイプライン演算子を使用して指定します。
既定では、このコマンドレットはデータベースの完全バックアップを実行します。
BackupAction パラメーターを使用して、バックアップの種類を設定します。
既定では、バックアップ ファイルは、完全バックアップまたはファイル バックアップのdatabasename.bak名の下の既定のサーバー バックアップの場所に格納され、ログ バックアップの場合は databasename.trn という名前で保存されます。 別のファイル名を指定するには、BackupFile パラメーターを使用します。
バックアップ ファイルの場所を指定し、自動生成されたファイル名を使用するには、BackupContainer パラメーターを使用して場所を指定します。
例
例 1: 完全なデータベースをバックアップする
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainDB"
このコマンドを実行すると、"MainDB" という名前のデータベースの完全なデータベース バックアップが、サーバー インスタンス 'Computer\Instance' の既定のバックアップ場所に作成されます。 バックアップ ファイルの名前は "MainDB.bak" です。
例 2: 場所に基づいてデータベースをバックアップする
PS C:\> Set-Location "SQLSERVER:\SQL\Computer\Instance"
PS SQLSERVER:\SQL\Computer\Instance> Backup-SqlDatabase -Database "MainDB"
このコマンドを実行すると、データベース 'MainDB' の完全なデータベース バックアップが、サーバー インスタンス 'Computer\Instance' の既定のバックアップ場所に作成されます。 現在の作業ディレクトリは、バックアップが行われるサーバー インスタンスを決定するために使用されます。
例 3: トランザクション ログをバックアップする
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainDB" -BackupAction Log
このコマンドは、データベース 'MainDB' のトランザクション ログのバックアップを、サーバー インスタンス 'Computer\Instance' の既定のバックアップ場所に作成します。 バックアップ ファイルの名前は "MainDB.trn" です。
例 4: データベースをバックアップし、資格情報の入力を求める
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainDB" -Credential (Get-Credential "sa")
このコマンドは、'sa' SQL Server ログインを使用して、データベース 'MainDB' の完全なデータベース バックアップを作成します。 このコマンドは、認証を完了するためのパスワードの入力を求めます。
例 5: データベースをネットワーク ファイル共有にバックアップする
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainDB" -BackupFile "\\mainserver\databasebackup\MainDB.bak"
このコマンドを実行すると、データベース 'MainDB' の完全なデータベース バックアップがファイル "\\mainserver\databasebackup\MainDB.bak" に作成されます。
例 6: サーバー インスタンス内のすべてのデータベースをバックアップする
PS C:\> Get-ChildItem "SQLSERVER:\SQL\Computer\Instance\Databases" | Backup-SqlDatabase
このコマンドは、サーバー インスタンス 'Computer\Instance' 上のすべてのデータベースを既定のバックアップ場所にバックアップします。 バックアップ ファイルには、 <データベース名>.bakという名前が付けられます。
例 7: サーバー インスタンス内のすべてのデータベースをネットワーク ファイル共有にバックアップする
PS C:\> Set-Location "SQLSERVER:\SQL\Computer\Instance\Databases"
PS SQLSERVER:\SQL\Computer\Instance\Databases> foreach ($database in (Get-ChildItem)) {
$dbName = $database.Name
Backup-SqlDatabase -Database $dbName -BackupFile "\\mainserver\databasebackup\$dbName.bak" }
このコマンドは、サーバー インスタンス 'Computer\Instance' 上の各データベースの完全バックアップを共有 "\\mainserver\databasebackup" に作成します。 バックアップ ファイルには、 <データベース名>.bakという名前が付けられます。
例 8: セカンダリ ファイル グループ内のすべてのファイルをバックアップする
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainDB" -BackupAction Files -DatabaseFileGroup "FileGroupJan","FileGroupFeb"
このコマンドは、セカンダリ ファイル グループ 'FileGroupJan' および 'FileGroupFeb' 内のすべてのファイルの完全なファイル バックアップを作成します。
例 9: 差分バックアップを作成する
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainDB" -Incremental
このコマンドは、データベース 'MainDB' の差分バックアップをサーバー インスタンス 'Computer\Instance' の既定のバックアップ場所に作成します。 バックアップ ファイルの名前は "MainDB.bak" です。
例 10: テープ ドライブへのバックアップを作成する
PS C:\> $TapeDevice = New-Object Microsoft.Sqlserver.Management.Smo.BackupDeviceItem("\\.\tape0", "Tape")
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainDB" -BackupDevice $TapeDevice
このコマンドにより、データベース MainDB のテープ デバイス "\\.\tape0" への完全バックアップが作成されます。 このデバイスを表すために、このコマンドは Microsoft.Sqlserver.Management.Smo.BackupDeviceItem オブジェクトのインスタンスを構築します。 コンストラクターは、バックアップ デバイスの名前とバックアップ デバイスの種類という 2 つの引数を受け取ります。 この BackupDeviceItem オブジェクトは、 Backup-SqlDatabase コマンドレットの BackupDevice パラメーターに渡されます。
例 11: データベースを Azure Blob Storage サービスにバックアップする
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainDB" -BackupContainer "https://storageaccountname.blob.core.windows.net/containername" -SqlCredential "SQLCredentialName"
このコマンドを実行すると、データベース 'MainDB' の完全バックアップが Windows Azure Blob Storage サービスに作成されます。 BackupContainer を使用して、Windows Azure BLOB コンテナーの場所 (URL) を指定します。 バックアップ ファイルの名前が自動生成されます。 SqlCredential パラメーターは、認証情報を格納する SQL Server 資格情報の名前を指定するために使用されます。
例 12: データベースを Azure Blob Storage サービスにバックアップし、ファイル名を指定する
PS C:\> Backup-SqlDatabase -ServerInstance "Computer\Instance" -Database "MainyDB" -BackupFile "https://storageaccountname.blob.core.windows.net/containername/MainDB.bak" -SqlCredential "SQLCredentialName"
このコマンドを実行すると、データベース MainDB の完全バックアップが Windows Azure Blob Storage サービスに作成されます。 BackupFile パラメーターを使用して、場所 (URL) とバックアップ ファイル名を指定します。 SqlCredential パラメーターは、SQL Server 資格情報の名前を指定するために使用されます。
例 13: すべてのデータベースを Azure Blob Storage サービスにバックアップする
PS C:\> Get-ChildItem "SQLSERVER:\SQL\Computer\Instance\Databases" | Backup-SqlDatabase -BackupContainer "https://storageaccountname.blob.core.windows.net/containername" -SqlCredential "SQLCredentialName"
このコマンドは、BackupContainer パラメーターを使用して、サーバー インスタンス 'Computer\Instance' 上のすべてのデータベースを Windows Azure Blob Storage サービスの場所にバックアップします。 バックアップ ファイル名が自動生成されます。
例 14: 暗号化されたバックアップを作成する
PS C:\> $EncryptionOption = New-SqlBackupEncryptionOption -Algorithm Aes256 -EncryptorType ServerCertificate -EncryptorName "BackupCert"
PS C:\> Backup-SqlDatabase -ServerInstance "." -Database "MainDB" -BackupFile "MainDB.bak" -CompressionOption On -EncryptionOption $EncryptionOption
この例では、暗号化オプションを作成し、 それを Backup-SqlDatabase のパラメーター値として使用して、暗号化されたバックアップを作成します。
パラメーター
-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 |
-BackupAction
実行するバックアップ操作の種類を指定します。 有効な値は次のとおりです。
- データベース。 データベース内のすべてのデータ ファイルをバックアップします。
- Files。 DatabaseFile パラメーターまたは DatabaseFileGroup パラメーターで指定されたデータ ファイルをバックアップします。
- 丸太。 トランザクション ログをバックアップします。
パラメーターのプロパティ
| 型: | BackupActionType |
| 規定値: | None |
| 指定可能な値: | Database, Files, Log |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BackupContainer
コマンドレットがバックアップを格納するフォルダーまたは場所を指定します。 ディスク上のフォルダーまたは Azure BLOB コンテナーの URL を指定できます。 このパラメーターは、特定のインスタンス内の複数のデータベースをバックアップする場合に役立ちます。 このパラメーターを BackupDevice パラメーターと共に使用することはできません。 BackupContainer パラメーターを BackupFile パラメーターと共に使用することはできません。
場所を指定するために使用するパスは、スラッシュ (/) で終わる必要があります。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BackupDevice
バックアップが格納されるデバイスを指定します。 このパラメーターを BackupFile パラメーターと共に使用することはできません。 テープにバックアップする場合は、このパラメーターを使用します。
パラメーターのプロパティ
| 型: | BackupDeviceItem[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BackupFile
バックアップの場所とファイル名を指定します。
これは省略可能なパラメーターです。
指定しない場合、バックアップはサーバーの既定のバックアップ場所に、完全バックアップとファイル バックアップの場合は databasename.bak という名前で、ログ バックアップの場合は databasename.trn に格納されます。
複数のファイルにバックアップする場合は、ファイル名をコンマで区切ります。次に例を示します。 -BackupFile C:\Backups\databasename2.bak,C:\Backups\databasename2.bak
このパラメーターは、 -BackupDevice パラメーターまたは -BackupContainer パラメーターでは使用できません。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BackupSetDescription
バックアップ セットの説明を指定します。 このパラメーターは省略可です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BackupSetName
バックアップ セットの名前を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BlockSize
バックアップの物理ブロック サイズをバイト単位で指定します。 サポートされるサイズは、512、1024、2048、4096、8192、16384、32768、および 65536 (64 KB) バイトです。 既定値は、テープ デバイスの場合は 65536、他のすべてのデバイスでは 512 です。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BufferCount
バックアップ操作に使用する I/O バッファーの数を指定します。 任意の正の整数を指定できます。 バッファーの Sqlservr.exe プロセスに仮想アドレス空間が不足している場合は、メモリ不足エラーが発生します。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Checksum
バックアップ操作中にチェックサム値が計算されることを示します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CompressionOption
バックアップ操作の圧縮オプションを指定します。
パラメーターのプロパティ
| 型: | BackupCompressionOptions |
| 規定値: | None |
| 指定可能な値: | Default, On, Off |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ConnectionTimeout
タイムアウトエラーが発生するまでのサーバー接続を待機する秒数を指定します。 タイムアウト値は、0 ~ 65534 の整数である必要があります。 0 を指定した場合、接続試行はタイムアウトしません。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByName
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ContinueAfterError
チェックサム エラーが発生したときに操作を続行することを示します。 設定されていない場合、チェックサム エラーの後に操作は失敗します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CopyOnly
バックアップがコピーのみのバックアップであることを示します。 コピーのみのバックアップは、定期的にスケジュールされた従来のバックアップの通常のシーケンスには影響しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Credential
この操作を実行する権限を持つ SQL Server ログインの資格情報を含む PSCredential オブジェクトを指定します。 これは、SQL Server 外部のリソースにアクセスするときに、SQL Server によって内部的に認証情報を格納するために使用される SQL 資格情報オブジェクトではありません。
パラメーターのプロパティ
| 型: | PSCredential |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByName
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Database
バックアップするデータベースの名前を指定します。 このパラメーターを DatabaseObject パラメーターと共に使用することはできません。 このパラメーターを指定する場合は、Path、InputObject、または ServerInstance パラメーターも指定する必要があります。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByPath
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByName
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByObject
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DatabaseFile
バックアップする 1 つ以上のデータベース ファイルを指定します。 このパラメーターは、BackupAction が Files に設定されている場合にのみ使用されます。 BackupAction が Files に設定されている場合は、DatabaseFileGroups パラメーターまたは DatabaseFiles パラメーターを指定する必要があります。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DatabaseFileGroup
バックアップ操作の対象となるデータベース ファイル グループを指定します。 このパラメーターは、BackupAction プロパティが Files に設定されている場合にのみ使用されます。 BackupAction パラメーターが Files に設定されている場合は、DatabaseFileGroups パラメーターまたは DatabaseFiles パラメーターを指定する必要があります。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DatabaseObject
バックアップ操作のデータベース オブジェクトを指定します。
パラメーターのプロパティ
| 型: | Database |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByDBObject
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | 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 |
-EncryptionOption
バックアップ操作の暗号化オプションを指定します。
パラメーターのプロパティ
| 型: | BackupEncryptionOptions |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExpirationDate
バックアップ セットの有効期限が切れ、バックアップ データが有効と見なされなくなった日時を指定します。 これは、ディスクまたはテープ デバイスに格納されているバックアップ データにのみ使用できます。 有効期限より古いバックアップ セットは、後のバックアップで上書きできます。
パラメーターのプロパティ
| 型: | DateTime |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-FormatMedia
テープがバックアップ操作の最初の手順として書式設定されていることを示します。 これはディスク バックアップには適用されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | 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 |
-Incremental
差分バックアップが実行されることを示します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Initialize
バックアップ操作に関連付けられているデバイスが初期化されることを示します。 これにより、メディア上の既存のバックアップ セットが上書きされ、このバックアップがメディア上の最初のバックアップ セットになります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InputObject
バックアップの場所のサーバー オブジェクトを指定します。
パラメーターのプロパティ
| 型: | Server[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LogTruncationType
ログ バックアップの切り捨て動作を指定します。 有効な値は次のとおりです。
-- TruncateOnly -- NoTruncate -- Truncate
既定値は Truncate です。
パラメーターのプロパティ
| 型: | BackupTruncateLogType |
| 規定値: | None |
| 指定可能な値: | TruncateOnly, NoTruncate, Truncate |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MaxTransferSize
バックアップ メディアと SQL Server のインスタンスの間で転送される最大バイト数を指定します。 指定できる値は、65536 バイト (64 KB) の倍数で、最大4194304 バイト (4 MB) です。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MediaDescription
バックアップ セットを含むメディアの説明を指定します。 このパラメーターは省略可です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MediaName
メディア セットの識別に使用する名前を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MirrorDevices
ミラー化されたバックアップで使用される BackupDeviceList オブジェクトの配列を指定します。
パラメーターのプロパティ
| 型: | BackupDeviceList[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoRecovery
ログの末尾がバックアップされていないことを示します。 復元されると、データベースは復元中の状態になります。 設定しない場合、ログの末尾がバックアップされます。 これは、BackupAction パラメーターが Log に設定されている場合にのみ適用されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoRewind
バックアップが完了したときに、テープ ドライブが終了位置で開いたままであることを示します。 設定されていない場合、操作の完了後にテープが巻き戻されます。 これは、ディスクまたは URL のバックアップには適用されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PassThru
コマンドレットが、バックアップを実行した Smo.Backup オブジェクトを出力することを示します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Path
バックアップ操作を実行する SQL Server のインスタンスへのパスを指定します。 これは省略可能なパラメーターです。 このパラメーターの値を指定しない場合、既定では、現在の場所に設定されます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByPath
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Restart
コマンドレットが部分的に完了したバックアップ操作の処理を続行することを示します。 設定されていない場合、コマンドレットは、バックアップ セットの先頭で中断されたバックアップ操作を再起動します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RetainDays
バックアップ セットを上書きするまでに経過する必要がある日数を指定します。 これは、ディスクまたはテープ デバイスに格納されているバックアップ データにのみ使用できます。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Script
このコマンドレットが、バックアップ操作を実行する Transact-SQL スクリプトを出力することを示します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ServerInstance
SQL Server インスタンスの名前を指定します。 このサーバー インスタンスがバックアップ操作のターゲットになります。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByName
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SkipTapeHeader
テープ ヘッダーが読み取られないことを示します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SqlCredential
認証情報を格納する SQL Server 資格情報オブジェクトを指定します。 Blob Storage サービスにバックアップする場合は、このパラメーターを指定する必要があります。 格納される認証情報には、ストレージ アカウント名と、関連付けられているアクセス キーの値が含まれます。 ディスクまたはテープには、このパラメーターを指定しないでください。
パラメーターのプロパティ
| 型: | PSObject |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-StatementTimeout
バックアップ操作のタイムアウト (秒単位) を設定します。
値が 0 の場合、または StatementTimeout パラメーターが指定されていない場合、復元操作はタイムアウトになりません。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | 0 |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TrustServerCertificate
信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UndoFileName
復旧中にロールバックされるコミットされていないトランザクションを格納するために使用される元に戻すファイルの名前を指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UnloadTapeAfter
操作の終了時にテープ デバイスが巻き戻されてアンロードされることを示します。 設定されていない場合、テープ メディアの巻き戻しとアンロードは試行されません。 これは、ディスクまたは URL のバックアップには適用されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
SMO.Server
Microsoft.SqlServer.Management.Smo.Database
Microsoft.SqlServer.Management.Smo.Server
SMO を指定します。バックアップ操作が行われる SQL Server のインスタンスを参照するサーバー オブジェクト。