Edit

Share via

New-AzTerraformExportResourceObject

Module:
Az.Terraform Module

Create an in-memory object for ExportResource.

Syntax

Default (Default) 

New-AzTerraformExportResourceObject
    -ResourceId <String[]>
    [-NamePattern <String>]
    [-ResourceName <String>]
    [-ResourceType <String>]
    [-FullProperty <Boolean>]
    [-MaskSensitive <Boolean>]
    [-TargetProvider <String>]
    [<CommonParameters>]

Description

Create an in-memory object for ExportResource.

Examples

Example 1: Create a query object with single resource id

New-AzTerraformExportResourceObject -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-pwsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet"

FullProperty   :
MaskSensitive  :
NamePattern    :
ResourceId     : {/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-pwsh-test-rg/providers/Microsoft.Network/virtualNetworks
                 /test-vnet}
ResourceName   :
ResourceType   :
TargetProvider :
Type           : ExportResource

Create a query object with single resource id

Example 2: Create a query object with multiple resource Ids

New-AzTerraformExportResourceObject -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-pwsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet","/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-pwsh-test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet2"

FullProperty   :
MaskSensitive  :
NamePattern    :
ResourceId     : {/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-pwsh-test-rg/providers/Microsoft.Network/virtualNetworks
                 /test-vnet, /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/aztfy-pwsh-test-rg/providers/Microsoft.Network/virt
                 ualNetworks/test-vnet2}
ResourceName   :
ResourceType   :
TargetProvider :
Type           : ExportResource

Create a query object with multiple resource Ids

Parameters

-FullProperty

Whether to output all non-computed properties in the generated Terraform configuration? This probably needs manual modifications to make it valid.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaskSensitive

Mask sensitive attributes in the Terraform configuration.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NamePattern

The name pattern of the Terraform resources.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

The id of the resource to be exported.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceName

The Terraform resource name. Only works when resourceIds contains only one item.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceType

The Terraform resource type. Only works when resourceIds contains only one item.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetProvider

The target Azure Terraform Provider.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

ExportResource