Export-AzResourceGroup

リファレンス

モジュール:: Az.Resources

リソースグループをテンプレートとしてキャプチャし、ファイルに保存します。

構文

Export-AzResourceGroup
      -ResourceGroupName <String>
      [-Path <String>]
      [-IncludeParameterDefaultValue]
      [-IncludeComments]
      [-SkipResourceNameParameterization]
      [-SkipAllParameterization]
      [-Resource <String[]>]
      [-Force]
      [-ApiVersion <String>]
      [-Pre]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Export-AzResourceGroup コマンドレットは、指定されたリソースグループをテンプレートとしてキャプチャし、JSON ファイルに保存します。これは、リソースグループにリソースを既に作成し、テンプレートに基づくデプロイを使用する利点を活用したいシナリオで役立ちます。このコマンドレットを使用すると、リソースグループ内の既存のリソースのテンプレートを簡単に生成できます。このコマンドレットがテンプレートの一部を生成できない場合があります。失敗したリソースが警告メッセージによって通知されます。テンプレートは、成功した部分に対して引き続き生成されます。

例

例 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 ファイルに保存します。生成されたテンプレートには、生成されたパラメーターは含まれません。

パラメーター

-ApiVersion

使用するリソースプロバイダー API のバージョンを指定します。指定しない場合は、最新の API バージョンが使用されます。

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-IncludeComments

この操作によって、コメントを含むテンプレートがエクスポートされることを示します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-IncludeParameterDefaultValue

この操作によって、既定値を使用してテンプレートパラメーターがエクスポートされることを示します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

テンプレートファイルの出力パスを指定します。

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Pre

使用する API バージョンを自動的に決定するときに、このコマンドレットがプレリリース API バージョンを使用することを示します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Resource

結果をフィルター処理する resourceId の一覧。

Type:	String[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

エクスポートするリソースグループの名前を指定します。

Type:	String
Aliases:	ResourceGroup
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-SkipAllParameterization

すべてのパラメーター化をスキップします。

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipResourceNameParameterization

リソース名のパラメーター化をスキップします。

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

String

出力

PSObject

Get-AzResourceGroup