次の方法で共有


Set-SqlSmartAdmin

バックアップの保有期間とストレージの設定を構成または変更します。

構文

Set-SqlSmartAdmin
   [-SqlCredential <PSObject>]
   [-MasterSwitch <Boolean>]
   [-BackupEnabled <Boolean>]
   [-BackupRetentionPeriodInDays <Int32>]
   [-EncryptionOption <BackupEncryptionOptions>]
   [-DatabaseName <String>]
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SqlSmartAdmin
   [-SqlCredential <PSObject>]
   [-MasterSwitch <Boolean>]
   [-BackupEnabled <Boolean>]
   [-BackupRetentionPeriodInDays <Int32>]
   [-EncryptionOption <BackupEncryptionOptions>]
   [-DatabaseName <String>]
   [-InputObject] <SmartAdmin>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-SqlSmartAdmin コマンドレットは、BackupEnabledBackupRetentionPeriodinDaysMasterSwitch、および sqlCredential パラメーター設定の を構成または変更します。 このコマンドレットは、特定のデータベースではなく、インスタンス レベルの構成に対してのみ実行できます。

このコマンドレットは、オブジェクトを返す次の操作モードをサポートしています。

  • 直接またはパイプラインを介して、Smo.Server オブジェクトを InputObject パラメーターに渡します。
  • SQL Server のインスタンスのパスを Path パラメーターに渡す

例 1: バックアップの保持とストレージの設定を構成する

PS C:\> $EncryptionOption = New-SqlBackupEncryptionOption -EncryptionAlgorithm Aes128 -EncryptorType ServerCertificate -EncryptorName "MyBackupCert"

このコマンドは、MyBackupCert という名前の暗号化機能を使用するストレージ設定のバックアップリテンション期間を構成し、結果を $EncryptionOptionという名前の変数に格納します。

パラメーター

-AccessToken

ユーザー/パスワードまたは Windows 認証の代わりに、SQL Server に対する認証に使用されるアクセス トークン。

これは、たとえば、Service Principal または Managed Identityを使用して SQL Azure DBSQL Azure Managed Instance に接続するために使用できます。

使用するパラメーターには、トークンを表す文字列、または Get-AzAccessToken -ResourceUrl https://database.windows.netを実行して返される PSAccessToken オブジェクトを指定できます。

このパラメーターは、モジュールの v22 の新機能です。

型:PSObject
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-BackupEnabled

このコマンドレットによって、Windows Azure への SQL Server マネージド バックアップが有効であることを示します。

型:Boolean
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-BackupRetentionPeriodInDays

バックアップ ファイルを保持する日数を指定します。 これにより、データベースの回復可能性の期間が決まります。 たとえば、30 日間の値を設定した場合、過去 30 日間の時点にデータベースを復旧できます。

型:Int32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DatabaseName

このコマンドレットが変更するデータベースの名前を指定します。

型: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

-EncryptionOption

暗号化オプションを指定します。

型:BackupEncryptionOptions
配置: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

-InputObject

Smo Smart Admin オブジェクトを指定します。 Get-SqlSmartAdmin コマンドレットを使用して、このオブジェクトを取得できます。

型:SmartAdmin
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-MasterSwitch

このコマンドレットが、Windows Azure への SQL Server マネージド バックアップを含むスマート管理者のすべてのサービスを一時停止または再起動することを示します。

型:Boolean
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Path

SQL Server のインスタンスへのパスを指定します。 このパラメーターの値を指定しない場合、コマンドレットは現在の作業ディレクトリを使用します。 これは、複数のインスタンスを管理するスクリプトを作成する場合に便利です。

型:String
配置:1
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ProgressAction

スクリプト、コマンドレット、またはプロバイダーによって生成された進行状況の更新 (Write-Progress コマンドレットによって生成された進行状況バーなど) に対する PowerShell の応答方法を決定します。 Write-Progress コマンドレットは、コマンドの状態を示す進行状況バーを作成します。

型:ActionPreference
Aliases:proga
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Script

このコマンドレットは、このコマンドレットが実行するタスクを実行する Transact-SQL スクリプトを返します。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-SqlCredential

Windows Azure ストレージ アカウントに対する認証に使用する SqlCredential オブジェクトを指定します。

型:PSObject
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-TrustServerCertificate

信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。

モジュールの v22 では、既定値は $true です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに重大な変更が生じる可能性があります。

このパラメーターは、モジュールの v22 の新機能です。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

Microsoft.SqlServer.Management.Smo.SmartAdmin