通过

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

Resource Groups - Export Template

  • 参考
服务:
Resource Management
API 版本:
2021-04-01

将指定的资源组捕获为模板。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate?api-version=2021-04-01

URI 参数

名称 在 必需 类型 说明
resourceGroupName
 path True

string

资源组的名称。 此名称不区分大小写。
subscriptionId
 path True

string

Microsoft Azure 订阅 ID。
api-version
 query True

string

要用于此操作的 API 版本。

请求正文

名称 类型 说明
options

string

导出模板选项。 CSV 格式的列表，其中包含以下零个或多个内容：“IncludeParameterDefaultValue”、“IncludeComments”、“SkipResourceNameParameterization”、“SkipAllParameterization”
resources

string[]

要筛选导出依据的资源的 ID。 若要导出所有资源，请提供包含单个条目“*”的数组。

响应

名称 类型 说明
200 OK

ResourceGroupExportResult

确定 - 返回导出的结果。
202 Accepted

已接受
Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Export a resource group
Export a resource group with filtering

Export a resource group

示例请求

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/exportTemplate?api-version=2021-04-01

{
  "resources": [
    "*"
  ],
  "options": "IncludeParameterDefaultValue,IncludeComments"
}

示例响应

状态代码:
202 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01
状态代码:
200 
{
  "template": {
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
      "myResourceType_myFirstResource_name": {
        "defaultValue": "myFirstResource",
        "type": "String"
      },
      "myResourceType_mySecondResource_name": {
        "defaultValue": "mySecondResource",
        "type": "String"
      },
      "myResourceType_myFirstResource_secret": {
        "defaultValue": null,
        "type": "SecureString"
      }
    },
    "variables": {},
    "resources": [
      {
        "type": "My.RP/myResourceType",
        "apiVersion": "2019-01-01",
        "name": "[parameters('myResourceType_myFirstResource_name')]",
        "location": "West US",
        "properties": {
          "secret": "[parameters('myResourceType_myFirstResource_secret')]"
        }
      },
      {
        "type": "My.RP/myResourceType",
        "apiVersion": "2019-01-01",
        "name": "[parameters('myResourceType_mySecondResource_name')]",
        "location": "West US",
        "properties": {
          "customProperty": "hello!"
        }
      }
    ]
  },
  "error": {
    "code": "ExportTemplateCompletedWithErrors",
    "message": "Export template operation completed with errors. Some resources were not exported. Please see details for more information.",
    "details": []
  }
}

Export a resource group with filtering

示例请求

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/exportTemplate?api-version=2021-04-01

{
  "resources": [
    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/My.RP/myResourceType/myFirstResource"
  ],
  "options": "SkipResourceNameParameterization"
}

示例响应

状态代码:
202 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01
状态代码:
200 
{
  "template": {
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
      "myResourceType_myFirstResource_secret": {
        "defaultValue": null,
        "type": "SecureString"
      }
    },
    "variables": {},
    "resources": [
      {
        "type": "My.RP/myResourceType",
        "apiVersion": "2019-01-01",
        "name": "myFirstResource",
        "location": "West US",
        "properties": {
          "secret": "[parameters('myResourceType_myFirstResource_secret')]"
        }
      }
    ]
  }
}

定义

名称 说明
CloudError

资源管理请求的错误响应。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorResponse

错误响应
ExportTemplateRequest

导出资源组模板请求参数。
ResourceGroupExportResult

资源组导出结果。

CloudError

资源管理请求的错误响应。

名称 类型 说明
error

ErrorResponse

错误响应
对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorResponse

错误响应

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorResponse[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ExportTemplateRequest

导出资源组模板请求参数。

名称 类型 说明
options

string

导出模板选项。 CSV 格式的列表，其中包含以下零个或多个内容：“IncludeParameterDefaultValue”、“IncludeComments”、“SkipResourceNameParameterization”、“SkipAllParameterization”
resources

string[]

要筛选导出依据的资源的 ID。 若要导出所有资源，请提供包含单个条目“*”的数组。

ResourceGroupExportResult

资源组导出结果。

名称 类型 说明
error

ErrorResponse

错误响应
模板导出错误。
template

object

模板内容。