purview/purview_accounts¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azurecaf_name.pva["azurecaf_name.pva"]
azurerm_purview_account.pva["azurerm_purview_account.pva"]
module.diagnostics_automation["module.diagnostics_automation"]
module.managed_resources_private_endpoints["module.managed_resources_private_endpoints"]
module.private_endpoint["module.private_endpoint"]
azurerm_purview_account.pva --> azurecaf_name.pva
module.diagnostics_automation --> azurerm_purview_account.pva
module.managed_resources_private_endpoints --> azurerm_purview_account.pva
module.private_endpoint --> azurerm_purview_account.pva
Module Reference¶
Category: purview
Path: modules/purview/purview_accounts
Azure Resources: azurecaf_name, azurerm_purview_account
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
global_settings |
Global settings object (see module README.md) | any |
yes | - |
- |
client_config |
Client configuration object (see module README.md). | any |
yes | - |
- |
settings |
(Required) Used to handle passthrough paramenters. | any |
yes | - |
- |
remote_objects |
Remote objects configuration. | any |
no | {} |
- |
location |
location of the resource if different from the resource group. | string |
no | - |
- |
resource_group_name |
Resource group object to deploy the Azure resource | string |
no | - |
- |
resource_group |
Resource group object to deploy the Azure resource | any |
yes | - |
- |
base_tags |
Base tags for the resource to be inherited from the resource group. | bool |
yes | - |
- |
diagnostics |
any |
yes | - |
- | |
private_dns |
any |
no | {} |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
id |
The ID of the Purview Account. | - | azurerm_purview_account.pva.id |
atlas_kafka_endpoint_primary_connection_string |
Atlas Kafka endpoint primary connection string. | - | azurerm_purview_account.pva.atlas_kafka_endpoint_primary_connection_string |
atlas_kafka_endpoint_secondary_connection_string |
Atlas Kafka endpoint secondary connection string. | - | azurerm_purview_account.pva.atlas_kafka_endpoint_secondary_connection_string |
catalog_endpoint |
Catalog endpoint. | - | azurerm_purview_account.pva.catalog_endpoint |
guardian_endpoint |
Guardian endpoint. | - | azurerm_purview_account.pva.guardian_endpoint |
scan_endpoint |
Scan endpoint. | - | azurerm_purview_account.pva.scan_endpoint |
identity |
A identity block as defined below. |
- | azurerm_purview_account.pva.identity |
rbac_id |
The ID of the Purview Account for role assignments. | - | azurerm_purview_account.pva.identity[0].principal_id |
Sources¶
modules/purview/purview_accounts/diagnostics.tfmodules/purview/purview_accounts/locals.tfmodules/purview/purview_accounts/main.tfmodules/purview/purview_accounts/module.tfmodules/purview/purview_accounts/outputs.tfmodules/purview/purview_accounts/private_endpoints.tfmodules/purview/purview_accounts/variables.tf