Partilhar via

Export-AzTerraform

  • Referência
Módulo:
Az.Terraform

Exporta a configuração Terraform do(s) recurso(s) especificado(s).

Sintaxe

Export-AzTerraform
      [-SubscriptionId <String>]
      -ExportParameter <IBaseExportModel>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-AzTerraform
      [-SubscriptionId <String>]
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-AzTerraform
      [-SubscriptionId <String>]
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Exporta a configuração Terraform do(s) recurso(s) especificado(s).

Exemplos

Exemplo 1: Exportar recursos por ID de recurso

Export-AzTerraform -ExportParameter $(New-AzTerraformExportResourceObject -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-pwsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet")

AdditionalInfo    :
Code              :
Configuration     : terraform {
                      required_providers {
                        azurerm = {
                          source  = "azurerm"
                          version = "4.0.1"
                        }
                      }
                    }
                    provider "azurerm" {
                      features {}
                    }
                    resource "azurerm_virtual_network" "res-0" {
                      address_space           = ["10.0.0.0/16"]
                      bgp_community           = ""
                      dns_servers             = []
                      edge_zone               = ""
                      flow_timeout_in_minutes = 0
                      location                = "westus3"
                      name                    = "test-vnet"
                      resource_group_name     = "aztfy-pwsh-test-rg"
                      subnet = [{
                        address_prefixes                              = ["10.0.0.0/24"]
                        default_outbound_access_enabled               = false
                        delegation                                    = []
                        id                                            = "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-p
                    wsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
                        name                                          = "default"
                        private_endpoint_network_policies             = "Disabled"
                        private_link_service_network_policies_enabled = true
                        route_table_id                                = ""
                        security_group                                = ""
                        service_endpoint_policy_ids                   = []
                        service_endpoints                             = []
                      }]
                      tags = {}
                    }

Detail            :
EndTime           : 9/11/2024 2:32:17 AM
Errors            :
Id                : /subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.AzureTerraform/operationStatuses/00000000-0000-0000-0000-000000000002*A034E6455B3397057968069439403400471981A03C6A372DB86AB63D04A41AD4
Message           :
Name              : 00000000-0000-0000-0000-000000000002*A034E6455B3397057968069439403400471981A03C6A372DB86AB63D04A41AD4
PercentComplete   :
ResourceGroupName :
ResourceId        : /subscriptions/00000000-0000-0000-0000-000000000001/providers/
SkippedResource   :
StartTime         : 9/11/2024 2:32:14 AM
Status            : Succeeded
Target            :

Exportar um recurso pelo seu ID de recurso

Exemplo 2: Exportar um grupo de recursos pelo seu nome

Export-AzTerraform -ExportParameter $(New-AzTerraformExportResourceGroupObject -ResourceGroupName "aztfy-pwsh-test-rg")

AdditionalInfo    :
Code              :
Configuration     :
Detail            :
EndTime           : 9/11/2024 2:45:04 AM
Errors            :
Id                : /subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.AzureTerraform/operationStatuses/96e64a19-eed2-4d98-9d5
                    a-58c0b8a0aff0*A034E6455B3397057968069439403400471981A03C6A372DB86AB63D04A41AD4
Message           :
Name              : 96e64a19-eed2-4d98-9d5a-58c0b8a0aff0*A034E6455B3397057968069439403400471981A03C6A372DB86AB63D04A41AD4
PercentComplete   :
ResourceGroupName :
ResourceId        : /subscriptions/00000000-0000-0000-0000-000000000001/providers/
SkippedResource   : {/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups//subscriptions/00000000-0000-0000-0000-000000000001/resourc
                    eGroups/aztfy-pwsh-test-rg}
StartTime         : 9/11/2024 2:45:02 AM
Status            : Succeeded
Target            :

Exportar um grupo de recursos pelo seu nome

Exemplo 3: Exportar recursos por uma consulta ARG

Export-AzTerraform -ExportParameter $(New-AzTerraformExportQueryObject -Query "type =~ `"microsoft.network/virtualnetworks`"")

AdditionalInfo    :
Code              :
Configuration     : terraform {
                      required_providers {
                        azurerm = {
                          source  = "azurerm"
                          version = "4.0.1"
                        }
                      }
                    }
                    provider "azurerm" {
                      features {}
                    }
                    resource "azurerm_virtual_network" "res-0" {
                      address_space           = ["10.0.0.0/16"]
                      bgp_community           = ""
                      dns_servers             = []
                      edge_zone               = ""
                      flow_timeout_in_minutes = 0
                      location                = "westus3"
                      name                    = "test-vnet"
                      resource_group_name     = "aztfy-pwsh-test-rg"
                      subnet = [{
                        address_prefixes                              = ["10.0.0.0/24"]
                        default_outbound_access_enabled               = false
                        delegation                                    = []
                        id                                            = "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-p
                    wsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
                        name                                          = "default"
                        private_endpoint_network_policies             = "Disabled"
                        private_link_service_network_policies_enabled = true
                        route_table_id                                = ""
                        security_group                                = ""
                        service_endpoint_policy_ids                   = []
                        service_endpoints                             = []
                      }]
                      tags = {}
                    }

Detail            :
EndTime           : 9/11/2024 7:40:17 AM
Errors            :
Id                : /subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.AzureTerraform/operationStatuses/5cf722ab-84a1-4a94-a58
                    6-356b6db6bb86*BED64399B6CC85896CB12E2360BF08E2FDF3132D587CEED230628920BA5D959D
Message           :
Name              : 5cf722ab-84a1-4a94-a586-356b6db6bb86*BED64399B6CC85896CB12E2360BF08E2FDF3132D587CEED230628920BA5D959D
PercentComplete   :
ResourceGroupName :
ResourceId        : /subscriptions/00000000-0000-0000-0000-000000000001/providers/
SkippedResource   :
StartTime         : 9/11/2024 7:40:12 AM
Status            : Succeeded
Target            :

Exportar recursos por uma consulta ARG

Parâmetros

-AsJob

Executar o comando como um trabalho

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DefaultProfile

O parâmetro DefaultProfile não é funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Tipo:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ExportParameter

O parâmetro de exportação de base

Tipo:IBaseExportModel
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-JsonFilePath

Caminho do arquivo Json fornecido para a operação de exportação

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-JsonString

Cadeia de caracteres Json fornecida para a operação de exportação

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-NoWait

Execute o comando de forma assíncrona

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-SubscriptionId

A ID da assinatura de destino. O valor deve ser um UUID.

Tipo:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

Saídas