Terraform - Export Terraform

Servizio:: Terraform

Versione API:: 2025-06-01-preview

Esporta la configurazione Terraform delle risorse specificate.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AzureTerraform/exportTerraform?api-version=2025-06-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
ExportQuery	Parametro di esportazione per le risorse sottoposte a query da ARG (Azure Resource Graph)
ExportResource	Parametro di esportazione per singole risorse.
ExportResourceGroup	Parametro di esportazione per un gruppo di risorse

ExportQuery

Parametro di esportazione per le risorse sottoposte a query da ARG (Azure Resource Graph)

Nome	Necessario	Tipo	Descrizione
query	True	string	ARG in cui predicato. Si noti che è possibile combinare più condizioni in un predicato `where`, ad esempio `resourceGroup =~ "my-rg" and type =~ "microsoft.network/virtualnetworks"`
type	True	string: ExportQuery	Tipo di parametro
authorizationScopeFilter		authorizationScopeFilter	Parametro Filtro ambito ARG
excludeAzureResource		string[]	Escludere le risorse dall'esportazione in base al modello di ID risorsa di Azure (espressione regolare senza distinzione tra maiuscole e minuscole)
excludeTerraformResource		string[]	Escludere le risorse dall'esportazione in base al tipo di risorsa Terraform
fullProperties		boolean	Se restituire tutte le proprietà non calcolate nella configurazione di Terraform generata? Questo probabilmente richiede modifiche manuali per renderlo valido
maskSensitive		boolean	Mascherare gli attributi sensibili nella configurazione di Terraform
namePattern		string	Modello di nome delle risorse terraform
recursive		boolean	Indica se elencare in modo ricorsivo le risorse figlio del risultato della query
table		string	Nome della tabella ARG
targetProvider		targetProvider	Provider Terraform di azure di destinazione

ExportResource

Parametro di esportazione per singole risorse.

Nome	Necessario	Tipo	Descrizione
resourceIds	True	string[] (arm-id)	ID della risorsa da esportare
type	True	string: ExportResource	Tipo di parametro
excludeAzureResource		string[]	Escludere le risorse dall'esportazione in base al modello di ID risorsa di Azure (espressione regolare senza distinzione tra maiuscole e minuscole)
excludeTerraformResource		string[]	Escludere le risorse dall'esportazione in base al tipo di risorsa Terraform
fullProperties		boolean	Se restituire tutte le proprietà non calcolate nella configurazione di Terraform generata? Questo probabilmente richiede modifiche manuali per renderlo valido
maskSensitive		boolean	Mascherare gli attributi sensibili nella configurazione di Terraform
namePattern		string	Modello di nome delle risorse terraform
resourceName		string	Nome della risorsa Terraform. Funziona solo quando `resourceIds` contiene un solo elemento.
resourceType		string	Tipo di risorsa Terraform. Funziona solo quando `resourceIds` contiene un solo elemento.
targetProvider		targetProvider	Provider Terraform di azure di destinazione

ExportResourceGroup

Parametro di esportazione per un gruppo di risorse

Nome	Necessario	Tipo	Descrizione
resourceGroupName	True	string	Nome del gruppo di risorse da esportare
type	True	string: ExportResourceGroup	Tipo di parametro
excludeAzureResource		string[]	Escludere le risorse dall'esportazione in base al modello di ID risorsa di Azure (espressione regolare senza distinzione tra maiuscole e minuscole)
excludeTerraformResource		string[]	Escludere le risorse dall'esportazione in base al tipo di risorsa Terraform
fullProperties		boolean	Se restituire tutte le proprietà non calcolate nella configurazione di Terraform generata? Questo probabilmente richiede modifiche manuali per renderlo valido
maskSensitive		boolean	Mascherare gli attributi sensibili nella configurazione di Terraform
namePattern		string	Modello di nome delle risorse terraform
targetProvider		targetProvider	Provider Terraform di azure di destinazione

Risposte

Nome	Tipo	Descrizione
202 Accepted		Operazione di risorsa accettata. Intestazioni Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

202 Accepted

Operazione di risorsa accettata.

Intestazioni

Azure-AsyncOperation: string
Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

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

ExportTerraform

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzureTerraform/exportTerraform?api-version=2025-06-01-preview

{
  "type": "ExportResourceGroup",
  "resourceGroupName": "rg1"
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Terraform.Models;
using Azure.ResourceManager.Terraform;

// Generated from example definition: 2025-06-01-preview/ExportTerraform.json
// this example is just showing the usage of "Terraform_ExportTerraform" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
CommonExportProperties body = new ExportResourceGroupTerraform("rg1");
ArmOperation<TerraformOperationStatus> lro = await subscriptionResource.ExportTerraformAsync(WaitUntil.Completed, body);
TerraformOperationStatus result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzureTerraform/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AzureTerraform/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2025-06-01-preview

Definizioni

Nome	Descrizione
authorizationScopeFilter	Parametro di filtro dell'ambito di autorizzazione di Azure Resource Graph
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ExportQuery	Parametro di esportazione per le risorse sottoposte a query da ARG (Azure Resource Graph)
ExportResource	Parametro di esportazione per singole risorse.
ExportResourceGroup	Parametro di esportazione per un gruppo di risorse
targetProvider	Provider Terraform di azure di destinazione
Type	Tipo di parametro

authorizationScopeFilter

Enumerazione

Parametro di filtro dell'ambito di autorizzazione di Azure Resource Graph

Valore	Descrizione
AtScopeAboveAndBelow	Restituisce le assegnazioni per l'ambito specificato, tutti gli ambiti padre e tutti gli ambiti figlio.
AtScopeAndAbove	Restituisce le assegnazioni per l'ambito specificato e tutti gli ambiti padre, ma non per gli ambiti figlio.
AtScopeAndBelow	Restituisce le assegnazioni per l'ambito specificato e per tutti gli ambiti figlio.
AtScopeExact	Restituisce le assegnazioni solo per l'ambito specificato; non sono inclusi ambiti padre o figlio.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ExportQuery

Object

Parametro di esportazione per le risorse sottoposte a query da ARG (Azure Resource Graph)

Nome	Tipo	Valore predefinito	Descrizione
authorizationScopeFilter	authorizationScopeFilter		Parametro Filtro ambito ARG
excludeAzureResource	string[]		Escludere le risorse dall'esportazione in base al modello di ID risorsa di Azure (espressione regolare senza distinzione tra maiuscole e minuscole)
excludeTerraformResource	string[]		Escludere le risorse dall'esportazione in base al tipo di risorsa Terraform
fullProperties	boolean	True	Se restituire tutte le proprietà non calcolate nella configurazione di Terraform generata? Questo probabilmente richiede modifiche manuali per renderlo valido
maskSensitive	boolean	True	Mascherare gli attributi sensibili nella configurazione di Terraform
namePattern	string	res-	Modello di nome delle risorse terraform
query	string		ARG in cui predicato. Si noti che è possibile combinare più condizioni in un predicato `where`, ad esempio `resourceGroup =~ "my-rg" and type =~ "microsoft.network/virtualnetworks"`
recursive	boolean	False	Indica se elencare in modo ricorsivo le risorse figlio del risultato della query
table	string	Resources	Nome della tabella ARG
targetProvider	targetProvider	azurerm	Provider Terraform di azure di destinazione
type	string: ExportQuery		Tipo di parametro

ExportResource

Object

Parametro di esportazione per singole risorse.

Nome	Tipo	Valore predefinito	Descrizione
excludeAzureResource	string[]		Escludere le risorse dall'esportazione in base al modello di ID risorsa di Azure (espressione regolare senza distinzione tra maiuscole e minuscole)
excludeTerraformResource	string[]		Escludere le risorse dall'esportazione in base al tipo di risorsa Terraform
fullProperties	boolean	True	Se restituire tutte le proprietà non calcolate nella configurazione di Terraform generata? Questo probabilmente richiede modifiche manuali per renderlo valido
maskSensitive	boolean	True	Mascherare gli attributi sensibili nella configurazione di Terraform
namePattern	string	res-	Modello di nome delle risorse terraform
resourceIds	string[] (arm-id)		ID della risorsa da esportare
resourceName	string	res-0	Nome della risorsa Terraform. Funziona solo quando `resourceIds` contiene un solo elemento.
resourceType	string		Tipo di risorsa Terraform. Funziona solo quando `resourceIds` contiene un solo elemento.
targetProvider	targetProvider	azurerm	Provider Terraform di azure di destinazione
type	string: ExportResource		Tipo di parametro

ExportResourceGroup

Object

Parametro di esportazione per un gruppo di risorse

Nome	Tipo	Valore predefinito	Descrizione
excludeAzureResource	string[]		Escludere le risorse dall'esportazione in base al modello di ID risorsa di Azure (espressione regolare senza distinzione tra maiuscole e minuscole)
excludeTerraformResource	string[]		Escludere le risorse dall'esportazione in base al tipo di risorsa Terraform
fullProperties	boolean	True	Se restituire tutte le proprietà non calcolate nella configurazione di Terraform generata? Questo probabilmente richiede modifiche manuali per renderlo valido
maskSensitive	boolean	True	Mascherare gli attributi sensibili nella configurazione di Terraform
namePattern	string	res-	Modello di nome delle risorse terraform
resourceGroupName	string		Nome del gruppo di risorse da esportare
targetProvider	targetProvider	azurerm	Provider Terraform di azure di destinazione
type	string: ExportResourceGroup		Tipo di parametro

targetProvider

Enumerazione

Provider Terraform di azure di destinazione

Valore	Descrizione
azapi	https://registry.terraform.io/providers/Azure/azapi/latest
azurerm	https://registry.terraform.io/providers/hashicorp/azurerm/latest

Type

Enumerazione

Tipo di parametro

Valore	Descrizione
ExportQuery
ExportResource
ExportResourceGroup

Condividi tramite

Terraform - Export Terraform

Parametri dell'URI

Corpo della richiesta

ExportQuery

ExportResource

ExportResourceGroup

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ExportTerraform

Esempio di richiesta

Risposta di esempio

Definizioni

authorizationScopeFilter

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExportQuery

ExportResource

ExportResourceGroup

targetProvider

Type