tfdocs.md

Module documentation

Required Inputs

The following input variables are required:

name

Description: The name of the Azure Relay Hybrid Connection.

Type: string

relay_namespace_name

Description: The name of the Azure Relay namespace in which to create the Hybrid Connection.

Type: string

resource_group_name

Description: The name of the resource group containing the Azure Relay namespace.

Type: string

Optional Inputs

The following input variables are optional (have default values):

authorization_rules

Description: A map of authorization rules to create for the Hybrid Connection.

Type:

map(object({
    listen = optional(bool, false)
    send   = optional(bool, false)
    manage = optional(bool, false)
  }))

Default: {}

requires_client_authorization

Description: Whether client authorization is required for this Hybrid Connection.

Type: bool

Default: true

user_metadata

Description: User metadata string for the Hybrid Connection.

Type: string

Default: null

Outputs

The following outputs are exported:

authorization_rule_ids

Description: A map of authorization rule names to their IDs.

authorization_rule_primary_connection_strings

Description: A map of authorization rule names to their primary connection strings.

authorization_rule_primary_keys

Description: A map of authorization rule names to their primary keys.

authorization_rule_secondary_connection_strings

Description: A map of authorization rule names to their secondary connection strings.

authorization_rule_secondary_keys

Description: A map of authorization rule names to their secondary keys.

id

Description: The ID of the Relay Hybrid Connection.

name

Description: The name of the Relay Hybrid Connection.

Resources

The following resources are used by this module:

• azurerm_relay_hybrid_connection.hybrid_connection (resource)
• azurerm_relay_hybrid_connection_authorization_rule.auth_rule (resource)