Set-AzureRMVMSqlServerExtension
仮想マシン上の Azure SQL Server 拡張機能を設定します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Set-AzureRMVMSqlServerExtension
[[-Version] <String>]
[-ResourceGroupName] <String>
[-VMName] <String>
[[-Name] <String>]
[[-AutoPatchingSettings] <AutoPatchingSettings>]
[[-AutoBackupSettings] <AutoBackupSettings>]
[[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>]
[[-Location] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Set-AzureRmVMSqlServerExtension コマンドレットは、仮想マシンに AzureSQL Server 拡張機能を設定します。
例
例 1: 仮想マシンで自動修正プログラムの設定を行う
PS C:\> $AutoPatchingConfig = New-AzureVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important"
PS C:\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoPatchingSettings $AutoPatchingConfig | Update-AzureRmVM最初のコマンドは、New-AzureVMSqlServerAutoPatchingConfig コマンドレットを使用して構成オブジェクトを作成します。 このコマンドは、$AutoPatchingConfig変数に構成を格納します。 2 番目のコマンドは、Get-AzureRmVM コマンドレットを使用して、Service02 という名前のサービスで VirtualMachine11 という名前の仮想マシンを取得します。 コマンドは、パイプライン演算子を使用して、そのオブジェクトを現在のコマンドレットに渡します。 現在のコマンドレットは、仮想マシンの$AutoPatchingConfigで自動修正プログラムの設定を行います。 このコマンドは、仮想マシンを Update-AzureRmVM コマンドレットに渡します。
例 2: 仮想マシンで自動バックアップ設定を設定する
PS C:\> $AutoBackupConfig = New-AzureVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri $StorageUrl -StorageKey $StorageAccountKeySecure
PS C:\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoBackupSettings $AutoBackupConfig | Update-AzureRmVM最初のコマンドは、New-AzureVMSqlServerAutoBackupConfig コマンドレットを使用して構成オブジェクトを作成します。 このコマンドは、$AutoBackupConfig変数に構成を格納します。 2 番目のコマンドは、Service02 という名前のサービスで VirtualMachine11 という名前の仮想マシンを取得し、現在のコマンドレットに渡します。 現在のコマンドレットは、仮想マシンの自動バックアップ設定を$AutoBackupConfigに設定します。 このコマンドは、仮想マシンを Update-AzureRmVM コマンドレットに渡します。
例 3: 仮想マシンで SQL Server 拡張機能を無効にする
PS C:\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Disableこのコマンドは、Service03 上の VirtualMachine08 という名前の仮想マシンを取得し、現在のコマンドレットに渡します。 このコマンドを実行すると、その仮想マシン上の SQL Server 仮想マシン拡張機能が無効になります。
例 4: 特定の仮想マシンで SQL Server 拡張機能をアンインストールする
PS C:\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Uninstallこのコマンドは、Service03 上の VirtualMachine08 という名前の仮想マシンを取得し、現在のコマンドレットに渡します。 このコマンドは、その仮想マシン上の SQL Server 仮想マシン拡張機能をアンインストールします。
パラメーター
-AutoBackupSettings
SQL Server の自動バックアップ設定を指定します。 AutoBackup設定 オブジェクトを作成するには、New-AzureVMSqlServerAutoBackupConfig コマンドレットを使用します。
| Type: | AutoBackupSettings |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AutoPatchingSettings
SQL Server の自動修正プログラムの設定を指定します。 AutoPatching設定 オブジェクトを作成するには、New-AzureVMSqlServerAutoPatchingConfig コマンドレットを使用します。
| Type: | AutoPatchingSettings |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
-KeyVaultCredentialSettings
| Type: | KeyVaultCredentialSettings |
| Position: | 7 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Location
仮想マシンの場所を指定します。
| Type: | String |
| Position: | 8 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
拡張機能の SQL Server の名前を指定します。
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
仮想マシンのリソース グループの名前を指定します。
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Version
SQL Server 拡張機能のバージョンを指定します。
| Type: | String |
| Aliases: | HandlerVersion |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMName
このコマンドレットで SQL Server 拡張機能を設定する仮想マシンの名前を指定します。
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |