ArmTerraformModelFactory.ExportQueryTerraform Method

Definition

Namespace:

Azure.ResourceManager.Terraform.Models

Assembly:

Azure.ResourceManager.Terraform.dll

Package:

Azure.ResourceManager.Terraform v1.0.0-beta.3

Source:

ArmTerraformModelFactory.cs

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

public static Azure.ResourceManager.Terraform.Models.ExportQueryTerraform ExportQueryTerraform(Azure.ResourceManager.Terraform.Models.TargetTerraformProvider? targetProvider = default, bool? isOutputFullPropertiesEnabled = default, bool? isMaskSensitiveEnabled = default, bool? includeRoleAssignment = default, bool? includeManagedResource = default, System.Collections.Generic.IEnumerable<string> azureResourcesToExclude = default, System.Collections.Generic.IEnumerable<string> terraformResourcesToExclude = default, string query = default, string namePattern = default, bool? isRecursive = default, bool? includeResourceGroup = default, string table = default, Azure.ResourceManager.Terraform.Models.TerraformAuthorizationScopeFilter? authorizationScopeFilter = default);

static member ExportQueryTerraform : Nullable<Azure.ResourceManager.Terraform.Models.TargetTerraformProvider> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * seq<string> * seq<string> * string * string * Nullable<bool> * Nullable<bool> * string * Nullable<Azure.ResourceManager.Terraform.Models.TerraformAuthorizationScopeFilter> -> Azure.ResourceManager.Terraform.Models.ExportQueryTerraform

Public Shared Function ExportQueryTerraform (Optional targetProvider As Nullable(Of TargetTerraformProvider) = Nothing, Optional isOutputFullPropertiesEnabled As Nullable(Of Boolean) = Nothing, Optional isMaskSensitiveEnabled As Nullable(Of Boolean) = Nothing, Optional includeRoleAssignment As Nullable(Of Boolean) = Nothing, Optional includeManagedResource As Nullable(Of Boolean) = Nothing, Optional azureResourcesToExclude As IEnumerable(Of String) = Nothing, Optional terraformResourcesToExclude As IEnumerable(Of String) = Nothing, Optional query As String = Nothing, Optional namePattern As String = Nothing, Optional isRecursive As Nullable(Of Boolean) = Nothing, Optional includeResourceGroup As Nullable(Of Boolean) = Nothing, Optional table As String = Nothing, Optional authorizationScopeFilter As Nullable(Of TerraformAuthorizationScopeFilter) = Nothing) As ExportQueryTerraform

Parameters

targetProvider

Nullable<TargetTerraformProvider>

The target Azure Terraform provider. Defaults to azurerm.

isOutputFullPropertiesEnabled

Nullable<Boolean>

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.

isMaskSensitiveEnabled

Nullable<Boolean>

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

includeRoleAssignment

Nullable<Boolean>

Whether to include RBAC role assignments assigned to the resources exported. Only resource-scoped role assignments are supported. Defaults to false.

includeManagedResource

Nullable<Boolean>

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

azureResourcesToExclude

IEnumerable<String>

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

terraformResourcesToExclude

IEnumerable<String>

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

query

String

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.

namePattern

String

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

isRecursive

Nullable<Boolean>

Recursively includes child resources. Defaults to false.

includeResourceGroup

Nullable<Boolean>

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

table

String

The ARG table name. Defaults to 'Resources'.

authorizationScopeFilter

Nullable<TerraformAuthorizationScopeFilter>

The ARG Scope Filter parameter.

Returns

ExportQueryTerraform

A new ExportQueryTerraform instance for mocking.