BaseExportModel interface

Package:

@azure/arm-terraform

The base export parameter

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.
type	The discriminator possible values: ExportQuery, ExportResource, ExportResourceGroup

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[]

excludeTerraformResource

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

excludeTerraformResource?: string[]

Property Value

string[]

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

includeExtensions

Include extension resource types directly associated to the resources exported

includeExtensions?: string[]

Property Value

string[]

includeManagedResource

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

includeManagedResource?: boolean

Property Value

boolean

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

maskSensitive

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

maskSensitive?: boolean

Property Value

boolean

targetProvider

The target Azure Terraform provider. Defaults to azurerm.

targetProvider?: string

Property Value

string

type

The discriminator possible values: ExportQuery, ExportResource, ExportResourceGroup

type: string

Property Value

string