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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

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

-DefaultProfile

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

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

-Force

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

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

-IncludeComments

この操作で、テンプレートをコメント付きでエクスポートすることを示します。

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

-IncludeParameterDefaultValue

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

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

-Path

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

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

-Pre

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

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

-Resource

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

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

-ResourceGroupName

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

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

-SkipAllParameterization

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

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

-SkipResourceNameParameterization

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

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

-WhatIf

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

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

入力

String

出力

PSObject