ExportQuery interface

Package:

@azure/arm-terraform

Uses ARG (Azure Resource Graph) query to choose resources to be exported.

Extends

BaseExportModel

Properties

authorizationScopeFilter	The ARG Scope Filter parameter.
includeResourceGroup	Includes the resource group in the exported Terraform resources. Defaults to false.
namePattern	The id prefix for the exported Terraform resources. Defaults to res-.
query	The ARG where predicate. Multiple predicates can be combined using and operator. Example: resourceGroup =~ "my-rg" and type =~ "microsoft.network/virtualnetworks". The default ARG table is Resources, use 'table' property to query a different table.
recursive	Recursively includes child resources. Defaults to false.
table	The ARG table name. Defaults to 'Resources'.
type	Has to be ExportQuery to distinguish from other types.

Inherited Properties

excludeAzureResource	Excludes specified Azure Resource Ids. Case-insensitive Azure Resource ID regular expression. Example: ["/subscriptions/[0-9a-f-]+/resourceGroups/my-rg.*"].
excludeTerraformResource	Excludes specified Terraform resource types. Example: ["azurerm_virtual_network"].
fullProperties	Whether to output all non-computed properties in the generated Terraform configuration. If set to false empty-valued properties will be omitted from the configuration. Defaults to true.
includeExtensions	Include extension resource types directly associated to the resources exported
includeManagedResource	Whether to include internal resources managed by Azure in the exported configuration. Defaults to false.
includeRoleAssignment	Whether to include role assignments assigned to the resources exported. Defaults to false. This is deprecated in favor of includeExtensions (with role-assignments specified).
maskSensitive	Mask sensitive attributes in the Terraform configuration. Defaults to true.
targetProvider	The target Azure Terraform provider. Defaults to azurerm.

Property Details

authorizationScopeFilter

The ARG Scope Filter parameter.

authorizationScopeFilter?: string

Property Value

string

includeResourceGroup

Includes the resource group in the exported Terraform resources. Defaults to false.

includeResourceGroup?: boolean

Property Value

boolean

namePattern

The id prefix for the exported Terraform resources. Defaults to res-.

namePattern?: string

Property Value

string

query

The ARG where predicate. Multiple predicates can be combined using and operator. Example: resourceGroup =~ "my-rg" and type =~ "microsoft.network/virtualnetworks". The default ARG table is Resources, use 'table' property to query a different table.

query: string

Property Value

string

recursive

Recursively includes child resources. Defaults to false.

recursive?: boolean

Property Value

boolean

table

The ARG table name. Defaults to 'Resources'.

table?: string

Property Value

string

type

Has to be ExportQuery to distinguish from other types.

type: "ExportQuery"

Property Value

"ExportQuery"

Inherited Property Details

excludeAzureResource

Excludes specified Azure Resource Ids. Case-insensitive Azure Resource ID regular expression. Example: ["/subscriptions/[0-9a-f-]+/resourceGroups/my-rg.*"].

excludeAzureResource?: string[]

Property Value

string[]

Inherited From BaseExportModel.excludeAzureResource

excludeTerraformResource

Excludes specified Terraform resource types. Example: ["azurerm_virtual_network"].

excludeTerraformResource?: string[]

Property Value

string[]

Inherited From BaseExportModel.excludeTerraformResource

fullProperties

Whether to output all non-computed properties in the generated Terraform configuration. If set to false empty-valued properties will be omitted from the configuration. Defaults to true.

fullProperties?: boolean

Property Value

boolean

Inherited From BaseExportModel.fullProperties

includeExtensions

Include extension resource types directly associated to the resources exported

includeExtensions?: string[]

Property Value

string[]

Inherited From BaseExportModel.includeExtensions

includeManagedResource

Whether to include internal resources managed by Azure in the exported configuration. Defaults to false.

includeManagedResource?: boolean

Property Value

boolean

Inherited From BaseExportModel.includeManagedResource

includeRoleAssignment

Whether to include role assignments assigned to the resources exported. Defaults to false. This is deprecated in favor of includeExtensions (with role-assignments specified).

includeRoleAssignment?: boolean

Property Value

boolean

Inherited From BaseExportModel.includeRoleAssignment

maskSensitive

Mask sensitive attributes in the Terraform configuration. Defaults to true.

maskSensitive?: boolean

Property Value

boolean

Inherited From BaseExportModel.maskSensitive

targetProvider

The target Azure Terraform provider. Defaults to azurerm.

targetProvider?: string

Property Value

string

Inherited From BaseExportModel.targetProvider