Top / Microsoft Azure / Azure Messaging / Namespace Customer Managed Key

Azure Messaging Namespace Customer Managed Key

This page shows how to write Terraform and Azure Resource Manager for Messaging Namespace Customer Managed Key and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_eventhub_namespace_customer_managed_key (Terraform)

The Namespace Customer Managed Key in Messaging can be configured in Terraform with the resource name azurerm_eventhub_namespace_customer_managed_key. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • eventhub_namespace_id - (Required) The ID of the EventHub Namespace. Changing this forces a new resource to be created.

  • key_vault_key_ids - (Required) The list of keys of Key Vault.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the EventHub Namespace.

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Customer Managed Key for a EventHub Namespace.

>> from Terraform Registry

Microsoft.EventHub/namespaces (Azure Resource Manager)

The namespaces in Microsoft.EventHub can be configured in Azure Resource Manager with the resource name Microsoft.EventHub/namespaces. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

policy.json
{
 "properties": {
  "displayName": "Apply diagnostic settings for Event Grid Topics - EventHub",
  "policyType": "Custom",
  "mode": "All",
CreateResourcesArm.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "sqlServerUsername": {
CreateResourcesArm.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "sqlServerUsername": {
CreateResourcesArm.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "sqlServerUsername": {
LocalPredictiveMaintenance.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "suiteName": {
azuredeploy.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
  "parameters": {
   "region": {
azuredeploy.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
  "parameters": {
   "region": {
LocalPredictiveMaintenance.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "suiteName": {
LocalPredictiveMaintenance.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "suiteName": {
azuredeploy.json
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
  "parameters": {
   "region": {

Parameters

  • apiVersion required - string
  • identity optional
      • type optional - string

        Type of managed service identity.

      • userAssignedIdentities optional - undefined

        Properties for User Assigned Identities

  • location optional - string

    Resource location.

  • name required - string

    The Namespace name

  • properties required
      • alternateName optional - string

        Alternate name specified when alias and namespace names are same.

      • clusterArmId optional - string

        Cluster ARM ID of the Namespace.

      • disableLocalAuth optional - boolean

        This property disables SAS authentication for the Event Hubs namespace.

      • encryption optional
          • keySource optional - string

            Enumerates the possible value of keySource for Encryption.

          • keyVaultProperties optional array
              • identity optional
                  • userAssignedIdentity optional - string

                    ARM ID of user Identity selected for encryption

              • keyName optional - string

                Name of the Key from KeyVault

              • keyVaultUri optional - string

                Uri of KeyVault

              • keyVersion optional - string

                Key Version

          • requireInfrastructureEncryption optional - boolean

            Enable Infrastructure Encryption (Double Encryption)

      • isAutoInflateEnabled optional - boolean

        Value that indicates whether AutoInflate is enabled for eventhub namespace.

      • kafkaEnabled optional - boolean

        Value that indicates whether Kafka is enabled for eventhub namespace.

      • maximumThroughputUnits optional - integer

        Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)

      • privateEndpointConnections optional array
          • properties optional
              • privateEndpoint optional
                  • id optional - string

                    The ARM identifier for Private Endpoint.

              • privateLinkServiceConnectionState optional
                  • description optional - string

                    Description of the connection state.

                  • status optional - string

                    Status of the connection.

              • provisioningState optional - string

                Provisioning state of the Private Endpoint Connection.

      • zoneRedundant optional - boolean

        Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

  • sku optional
      • capacity optional - integer

        The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units.

      • name required - string

        Name of this SKU.

      • tier optional - string

        The billing tier of this particular SKU.

  • tags optional - string

    Resource tags.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure Messaging Resources

Frequently asked questions

What is Azure Messaging Namespace Customer Managed Key?

Azure Messaging Namespace Customer Managed Key is a resource for Messaging of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents