New-AzureRmVMSqlServerAutoBackupConfig
SQL Server 自動バックアップの構成オブジェクトを作成します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
New-AzureRmVMSqlServerAutoBackupConfig
[-ResourceGroupName] <String>
[-Enable]
[[-RetentionPeriodInDays] <Int32>]
[-EnableEncryption]
[[-CertificatePassword] <SecureString>]
[[-StorageUri] <Uri>]
[[-StorageKey] <SecureString>]
[-BackupSystemDbs]
[-BackupScheduleType <String>]
[-FullBackupFrequency <String>]
[-FullBackupStartHour <Int32>]
[-FullBackupWindowInHours <Int32>]
[-LogBackupFrequencyInMinutes <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] New-AzureRmVMSqlServerAutoBackupConfig
[-ResourceGroupName] <String>
[-Enable]
[[-RetentionPeriodInDays] <Int32>]
[-EnableEncryption]
[[-CertificatePassword] <SecureString>]
[[-StorageContext] <IStorageContext>]
[[-StorageUri] <Uri>]
[[-StorageKey] <SecureString>]
[-BackupSystemDbs]
[-BackupScheduleType <String>]
[-FullBackupFrequency <String>]
[-FullBackupStartHour <Int32>]
[-FullBackupWindowInHours <Int32>]
[-LogBackupFrequencyInMinutes <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
New-AzureRmVMSqlServerAutoBackupConfig コマンドレットは、SQL Server 自動バックアップの構成オブジェクトを作成します。
例
例 1: ストレージ URI とアカウント キーを使用して自動バックアップ構成を作成する
PS C:\> $AutoBackupConfig = New-AzureRmVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri "\\contoso\StorageGeneral" -StorageKey "< Storage Key for ContosoGeneral >"
Enable : True
EnableEncryption : False
RetentionPeriodInDays : 10このコマンドでは、ストレージ URI とアカウント キーを指定して、自動バックアップ構成オブジェクトを作成します。 自動バックアップが有効になり、自動バックアップは 10 日間保持されます。 このコマンドは、結果を $AutoBackupConfig 変数に格納します。 Set-AzureRmVMSqlServerExtension コマンドレットなど、他のコマンドレットに対してこの構成項目を指定できます。
例 2: ストレージ コンテキストを使用して自動バックアップ構成を作成する
PS C:\> $StorageContext = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral >"
PS C:\> $AutoBackupConfig = New-AzureRmVMSqlServerAutoBackupConfig -StorageContext $StorageContext -Enable -RetentionPeriod 10
Enable : True
EnableEncryption : False
RetentionPeriodInDays : 10最初のコマンドは、ストレージ コンテキストを作成し、$StorageContext変数に格納します。 詳細については、「 New-AzureStorageContext」を参照してください。 2 番目のコマンドでは、$StorageContextでストレージ コンテキストを指定して、自動バックアップ構成オブジェクトを作成します。 自動バックアップが有効になり、自動バックアップは 10 日間保持されます。
例 3: 暗号化とパスワードを使用してストレージ コンテキストを使用して自動バックアップ構成を作成する
PS C:\> $StorageContext = New-AzureRmVMSqlServerAutoBackupConfig -StorageContext $StorageContext -Enable -RetentionPeriod 10 -EnableEncryption -CertificatePassword $CertificatePassword
Enable : True
EnableEncryption : True
RetentionPeriodInDays : 10このコマンドは、自動バックアップ構成オブジェクトを作成して格納します。 このコマンドは、前の例で作成したストレージ コンテキストを指定します。 このコマンドを使用すると、パスワードを使用した暗号化が有効になります。 パスワードは、以前はセキュリティで保護された文字列として$CertificatePassword変数に格納されていました。 セキュリティで保護された文字列を作成するには、ConvertTo-SecureString コマンドレットを使用します。
パラメーター
-BackupScheduleType
バックアップ スケジュールの種類(手動または自動)
| Type: | String |
| Accepted values: | Manual, Automated |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BackupSystemDbs
システム データベースのバックアップ
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CertificatePassword
SQL Server で暗号化されたバックアップを実行するために使用される証明書を暗号化するためのパスワードを指定します。
| Type: | SecureString |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Enable
SQL Server 仮想マシンの自動バックアップが有効になっていることを示します。 このパラメーターを指定すると、自動バックアップによって、すべての現在および新しいデータベースのバックアップ スケジュールが設定されます。 これにより、このスケジュールに従ってマネージド バックアップの設定が更新されます。
| Type: | SwitchParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EnableEncryption
このコマンドレットで暗号化が有効であることを示します。
| Type: | SwitchParameter |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FullBackupFrequency
Sql Server の完全バックアップの頻度 (毎日または毎週)
| Type: | String |
| Accepted values: | Daily, Weekly |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FullBackupStartHour
Sql Server の完全バックアップを開始する時刻 (0 から 23)
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FullBackupWindowInHours
Sql Server の [完全バックアップ] ウィンドウ (時間単位)
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LogBackupFrequencyInMinutes
Sql Server ログ バックアップの頻度 (1 ~ 60 分に 1 回)
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
仮想マシンのリソース グループの名前を指定します。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RetentionPeriodInDays
バックアップを保持する日数を指定します。
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageContext
バックアップの格納に使用するストレージ アカウントを指定します。 AzureStorageContext オブジェクトを取得するには、New-AzureStorageContext コマンドレットを使用します。 既定値は、SQL Server 仮想マシンに関連付けられているストレージ アカウントです。
| Type: | IStorageContext |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageKey
BLOB ストレージ アカウントのストレージ キーを指定します。
| Type: | SecureString |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageUri
BLOB ストレージ アカウントの URI (Uniform Resource Identifier) を指定します。
| Type: | Uri |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]