Export-AzResourceGroup
リソース グループをテンプレートとしてキャプチャし、ファイルに保存します。
構文
Default (既定)
Export-AzResourceGroup
-ResourceGroupName <String>
[-Path <String>]
[-IncludeParameterDefaultValue]
[-IncludeComments]
[-SkipResourceNameParameterization]
[-SkipAllParameterization]
[-Resource <String[]>]
[-OutputFormat <String>]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Export-AzResourceGroup コマンドレットは、指定されたリソース グループをテンプレートとしてキャプチャし、JSON または Bicep ファイルに保存します。これは、リソース グループにリソースを既に作成し、テンプレートベースのデプロイを使用する利点を活用したい場合に役立ちます。
このコマンドレットを使用すると、リソース グループ内の既存のリソースのテンプレートを簡単に生成できます。
このコマンドレットがテンプレートの一部の生成に失敗する場合があります。
失敗したリソースが警告メッセージによって通知されます。
成功したパーツのテンプレートは引き続き生成されます。
例
例 1: リソース グループをエクスポートする
Export-AzResourceGroup -ResourceGroupName "TestGroup"
このコマンドは、TestGroup という名前のリソース グループをテンプレートとしてキャプチャし、現在のディレクトリの JSON ファイルに保存します。
例 2: リソース グループから 1 つのリソースをエクスポートする
Export-AzResourceGroup -ResourceGroupName "TestGroup" -Resource "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"
このコマンドは、"TestGroup" リソース グループから "TestVirtualMachine" という名前の仮想マシン リソースをテンプレートとしてキャプチャし、現在のディレクトリの JSON ファイルに保存します。
例 3: リソース グループから選択したリソースをエクスポートする
Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -Resource @(
"/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVm",
"/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Network/networkInterfaces/TestNic"
)
このコマンドは、"TestGroup" リソース グループから 2 つのリソースをテンプレートとしてキャプチャし、現在のディレクトリの JSON ファイルに保存します。 生成されたテンプレートには、生成されたパラメーターは含まれません。
例 4: リソース グループを Bicep ファイルとしてエクスポートする
Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep
このコマンドは、TestGroup という名前のリソース グループをテンプレートとしてキャプチャし、現在のディレクトリの Bicep ファイルに保存します。
例 5: カスタム パスを使用してリソース グループを Bicep ファイルとしてエクスポートする
Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep -Path "C:\Templates\MyResourceGroup.bicep"
このコマンドは、TestGroup という名前のリソース グループをテンプレートとしてキャプチャし、指定したパスにある Bicep ファイルに保存します。
パラメーター
-ApiVersion
使用するリソース プロバイダー API のバージョンを指定します。
指定しない場合は、最新の API バージョンが使用されます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
この操作で、テンプレートをコメント付きでエクスポートすることを示します。
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IncludeParameterDefaultValue
この操作によってテンプレート パラメーターが既定値と共にエクスポートされることを示します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
エクスポートされたテンプレートの形式を指定します。 サポートされている値は、"Json" と "Bicep" です。
| 型: | String
|
| 規定値: | Json |
| ワイルドカードのサポート: | False |
| DontShow: | False |
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Path
テンプレート ファイルの出力パスを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Pre
使用する API のバージョンを自動的に決定するときに、このコマンドレットがプレリリース API バージョンを使用することを示します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Resource
結果をフィルター処理する resourceId の一覧。
パラメーターのプロパティ
| 型: | String[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
エクスポートするリソース グループの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | リソースグループ （ResourceGroup） |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SkipAllParameterization
すべてのパラメーター化をスキップします。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SkipResourceNameParameterization
リソース名のパラメーター化をスキップします。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
