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>]
[-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>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-SqlSmartAdmin コマンドレットは、BackupEnabled、BackupRetentionPeriodinDays、MasterSwitch、および 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に対する認証に使用されるアクセス トークン。
これは、たとえば、 または を使用して にSQL Azure DB
接続したりSQL Azure Managed Instance
、 を使用したりManaged Identity
するために使用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 |
-BackupEnabled
このコマンドレットで、Windows Azure へのマネージド バックアップSQL Server有効にすることを示します。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BackupRetentionPeriodInDays
バックアップ ファイルを保持する日数を指定します。 この設定で、データベースの復旧が可能な期間が決まります。 たとえば、30 日間の値を設定した場合、過去 30 日間の時点にデータベースを復旧できます。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DatabaseName
このコマンドレットで変更するデータベースの名前を指定します。
Type: | 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 |
-EncryptionOption
暗号化オプションを指定します。
Type: | BackupEncryptionOptions |
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
Smo Smart 管理 オブジェクトを指定します。 Get-SqlSmartAdmin コマンドレットを使用して、このオブジェクトを取得できます。
Type: | SmartAdmin |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MasterSwitch
このコマンドレットが、Windows Azure へのマネージド バックアップを含むスマート 管理のすべてのサービスSQL Server一時停止または再起動することを示します。
Type: | Boolean |
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 |
-Script
このコマンドレットによって、このコマンドレットが実行するタスクを実行する Transact-SQL スクリプトが返されることを示します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SqlCredential
Windows Azure ストレージ アカウントに対する認証に使用される SqlCredential オブジェクトを指定します。
Type: | PSObject |
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 |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
Microsoft.SqlServer.Management.Smo.SmartAdmin