Microsoft.EventHub namespaces
Bicep resource definition
The namespaces resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.EventHub/namespaces@2024-01-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
alternateName: 'string'
clusterArmId: 'string'
disableLocalAuth: bool
encryption: {
keySource: 'Microsoft.KeyVault'
keyVaultProperties: [
{
identity: {
userAssignedIdentity: 'string'
}
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
]
requireInfrastructureEncryption: bool
}
isAutoInflateEnabled: bool
kafkaEnabled: bool
maximumThroughputUnits: int
minimumTlsVersion: 'string'
privateEndpointConnections: [
{
properties: {
privateEndpoint: {
id: 'string'
}
privateLinkServiceConnectionState: {
description: 'string'
status: 'string'
}
provisioningState: 'string'
}
}
]
publicNetworkAccess: 'string'
zoneRedundant: bool
}
}
Property values
namespaces
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with letter. End with letter or number. Resource name must be unique across Azure. |
| location | Resource location. | string |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | Properties of sku resource | Sku |
| identity | Properties of BYOK Identity description | Identity |
| properties | Namespace properties supplied for create namespace operation. | EHNamespaceProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Properties for User Assigned Identities | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
EHNamespaceProperties
| Name | Description | Value |
|---|---|---|
| alternateName | Alternate name specified when alias and namespace names are same. | string |
| clusterArmId | Cluster ARM ID of the Namespace. | string |
| disableLocalAuth | This property disables SAS authentication for the Event Hubs namespace. | bool |
| encryption | Properties of BYOK Encryption description | Encryption |
| isAutoInflateEnabled | Value that indicates whether AutoInflate is enabled for eventhub namespace. | bool |
| kafkaEnabled | Value that indicates whether Kafka is enabled for eventhub namespace. | bool |
| maximumThroughputUnits | Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) | int Constraints: Min value = 0 |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. '1.2' | '1.0' '1.1' '1.2' |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection[] |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| zoneRedundant | Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. | bool |
Encryption
| Name | Description | Value |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | 'Microsoft.KeyVault' |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties[] |
| requireInfrastructureEncryption | Enable Infrastructure Encryption (Double Encryption) | bool |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| identity | UserAssignedIdentityProperties | |
| keyName | Name of the Key from KeyVault | string |
| keyVaultUri | Uri of KeyVault | string |
| keyVersion | Key Version | string |
UserAssignedIdentityProperties
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | ARM ID of user Identity selected for encryption | string |
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| properties | Properties of the PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The Private Endpoint resource for this Connection. | PrivateEndpoint |
| privateLinkServiceConnectionState | Details about the state of the connection. | ConnectionState |
| provisioningState | Provisioning state of the Private Endpoint Connection. | 'Canceled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int Constraints: Min value = 0 |
| name | Name of this SKU. | 'Basic' 'Premium' 'Standard' (required) |
| tier | The billing tier of this particular SKU. | 'Basic' 'Premium' 'Standard' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
PubNub Realtime Gateway for Azure Event Hubs |
The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure! |
| Deploy the Sports Analytics on Azure Architecture |
Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role. |
| Moesif API Analytics and Monetization |
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
| Azure Digital Twins with Time Data History Connection |
This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster |
| Create Event Grid custom topic and event hub handler |
Creates an Azure Event Grid custom topic and event hub to handle the events. |
| Create an EventHubs namespace, Event Hub, & consumer group |
This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group. |
| Create EventHubs authorizationRules |
This template enables you to deploy a EventHubs Standard namespace, an Event Hub, a consumer group and authorizationRules |
| Create a Eventhub namespace and geo-recovery configuration |
This template enables you to deploy a Service Bus namespace with a Basic/Standard SKU. |
| Create a Eventhub namespace IP Filter rule |
This template enables you to deploy a Service Bus Premium namespace with IP Filter rule |
| Create a Event Hubs namespace Virtual Network rule |
This template enables you to deploy a Event Hubs Standard namespace with Virtual Network rule |
| Creates Event Hub cluster & namesapce in cluster |
This template enables you to create EventHubs Cluster and a namespace in cluster |
| Creates Eventhub cluster, namesapce & eventhub |
This template enables you to create EventHubs Cluster, namespace and eventhub in cluster |
| Create EventHubs with Capture enabled |
This template enables you to deploy a EventHubs namespace with an event hub and enabling Capture on it |
| Create EventHubs with Capture enabled (ADLS) |
This template enables you to deploy a EventHubs namespace with an event hub and enabling Capture on it |
| Create an EventHubs namespace and enable auto-inflate |
This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group.This template also turns on the auto-inflate feature on your namespace. |
| Create an event hub |
This template enables you to deploy a EventHubs namespace with an event hub. |
| Connect to a Event Hubs namespace via private endpoint |
This sample shows how to use configure a virtual network and private DNS zone to access a Event Hubs namespace via a private endpoint. |
| Deploy the MedTech service |
The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy the MedTech service including an Azure IoT Hub |
The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy Azure Data Explorer db with Event Hub connection |
Deploy Azure Data Explorer db with Event Hub connection. |
| Azure SQL Server with Auditing written to Event Hub |
This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Event Hub |
| Create SQL MI with configured sending of logs and metrics |
This template allows you to deploy SQL MI and additional resources used for storing logs and metrics (diagnostic workspace, storage account, event hub). |
| Create an Environment with an Event Hub Event Source |
This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub. |
| Azure Function App with Event Hub and Managed Identity |
his template provisions an Azure Function app on a Linux Consumption plan, along with an Event Hub, Azure Storage, and Application Insights. The function app is able to use managed identity to connect to the Event Hub and Storage account |
ARM template resource definition
The namespaces resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces resource, add the following JSON to your template.
{
"type": "Microsoft.EventHub/namespaces",
"apiVersion": "2024-01-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"alternateName": "string",
"clusterArmId": "string",
"disableLocalAuth": "bool",
"encryption": {
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": [
{
"identity": {
"userAssignedIdentity": "string"
},
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string"
}
],
"requireInfrastructureEncryption": "bool"
},
"isAutoInflateEnabled": "bool",
"kafkaEnabled": "bool",
"maximumThroughputUnits": "int",
"minimumTlsVersion": "string",
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
"id": "string"
},
"privateLinkServiceConnectionState": {
"description": "string",
"status": "string"
},
"provisioningState": "string"
}
}
],
"publicNetworkAccess": "string",
"zoneRedundant": "bool"
}
}
Property values
namespaces
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.EventHub/namespaces' |
| apiVersion | The resource api version | '2024-01-01' |
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with letter. End with letter or number. Resource name must be unique across Azure. |
| location | Resource location. | string |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | Properties of sku resource | Sku |
| identity | Properties of BYOK Identity description | Identity |
| properties | Namespace properties supplied for create namespace operation. | EHNamespaceProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Properties for User Assigned Identities | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
EHNamespaceProperties
| Name | Description | Value |
|---|---|---|
| alternateName | Alternate name specified when alias and namespace names are same. | string |
| clusterArmId | Cluster ARM ID of the Namespace. | string |
| disableLocalAuth | This property disables SAS authentication for the Event Hubs namespace. | bool |
| encryption | Properties of BYOK Encryption description | Encryption |
| isAutoInflateEnabled | Value that indicates whether AutoInflate is enabled for eventhub namespace. | bool |
| kafkaEnabled | Value that indicates whether Kafka is enabled for eventhub namespace. | bool |
| maximumThroughputUnits | Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) | int Constraints: Min value = 0 |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. '1.2' | '1.0' '1.1' '1.2' |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection[] |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| zoneRedundant | Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. | bool |
Encryption
| Name | Description | Value |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | 'Microsoft.KeyVault' |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties[] |
| requireInfrastructureEncryption | Enable Infrastructure Encryption (Double Encryption) | bool |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| identity | UserAssignedIdentityProperties | |
| keyName | Name of the Key from KeyVault | string |
| keyVaultUri | Uri of KeyVault | string |
| keyVersion | Key Version | string |
UserAssignedIdentityProperties
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | ARM ID of user Identity selected for encryption | string |
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| properties | Properties of the PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The Private Endpoint resource for this Connection. | PrivateEndpoint |
| privateLinkServiceConnectionState | Details about the state of the connection. | ConnectionState |
| provisioningState | Provisioning state of the Private Endpoint Connection. | 'Canceled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int Constraints: Min value = 0 |
| name | Name of this SKU. | 'Basic' 'Premium' 'Standard' (required) |
| tier | The billing tier of this particular SKU. | 'Basic' 'Premium' 'Standard' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| PubNub Realtime Gateway for Azure Event Hubs |
The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure! |
| Deploy the Sports Analytics on Azure Architecture |
Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role. |
| Moesif API Analytics and Monetization |
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform |
| Azure Digital Twins with Time Data History Connection |
This template creates an Azure Digital Twins instance configured with a time series data history connection. In order to create a connection, other resources must be created such as an Event Hubs namespace, an event hub, Azure Data Explorer cluster, and a database. Data is sent to an event hub which eventually forwards the data to the Azure Data Explorer cluster. Data is stored in a database table in the cluster |
| Create Event Grid custom topic and event hub handler |
Creates an Azure Event Grid custom topic and event hub to handle the events. |
| Create an EventHubs namespace, Event Hub, & consumer group |
This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group. |
| Create EventHubs authorizationRules |
This template enables you to deploy a EventHubs Standard namespace, an Event Hub, a consumer group and authorizationRules |
| Create a Eventhub namespace and geo-recovery configuration |
This template enables you to deploy a Service Bus namespace with a Basic/Standard SKU. |
| Create a Eventhub namespace IP Filter rule |
This template enables you to deploy a Service Bus Premium namespace with IP Filter rule |
| Create a Event Hubs namespace Virtual Network rule |
This template enables you to deploy a Event Hubs Standard namespace with Virtual Network rule |
| Creates Event Hub cluster & namesapce in cluster |
This template enables you to create EventHubs Cluster and a namespace in cluster |
| Creates Eventhub cluster, namesapce & eventhub |
This template enables you to create EventHubs Cluster, namespace and eventhub in cluster |
| Create EventHubs with Capture enabled |
This template enables you to deploy a EventHubs namespace with an event hub and enabling Capture on it |
| Create EventHubs with Capture enabled (ADLS) |
This template enables you to deploy a EventHubs namespace with an event hub and enabling Capture on it |
| Create an EventHubs namespace and enable auto-inflate |
This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group.This template also turns on the auto-inflate feature on your namespace. |
| Create an event hub |
This template enables you to deploy a EventHubs namespace with an event hub. |
| Connect to a Event Hubs namespace via private endpoint |
This sample shows how to use configure a virtual network and private DNS zone to access a Event Hubs namespace via a private endpoint. |
| Deploy the MedTech service |
The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy the MedTech service including an Azure IoT Hub |
The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service. |
| Deploy Azure Data Explorer db with Event Hub connection |
Deploy Azure Data Explorer db with Event Hub connection. |
| Azure SQL Server with Auditing written to Event Hub |
This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Event Hub |
| Create SQL MI with configured sending of logs and metrics |
This template allows you to deploy SQL MI and additional resources used for storing logs and metrics (diagnostic workspace, storage account, event hub). |
| Create an Environment with an Event Hub Event Source |
This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub. |
| Azure Function App with Event Hub and Managed Identity |
his template provisions an Azure Function app on a Linux Consumption plan, along with an Event Hub, Azure Storage, and Application Insights. The function app is able to use managed identity to connect to the Event Hub and Storage account |
Terraform (AzAPI provider) resource definition
The namespaces resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces@2024-01-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
alternateName = "string"
clusterArmId = "string"
disableLocalAuth = bool
encryption = {
keySource = "Microsoft.KeyVault"
keyVaultProperties = [
{
identity = {
userAssignedIdentity = "string"
}
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
}
]
requireInfrastructureEncryption = bool
}
isAutoInflateEnabled = bool
kafkaEnabled = bool
maximumThroughputUnits = int
minimumTlsVersion = "string"
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
description = "string"
status = "string"
}
provisioningState = "string"
}
}
]
publicNetworkAccess = "string"
zoneRedundant = bool
}
sku = {
capacity = int
name = "string"
tier = "string"
}
})
}
Property values
namespaces
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.EventHub/namespaces@2024-01-01" |
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with letter. End with letter or number. Resource name must be unique across Azure. |
| location | Resource location. | string |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| sku | Properties of sku resource | Sku |
| identity | Properties of BYOK Identity description | Identity |
| properties | Namespace properties supplied for create namespace operation. | EHNamespaceProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
| identity_ids | Properties for User Assigned Identities | Array of user identity IDs. |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
EHNamespaceProperties
| Name | Description | Value |
|---|---|---|
| alternateName | Alternate name specified when alias and namespace names are same. | string |
| clusterArmId | Cluster ARM ID of the Namespace. | string |
| disableLocalAuth | This property disables SAS authentication for the Event Hubs namespace. | bool |
| encryption | Properties of BYOK Encryption description | Encryption |
| isAutoInflateEnabled | Value that indicates whether AutoInflate is enabled for eventhub namespace. | bool |
| kafkaEnabled | Value that indicates whether Kafka is enabled for eventhub namespace. | bool |
| maximumThroughputUnits | Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) | int Constraints: Min value = 0 |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. '1.2' | "1.0" "1.1" "1.2" |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection[] |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | "Disabled" "Enabled" "SecuredByPerimeter" |
| zoneRedundant | Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. | bool |
Encryption
| Name | Description | Value |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | "Microsoft.KeyVault" |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties[] |
| requireInfrastructureEncryption | Enable Infrastructure Encryption (Double Encryption) | bool |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| identity | UserAssignedIdentityProperties | |
| keyName | Name of the Key from KeyVault | string |
| keyVaultUri | Uri of KeyVault | string |
| keyVersion | Key Version | string |
UserAssignedIdentityProperties
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | ARM ID of user Identity selected for encryption | string |
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| properties | Properties of the PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The Private Endpoint resource for this Connection. | PrivateEndpoint |
| privateLinkServiceConnectionState | Details about the state of the connection. | ConnectionState |
| provisioningState | Provisioning state of the Private Endpoint Connection. | "Canceled" "Creating" "Deleting" "Failed" "Succeeded" "Updating" |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | "Approved" "Disconnected" "Pending" "Rejected" |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | 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. | int Constraints: Min value = 0 |
| name | Name of this SKU. | "Basic" "Premium" "Standard" (required) |
| tier | The billing tier of this particular SKU. | "Basic" "Premium" "Standard" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for