通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Export-AzTerraform

  • 预览
模块:
Az.Terraform Module

此 cmdlet 是 预览 模块的一部分。 不建议在生产环境中使用预览版本。 有关详细信息，请参阅 https://aka.ms/azps-refstatus。

导出指定资源的 Terraform 配置。

语法

Export （默认值） 

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

ExportViaJsonFilePath 

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

ExportViaJsonString 

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

说明

导出指定资源的 Terraform 配置。

示例

示例 1：按资源 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            :

按资源 ID 导出资源

示例 2：按名称导出资源组

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            :

按资源组名称导出资源组

示例 3：通过 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            :

通过 ARG 查询导出资源

参数

-AsJob

以作业身份运行命令

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet，请使用 SubscriptionId 参数。

参数属性

类型:PSObject
默认值:None
支持通配符:False
不显示:False
别名:AzureRMContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ExportParameter

基本导出参数

参数属性

类型:IBaseExportModel
默认值:None
支持通配符:False
不显示:False

参数集

Export
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-JsonFilePath

提供给导出操作的 Json 文件的路径

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ExportViaJsonFilePath
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-JsonString

提供给导出操作的 Json 字符串

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ExportViaJsonString
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-NoWait

异步运行命令

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-SubscriptionId

目标订阅的 ID。 该值必须是 UUID。

参数属性

类型:String
默认值:(Get-AzContext).Subscription.Id
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

IBaseExportModel

输出

IOperationStatus