Поделиться через


Resource Groups - Export Template

Записывает указанную группу ресурсов в виде шаблона.

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.

subscriptionId
path True

string

Идентификатор подписки Microsoft Azure.

api-version
query True

string

Версия API, используемая для этой операции.

Текст запроса

Имя Тип Описание
options

string

Параметры шаблона экспорта. Список в формате CSV, содержащий ноль или более следующих значений: IncludeParameterDefaultValue, IncludeComments, SkipResourceNameParameterization, SkipAllParameterization.

resources

string[]

Идентификаторы ресурсов для фильтрации экспорта. Чтобы экспортировать все ресурсы, укажите массив с одной записью "*".

Ответы

Имя Тип Описание
200 OK

ResourceGroupExportResult

ОК — возвращает результат экспорта.

202 Accepted

Принято

Other Status Codes

CloudError

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: 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"
}

Пример ответа

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01
{
  "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"
}

Пример ответа

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01
{
  "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

Ответ на ошибку
Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа на ошибку 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[]

Идентификаторы ресурсов для фильтрации экспорта. Чтобы экспортировать все ресурсы, укажите массив с одной записью "*".

ResourceGroupExportResult

Результат экспорта группы ресурсов.

Имя Тип Описание
error

ErrorResponse

Ответ на ошибку
Ошибка экспорта шаблона.

template

object

Содержимое шаблона.