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 cmdlet 将指定的资源组捕获为模板,并将其保存到 JSON 或 Bicep 文件中。在已在资源组中创建某些资源,然后想要利用模板支持的部署的优势时,这非常有用。
此 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 文件中。 生成的模板不包含任何生成的参数。
示例 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 |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Confirm
在运行 cmdlet 之前,提示你进行确认。
参数属性
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-DefaultProfile
用于与 azure 通信的凭据、帐户、租户和订阅
参数属性
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Force
强制命令运行而不要求用户确认。
参数属性
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
指示此操作使用注释导出模板。
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-IncludeParameterDefaultValue
指示此操作将导出具有默认值的模板参数。
参数属性
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
指定导出的模板的格式。 支持的值为“Json”和“Bicep”。
类型: | String
|
默认值: | Json |
支持通配符: | False |
不显示: | False |
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Path
指定模板文件的输出路径。
参数属性
类型: | String
|
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | True |
来自剩余参数的值: | False |
-Pre
指示当自动确定要使用的 API 版本时,此 cmdlet 使用预发行 API 版本。
参数属性
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Resource
要筛选结果的 resourceId 列表。
参数属性
类型: | String[]
|
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-ResourceGroupName
指定要导出的资源组的名称。
参数属性
类型: | String
|
默认值: | None |
支持通配符: | False |
不显示: | False |
别名: | ResourceGroup |
参数集
(All)
Position: | Named |
必需: | True |
来自管道的值: | False |
来自管道的值(按属性名称): | True |
来自剩余参数的值: | False |
-SkipAllParameterization
跳过所有参数化。
参数属性
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-SkipResourceNameParameterization
跳过资源名称参数化。
参数属性
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。
命令脚本未运行。
参数属性
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输出