Delen via

Resource Groups - Export Template

Service:
Resource Management
API-versie:
2021-04-01

Legt de opgegeven resourcegroep vast als een sjabloon.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId
 path True

string

De microsoft Azure-abonnements-id.
api-version
 query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Type Description
options

string

De exportsjabloonopties. Een door CSV opgemaakte lijst met nul of meer van de volgende items: IncludeParameterDefaultValue, IncludeComments, SkipResourceNameParameterization, SkipAllParameterization
resources

string[]

De id's van de resources om de export te filteren. Als u alle resources wilt exporteren, geeft u een matrix op met één vermelding *.

Antwoorden

Name Type Description
200 OK

ResourceGroupExportResult

OK: retourneert het resultaat van de export.
202 Accepted

Geaccepteerd
Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Export a resource group
Export a resource group with filtering

Export a resource group

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
CloudError

Een foutbericht voor een aanvraag voor resourcebeheer.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorResponse

Foutreactie
ExportTemplateRequest

Aanvraagparameters voor resourcegroepensjabloon exporteren.
ResourceGroupExportResult

Exportresultaat van resourcegroep.

CloudError

Object

Een foutbericht voor een aanvraag voor resourcebeheer.

Name Type Description
error

ErrorResponse

Foutreactie
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactie-indeling.)

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorResponse

Object

Foutreactie

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorResponse[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ExportTemplateRequest

Object

Aanvraagparameters voor resourcegroepensjabloon exporteren.

Name Type Description
options

string

De exportsjabloonopties. Een door CSV opgemaakte lijst met nul of meer van de volgende items: IncludeParameterDefaultValue, IncludeComments, SkipResourceNameParameterization, SkipAllParameterization
resources

string[]

De id's van de resources om de export te filteren. Als u alle resources wilt exporteren, geeft u een matrix op met één vermelding *.

ResourceGroupExportResult

Object

Exportresultaat van resourcegroep.

Name Type Description
error

ErrorResponse

Foutreactie
De fout bij het exporteren van de sjabloon.
template

object

De sjablooninhoud.