ExportResourceTerraform Class

Definition

Specified resources to be exported by their ids.

public class ExportResourceTerraform : Azure.ResourceManager.Terraform.Models.CommonExportProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Terraform.Models.ExportResourceTerraform>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Terraform.Models.ExportResourceTerraform>
type ExportResourceTerraform = class
    inherit CommonExportProperties
    interface IJsonModel<ExportResourceTerraform>
    interface IPersistableModel<ExportResourceTerraform>
Public Class ExportResourceTerraform
Inherits CommonExportProperties
Implements IJsonModel(Of ExportResourceTerraform), IPersistableModel(Of ExportResourceTerraform)
Inheritance
ExportResourceTerraform
Implements

Constructors

Name Description
ExportResourceTerraform(IEnumerable<ResourceIdentifier>)

Initializes a new instance of ExportResourceTerraform.

Properties

Name Description
AzureResourcesToExclude

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

(Inherited from CommonExportProperties)
IncludeManagedResource

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

(Inherited from CommonExportProperties)
IncludeResourceGroup

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

IncludeRoleAssignment

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

(Inherited from CommonExportProperties)
IsMaskSensitiveEnabled

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

(Inherited from CommonExportProperties)
IsOutputFullPropertiesEnabled

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.

(Inherited from CommonExportProperties)
NamePattern

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

Recursive

Recursively includes child resources. Defaults to false.

ResourceIds

The id(s) of the resource to be exported. Example: `["/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/my-rg"].

ResourceName

The Terraform id of the exported resource. Only effective when resourceIds contains only one item. Defaults to res-0.

ResourceType

The Terraform resource type to map to. Only effective when resourceIds has one item. Example: azurerm_virtual_network. Automatic type mapping will be performed if not provided.

TargetProvider

The target Azure Terraform provider. Defaults to azurerm.

(Inherited from CommonExportProperties)
TerraformResourcesToExclude

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

(Inherited from CommonExportProperties)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<CommonExportProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from CommonExportProperties)
IJsonModel<CommonExportProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from CommonExportProperties)
IJsonModel<ExportResourceTerraform>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ExportResourceTerraform>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CommonExportProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from CommonExportProperties)
IPersistableModel<CommonExportProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from CommonExportProperties)
IPersistableModel<CommonExportProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from CommonExportProperties)
IPersistableModel<ExportResourceTerraform>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ExportResourceTerraform>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ExportResourceTerraform>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to