你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 cmdlet 将指定的资源组捕获为模板，并将其保存到 JSON 文件中。在已在资源组中创建某些资源，然后想要利用模板支持的部署的优势时，这非常有用。 此 cmdlet 通过为资源组中的现有资源生成模板，可以轻松开始。 在某些情况下，此 cmdlet 无法生成模板的某些部分。 警告消息将通知你资源失败。 仍将为成功部件生成模板。

示例

示例 1：导出资源组

Export-AzResourceGroup -ResourceGroupName "TestGroup"

此命令将名为 TestGroup 的资源组捕获为模板，并将其保存到当前目录中的 JSON 文件中。

示例 2：从资源组导出单个资源

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”资源组中的两个资源捕获为模板，并将其保存到当前目录中的 JSON 文件中。 生成的模板不包含任何生成的参数。

参数

-ApiVersion

指定要使用的资源提供程序 API 的版本。 如果未指定，则使用最新的 API 版本。

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

-Confirm

提示你在运行 cmdlet 之前进行确认。

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 版本时，此 cmdlet 使用预发行 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

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

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

输入

String

输出

PSObject