Partager via

Resource Groups - Export Template

Service:
Resource Management
Version de l’API:
2021-04-01

Capture le groupe de ressources spécifié en tant que modèle.

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

Paramètres d’URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId
 path True

string

ID d’abonnement Microsoft Azure.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Corps de la requête

Nom Type Description
options

string

Options de modèle d’exportation. Liste au format CSV contenant zéro ou plusieurs des éléments suivants : « IncludeParameterDefaultValue », « IncludeComments », « SkipResourceNameParameterization », « SkipAllParameterization »
resources

string[]

ID des ressources pour filtrer l’exportation. Pour exporter toutes les ressources, fournissez un tableau avec une entrée unique « * ».

Réponses

Nom Type Description
200 OK

ResourceGroupExportResult

OK : retourne le résultat de l’exportation.
202 Accepted

Accepté
Other Status Codes

CloudError

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Couler: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Export a resource group
Export a resource group with filtering

Export a resource group

Demande d’échantillon

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

Exemple de réponse

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

Demande d’échantillon

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

Exemple de réponse

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

Définitions

Nom Description
CloudError

Réponse d’erreur pour une demande de gestion des ressources.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse

Réponse d’erreur
ExportTemplateRequest

Exporter les paramètres de demande de modèle de groupe de ressources.
ResourceGroupExportResult

Résultat de l’exportation du groupe de ressources.

CloudError

Objet

Réponse d’erreur pour une demande de gestion des ressources.

Nom Type Description
error

ErrorResponse

Réponse d’erreur
Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorResponse

Objet

Réponse d’erreur

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorResponse[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ExportTemplateRequest

Objet

Exporter les paramètres de demande de modèle de groupe de ressources.

Nom Type Description
options

string

Options de modèle d’exportation. Liste au format CSV contenant zéro ou plusieurs des éléments suivants : « IncludeParameterDefaultValue », « IncludeComments », « SkipResourceNameParameterization », « SkipAllParameterization »
resources

string[]

ID des ressources pour filtrer l’exportation. Pour exporter toutes les ressources, fournissez un tableau avec une entrée unique « * ».

ResourceGroupExportResult

Objet

Résultat de l’exportation du groupe de ressources.

Nom Type Description
error

ErrorResponse

Réponse d’erreur
Erreur d’exportation du modèle.
template

object

Contenu du modèle.