Partilhar via

Resource Groups - Export Template

Serviço:
Resource Management
Versão da API:
2021-04-01

Captura o grupo de recursos especificado como um modelo.

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId
 path True

string

A ID de assinatura do Microsoft Azure.
api-version
 query True

string

A versão da API a ser usada para esta operação.

Corpo do Pedido

Name Tipo Description
options

string

As opções de modelo de exportação. Uma lista formatada em CSV contendo zero ou mais do seguinte: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'
resources

string[]

As IDs dos recursos pelos quais filtrar a exportação. Para exportar todos os recursos, forneça uma matriz com uma única entrada '*'.

Respostas

Name Tipo Description
200 OK

ResourceGroupExportResult

OK - Devolve o resultado da exportação.
202 Accepted

Aceito
Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Export a resource group
Export a resource group with filtering

Export a resource group

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorResponse

Resposta de erro
ExportTemplateRequest

Exportar parâmetros de solicitação de modelo de grupo de recursos.
ResourceGroupExportResult

Resultado da exportação do grupo de recursos.

CloudError

Object

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

Name Tipo Description
error

ErrorResponse

Resposta de erro
Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorResponse[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ExportTemplateRequest

Object

Exportar parâmetros de solicitação de modelo de grupo de recursos.

Name Tipo Description
options

string

As opções de modelo de exportação. Uma lista formatada em CSV contendo zero ou mais do seguinte: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'
resources

string[]

As IDs dos recursos pelos quais filtrar a exportação. Para exportar todos os recursos, forneça uma matriz com uma única entrada '*'.

ResourceGroupExportResult

Object

Resultado da exportação do grupo de recursos.

Name Tipo Description
error

ErrorResponse

Resposta de erro
O erro de exportação do modelo.
template

object

O conteúdo do modelo.