Udostępnij przez

Resource Groups - Export Template

Usługa:
Resource Management
Wersja interfejsu API:
2021-04-01

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

Nazwa W Wymagane Typ Opis
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId
 path True

string

Identyfikator subskrypcji platformy Microsoft Azure.
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Typ Opis
options

string

Opcje szablonu eksportu. 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 do filtrowania eksportu według. Aby wyeksportować wszystkie zasoby, podaj tablicę z pojedynczym wpisem "*".

Odpowiedzi

Nazwa Typ Opis
200 OK

ResourceGroupExportResult

OK — zwraca wynik eksportu.
202 Accepted

Zaakceptowano
Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Export a resource group
Export a resource group with filtering

Export a resource group

Przykładowe zapytanie

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

Przykładowa odpowiedź

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

Przykładowe zapytanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
CloudError

Odpowiedź na błąd żądania zarządzania zasobami.
ErrorAdditionalInfo

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

Odpowiedź na błąd
ExportTemplateRequest

Eksportowanie parametrów żądania szablonu grupy zasobów.
ResourceGroupExportResult

Wynik eksportu grupy zasobów.

CloudError

Sprzeciwiać się

Odpowiedź na błąd żądania zarządzania zasobami.

Nazwa Typ Opis
error

ErrorResponse

Odpowiedź na błąd
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

ErrorAdditionalInfo

Sprzeciwiać się

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

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorResponse[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ExportTemplateRequest

Sprzeciwiać się

Eksportowanie parametrów żądania szablonu grupy zasobów.

Nazwa Typ Opis
options

string

Opcje szablonu eksportu. 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 do filtrowania eksportu według. Aby wyeksportować wszystkie zasoby, podaj tablicę z pojedynczym wpisem "*".

ResourceGroupExportResult

Sprzeciwiać się

Wynik eksportu grupy zasobów.

Nazwa Typ Opis
error

ErrorResponse

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

object

Zawartość szablonu.