Microsoft.EventHub (preview:2025-05-01)

2025/11/14 • 1 updated methods

Namespaces_Update (updated)
Description :  Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Namespaces_Update",
  "$responses": {
    "@removed_3723a95344d24e509cfdd24d2c7bc345": {
      "201": {
        "Description": "Single Namespace item in List or Get Operation",
        "Type": "object",
        "$properties": [
          {
            "#name": "properties",
            "Description": "Namespace properties supplied for create namespace operation.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "minimumTlsVersion",
                "Description": "The minimum TLS version for the cluster to support, e.g. '1.2'",
                "Enum": [
                  [
                    "1.0",
                    ""
                  ],
                  [
                    "1.1",
                    ""
                  ],
                  [
                    "1.2",
                    ""
                  ],
                  [
                    "1.3",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "provisioningState",
                "Description": "Provisioning state of the Namespace.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "status",
                "Description": "Status of the Namespace.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The time the Namespace was created.",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "updatedAt",
                "Description": "The time the Namespace was updated.",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "serviceBusEndpoint",
                "Description": "Endpoint you can use to perform Service Bus operations.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "clusterArmId",
                "Description": "Cluster ARM ID of the Namespace.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "metricId",
                "Description": "Identifier for Azure Insights metrics.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "isAutoInflateEnabled",
                "Description": "Value that indicates whether AutoInflate is enabled for eventhub namespace.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "publicNetworkAccess",
                "Description": "This determines if traffic is allowed over public network. By default it is enabled.",
                "Enum": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ],
                  [
                    "SecuredByPerimeter",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "maximumThroughputUnits",
                "Description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)",
                "Format": "int32",
                "Required": false,
                "Type": "integer"
              },
              {
                "#name": "kafkaEnabled",
                "Description": "Value that indicates whether Kafka is enabled for eventhub namespace.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "zoneRedundant",
                "Description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "encryption",
                "Description": "Properties of BYOK Encryption description",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "keyVaultProperties",
                    "Description": "Properties of KeyVault",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "Properties to configure keyVault Properties",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "keyName",
                          "Description": "Name of the Key from KeyVault",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "keyVaultUri",
                          "Description": "Uri of KeyVault",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "keyVersion",
                          "Description": "Key Version",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "identity",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "userAssignedIdentity",
                              "Description": "ARM ID of user Identity selected for encryption",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      ]
                    }
                  },
                  {
                    "#name": "keySource",
                    "Description": "Enumerates the possible value of keySource for Encryption",
                    "Enum": [
                      [
                        "Microsoft.KeyVault",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "requireInfrastructureEncryption",
                    "Description": "Enable Infrastructure Encryption (Double Encryption)",
                    "Required": false,
                    "Type": "boolean"
                  }
                ]
              },
              {
                "#name": "privateEndpointConnections",
                "Description": "List of private endpoint connections.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Properties of the PrivateEndpointConnection.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "properties",
                      "Description": "Properties of the PrivateEndpointConnection.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "privateEndpoint",
                          "Description": "The Private Endpoint resource for this Connection.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "id",
                              "Description": "The ARM identifier for Private Endpoint.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "privateLinkServiceConnectionState",
                          "Description": "Details about the state of the connection.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "status",
                              "Description": "Status of the connection.",
                              "Enum": [
                                [
                                  "Pending",
                                  ""
                                ],
                                [
                                  "Approved",
                                  ""
                                ],
                                [
                                  "Rejected",
                                  ""
                                ],
                                [
                                  "Disconnected",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "description",
                              "Description": "Description of the connection state.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Description": "Provisioning state of the Private Endpoint Connection.",
                          "Enum": [
                            [
                              "Creating",
                              ""
                            ],
                            [
                              "Updating",
                              ""
                            ],
                            [
                              "Deleting",
                              ""
                            ],
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Canceled",
                              ""
                            ],
                            [
                              "Failed",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "location",
                      "Description": "The geo-location where the resource lives",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "disableLocalAuth",
                "Description": "This property disables SAS authentication for the Event Hubs namespace.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "alternateName",
                "Description": "Alternate name specified when alias and namespace names are same.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "platformCapabilities",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "confidentialCompute",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "mode",
                        "Description": "Setting to Enable or Disable Confidential Compute",
                        "Enum": [
                          [
                            "Disabled",
                            ""
                          ],
                          [
                            "Enabled",
                            ""
                          ]
                        ],
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "geoDataReplication",
                "Description": "Geo Data Replication settings for the namespace",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "maxReplicationLagDurationInSeconds",
                    "Description": "The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas.  When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  },
                  {
                    "#name": "locations",
                    "Description": "A list of regions where replicas of the namespace are maintained.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Description": "Namespace replication properties",
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "locationName",
                          "Description": "Azure regions where a replica of the namespace is maintained",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "roleType",
                          "Description": "GeoDR Role Types",
                          "Enum": [
                            [
                              "Primary",
                              ""
                            ],
                            [
                              "Secondary",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "replicaState",
                          "Description": "state of Namespace replica.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "clusterArmId",
                          "Description": "Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          },
          {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "sku",
            "Description": "Properties of sku resource",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "Name of this SKU.",
                "Enum": [
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "Description": "The billing tier of this particular SKU.",
                "Enum": [
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "capacity",
                "Description": "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.",
                "Format": "int32",
                "Required": false,
                "Type": "integer"
              }
            ]
          },
          {
            "#name": "identity",
            "Description": "Properties of BYOK Identity description",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "principalId",
                "Description": "ObjectId from the KeyVault",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "tenantId",
                "Description": "TenantId from the KeyVault",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "type",
                "Description": "Type of managed service identity.",
                "Enum": [
                  [
                    "SystemAssigned",
                    ""
                  ],
                  [
                    "UserAssigned",
                    ""
                  ],
                  [
                    "SystemAssigned, UserAssigned",
                    ""
                  ],
                  [
                    "None",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "userAssignedIdentities",
                "Description": "Properties for User Assigned Identities",
                "Required": false,
                "Type": "object"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
platformCapabilities:
{
Required: False ,
}
{
confidentialCompute:
{
Required: False ,
}
{
mode:
{
Description: Setting to Enable or Disable Confidential Compute ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}