Resource Groups - Export Template

Przechwytuje określoną grupę zasobów jako szablon.

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

Parametry identyfikatora URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True
  • string

Identyfikator Microsoft Azure subskrypcji.

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Name Type Description
options
  • string

Opcje eksportowania szablonu. Lista w formacie CSV zawierająca zero lub więcej z następujących elementów: "IncludeParameterDefaultValue", "IncludeComments", "SkipResourceNameParameterization", "SkipAllParameterization"

resources
  • string[]

Identyfikatory zasobów, według których ma być filtrowany eksport. Aby wyeksportować wszystkie zasoby, należy podać tablicę z pojedynczym wpisem "*".

Odpowiedzi

Name Type Description
200 OK

OK — zwraca wynik eksportu.

202 Accepted

Zaakceptowano

Other Status Codes

Odpowiedź o błędzie opisująca przyczynę błędu operacji.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifikować konto użytkownika

Przykłady

Export a resource group
Export a resource group with filtering

Export a resource group

Sample Request

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"
}

Sample Response

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

Sample Request

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"
}

Sample Response

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')]"
        }
      }
    ]
  }
}

Definicje

CloudError

Odpowiedź z błędem dla żądania zarządzania zasobami.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorResponse

Odpowiedź na błąd

ExportTemplateRequest

Wyeksportuj parametry żądania szablonu grupy zasobów.

ResourceGroupExportResult

Wynik eksportu grupy zasobów.

CloudError

Odpowiedź z błędem dla żądania zarządzania zasobami.

Name Type Description
error

Odpowiedź na błąd
Typowe błędy odpowiedzi dla wszystkich interfejsów API Azure Resource Manager zwracały szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest on również zgodny z formatem odpowiedzi o błędzie OData).

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Typ dodatkowych informacji.

ErrorResponse

Odpowiedź na błąd

Name Type Description
additionalInfo

Dodatkowe informacje o błędzie.

code
  • string

Kod błędu.

details

Szczegóły błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Element docelowy błędu.

ExportTemplateRequest

Wyeksportuj parametry żądania szablonu grupy zasobów.

Name Type Description
options
  • string

Opcje eksportowania szablonu. Lista w formacie CSV zawierająca zero lub więcej z następujących elementów: "IncludeParameterDefaultValue", "IncludeComments", "SkipResourceNameParameterization", "SkipAllParameterization"

resources
  • string[]

Identyfikatory zasobów, według których ma być filtrowany eksport. Aby wyeksportować wszystkie zasoby, należy podać tablicę z pojedynczym wpisem "*".

ResourceGroupExportResult

Wynik eksportu grupy zasobów.

Name Type Description
error

Odpowiedź na błąd
Błąd eksportu szablonu.

template
  • object

Zawartość szablonu.