Resource Groups - Export Template

Acquisisce il gruppo di risorse specificato come modello.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

ID sottoscrizione di Microsoft Azure.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
options

string

Opzioni del modello di esportazione. Elenco in formato CSV contenente zero o più degli elementi seguenti: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'

resources

string[]

ID delle risorse per filtrare l'esportazione. Per esportare tutte le risorse, specificare una matrice con una singola voce '*'.

Risposte

Nome Tipo Descrizione
200 OK

ResourceGroupExportResult

OK: restituisce il risultato dell'esportazione.

202 Accepted

Accettato

Other Status Codes

CloudError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Export a resource group
Export a resource group with filtering

Export a resource group

Esempio di richiesta

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

Risposta di esempio

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

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
CloudError

Risposta di errore per una richiesta di gestione delle risorse.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorResponse

Risposta di errore

ExportTemplateRequest

Esportare i parametri di richiesta del modello del gruppo di risorse.

ResourceGroupExportResult

Risultato dell'esportazione del gruppo di risorse.

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

Nome Tipo Descrizione
error

ErrorResponse

Risposta di errore
Risposta di errore comune per tutte le API Resource Manager di Azure per restituire i dettagli dell'errore per le operazioni non riuscite. Segue anche il formato di risposta di errore OData.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorResponse[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ExportTemplateRequest

Esportare i parametri di richiesta del modello del gruppo di risorse.

Nome Tipo Descrizione
options

string

Opzioni del modello di esportazione. Elenco in formato CSV contenente zero o più degli elementi seguenti: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'

resources

string[]

ID delle risorse per filtrare l'esportazione. Per esportare tutte le risorse, specificare una matrice con una singola voce '*'.

ResourceGroupExportResult

Risultato dell'esportazione del gruppo di risorse.

Nome Tipo Descrizione
error

ErrorResponse

Risposta di errore
Errore di esportazione del modello.

template

object

Contenuto del modello.