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

2025/07/19 • 3 updated methods

EventHubs_ListByNamespace (updated)
Description :  Gets all the Event Hubs in a Namespace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "EventHubs_ListByNamespace",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "retentionDescription": [
                  {
                    "@added_818bc9451bdc4683ac18858a3cf8bc0c": {
                      "#name": "minCompactionLagTimeInMinutes",
                      "Description": "The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.",
                      "Format": "int64",
                      "Required": false,
                      "Type": "integer"
                    }
                  },
                  {
                    "@removed_59fa8e0a457e41f192b6d1be889a1bd8": {
                      "#name": "minCompactionLagInMins",
                      "Description": "The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.",
                      "Format": "int64",
                      "Required": false,
                      "Type": "integer"
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List EventHubs operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of EventHubs. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
object ,
}
,
]
,
}
,
}
EventHubs_CreateOrUpdate (updated)
Description :  Creates or updates a new Event Hub as a nested resource within a Namespace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "EventHubs_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "retentionDescription": [
              {
                "@added_09c7fa554768496d82f665781126da46": {
                  "#name": "minCompactionLagTimeInMinutes",
                  "Description": "The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.",
                  "Format": "int64",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@removed_057738373a6045819de472a683f635fb": {
                  "#name": "minCompactionLagInMins",
                  "Description": "The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.",
                  "Format": "int64",
                  "Required": false,
                  "Type": "integer"
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "retentionDescription": [
              {
                "@added_db6e0916be0b4132bd998b520ca4b9f4": {
                  "#name": "minCompactionLagTimeInMinutes",
                  "Description": "The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.",
                  "Format": "int64",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@removed_dc1ebe29cfde4f64b0502ce730e001e5": {
                  "#name": "minCompactionLagInMins",
                  "Description": "The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.",
                  "Format": "int64",
                  "Required": false,
                  "Type": "integer"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create an Event Hub resource. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
object ,
}
,
]
,
}
,
}
EventHubs_Get (updated)
Description :  Gets an Event Hubs description for the specified Event Hub.
Reference :  Link ¶

⚶ Changes

{
  "#id": "EventHubs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "retentionDescription": [
              {
                "@added_8579e6258e50446e856001cba54cc573": {
                  "#name": "minCompactionLagTimeInMinutes",
                  "Description": "The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.",
                  "Format": "int64",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@removed_54a68ce648e842c1bc4ebfa8823d318e": {
                  "#name": "minCompactionLagInMins",
                  "Description": "The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.",
                  "Format": "int64",
                  "Required": false,
                  "Type": "integer"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
object ,
}
,
]
,
}
,
}