Skip to content

azurermRelayNamespace

Manages an Azure Relay Namespace.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-resources",
  }
);
const azurermRelayNamespaceExample = new azurerm.relayNamespace.RelayNamespace(
  this,
  "example_1",
  {
    location: azurermResourceGroupExample.location,
    name: "example-relay",
    resource_group_name: azurermResourceGroupExample.name,
    sku_name: "Standard",
    tags: {
      source: "terraform",
    },
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermRelayNamespaceExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • name - (Required) Specifies the name of the Azure Relay Namespace. Changing this forces a new resource to be created.

  • resourceGroupName - (Required) The name of the resource group in which to create the Azure Relay Namespace. Changing this forces a new resource to be created.

  • location - (Required) Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.

  • skuName - (Required) The name of the SKU to use. At this time the only supported value is standard.

  • tags - (Optional) A mapping of tags to assign to the resource.

Attributes Reference

The following attributes are exported:

  • id - The Azure Relay Namespace ID.

The following attributes are exported only if there is an authorization rule named rootManageSharedAccessKey which is created automatically by Azure.

  • primaryConnectionString - The primary connection string for the authorization rule rootManageSharedAccessKey.

  • secondaryConnectionString - The secondary connection string for the authorization rule rootManageSharedAccessKey.

  • primaryKey - The primary access key for the authorization rule rootManageSharedAccessKey.

  • secondaryKey - The secondary access key for the authorization rule rootManageSharedAccessKey.

  • metricId - The Identifier for Azure Insights metrics.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the Relay Namespace.
  • update - (Defaults to 30 minutes) Used when updating the Relay Namespace.
  • read - (Defaults to 5 minutes) Used when retrieving the Relay Namespace.
  • delete - (Defaults to 60 minutes) Used when deleting the Relay Namespace.

Import

Azure Relay Namespace's can be imported using the resourceId, e.g.

terraform import azurerm_relay_namespace.relay1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Relay/namespaces/relay1