Set-AzVMSqlServerExtension
仮想マシン上の Azure SQL Server 拡張機能を設定します。
構文
Default (既定)
Set-AzVMSqlServerExtension
[[-Version] <String>]
[-ResourceGroupName] <String>
[-VMName] <String>
[[-Name] <String>]
[[-AutoPatchingSettings] <AutoPatchingSettings>]
[[-AutoBackupSettings] <AutoBackupSettings>]
[[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>]
[[-Location] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Set-AzVMSqlServerExtension コマンドレットは、仮想マシンに AzureSQL Server 拡張機能を設定します。
例
例 1: 仮想マシンで自動修正プログラムの設定を行う
$AutoPatchingConfig = New-AzVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important"
Get-AzVM -ResourceGroupName "testrg" -Name "VirtualMachine11" | Set-AzVMSqlServerExtension -AutoPatchingSettings $AutoPatchingConfig | Update-AzVM
最初のコマンドでは、 New-AzVMSqlServerAutoPatchingConfig コマンドレットを使用して構成オブジェクトを作成します。
このコマンドは、$AutoPatchingConfig変数に構成を格納します。
2 番目のコマンドは、Get-AzVM コマンドレットを使用して、リソース グループ testrg 内の VirtualMachine11 という名前の仮想マシンを取得します。
コマンドは、パイプライン演算子を使用して、そのオブジェクトを現在のコマンドレットに渡します。
現在のコマンドレットは、仮想マシンの$AutoPatchingConfigで自動修正プログラムの設定を行います。
このコマンドは、仮想マシンを Update-AzVM コマンドレットに渡します。
例 2: 仮想マシンで自動バックアップ設定を設定する
$AutoBackupConfig = New-AzVMSqlServerAutoBackupConfig -Enable -RetentionPeriodInDays 10 -StorageUri $StorageUrl -StorageKey $StorageAccountKeySecure
Get-AzVM -ResourceGroupName "testrg" -Name "VirtualMachine11" | Set-AzVMSqlServerExtension -AutoBackupSettings $AutoBackupConfig | Update-AzVM
最初のコマンドは、 New-AzVMSqlServerAutoBackupConfig コマンドレットを使用して構成オブジェクトを作成します。
このコマンドは、$AutoBackupConfig変数に構成を格納します。
2 番目のコマンドは、リソース グループ の testrg で VirtualMachine11 という名前の仮想マシンを取得し、現在のコマンドレットに渡します。
現在のコマンドレットは、仮想マシンの自動バックアップ設定を$AutoBackupConfigに設定します。
このコマンドは、仮想マシンを Update-AzVM コマンドレットに渡します。
パラメーター
-AutoBackupSettings
SQL Server の自動バックアップ設定を指定します。
AutoBackupSettings オブジェクトを作成するには、New-AzVMSqlServerAutoBackupConfig コマンドレットを使用します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | 6 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-AutoPatchingSettings
SQL Server の自動修正プログラムの設定を指定します。
AutoPatchingSettings オブジェクトを作成するには、New-AzVMSqlServerAutoPatchingConfig コマンドレットを使用します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | 5 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-KeyVaultCredentialSettings
Set-AzVMSqlServerExtension コマンドレットは、仮想マシンに AzureSQL Server 拡張機能を設定します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | 7 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Location
仮想マシンの場所を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 8 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Name
拡張機能の SQL Server の名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 4 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ResourceGroupName
仮想マシンのリソース グループの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Version
SQL Server 拡張機能のバージョンを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | HandlerVersion |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-VMName
このコマンドレットで SQL Server 拡張機能を設定する仮想マシンの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 3 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力