Export-AzTerraform
Exports the Terraform configuration of the specified resource(s).
Syntax
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
Exports the Terraform configuration of the specified resource(s).
Examples
Example 1: Export Resources by Resource Id
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 :Export a resource by its resource ID
Example 2: Export a Resource Group by its name
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 :Export a resource group by its name
Example 3: Export resources by an ARG query
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 :Export resources by an ARG query
Parameters
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExportParameter
The base export parameter
| Type: | IBaseExportModel |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JsonFilePath
Path of Json file supplied to the Export operation
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JsonString
Json string supplied to the Export operation
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell