New-AzTerraformExportResourceObject

Reference

Module:: Az.Terraform

Create an in-memory object for ExportResource.

Syntax

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.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaskSensitive

Mask sensitive attributes in the Terraform configuration.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NamePattern

The name pattern of the Terraform resources.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

The id of the resource to be exported.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceType

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TargetProvider

The target Azure Terraform Provider.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

ExportResource

Share via