subcategory | layout | page_title | description |
---|---|---|---|
Messaging |
azurerm |
Azure Resource Manager: azurerm_relay_hybrid_connection |
Manages an Azure Relay Hybrid Connection. |
Manages an Azure Relay Hybrid Connection.
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "West Europe"
}
resource "azurerm_relay_namespace" "example" {
name = "example-relay"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
sku_name = "Standard"
tags = {
source = "terraform"
}
}
resource "azurerm_relay_hybrid_connection" "example" {
name = "acctestrnhc-%d"
resource_group_name = azurerm_resource_group.example.name
relay_namespace_name = azurerm_relay_namespace.example.name
requires_client_authorization = false
user_metadata = "testmetadata"
}
The following arguments are supported:
-
name
- (Required) Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created. -
resource_group_name
- (Required) The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created. -
relay_namespace_name
- (Required) The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created. -
requires_client_authorization
- (Optional) Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults totrue
. -
user_metadata
- (Optional) The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
In addition to the Arguments listed above - the following Attributes are exported:
id
- The ID of the Relay Hybrid Connection.
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the Relay Hybrid Connection.update
- (Defaults to 30 minutes) Used when updating the Relay Hybrid Connection.read
- (Defaults to 5 minutes) Used when retrieving the Relay Hybrid Connection.delete
- (Defaults to 30 minutes) Used when deleting the Relay Hybrid Connection.
Relay Hybrid Connection's can be imported using the resource id
, e.g.
terraform import azurerm_relay_hybrid_connection.relay1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Relay/namespaces/relay1/hybridConnections/hconn1