Event Hubs Management REST (classic) - Common headers and parameters

These APIs enable you to perform management operations on Event Hubs.

Important

If you are using "Classic" or RDFE management APIs, they are obsolete and retired as of 11/1/2021 and should no longer be used.

Common parameters

The following information is common to all tasks related to managing event hubs.

  • Replace {api-version} with 2014-01 in the URL.
  • Replace {servicebusNamespace} with the name of the namespace.
  • Replace {eventHubPath} with the path to your event hub.
  • Replace {consumergroupName} with the name of a consumer group.
  • Replace {partitionId} with the ID of a partition on your Event Hub.

Common headers

The following table describes common request headers.

Request Header Description
Authorization Specify one of the following:
  • Azure Active Directory (Azure AD) JSON Web Token (JWT) token.
    Example: Authorization: Bearer <Azure AD JWT token>.
    For information on generating an Azure AD token, see Get Azure AD token..
  • A SAS token.
    Example: Authorization: SharedAccessSignature sr=<NAMESPACE NAME>.servicebus.windows.net&sig=<SHARED ACCESS KEY>&se=<TOKEN EXPIRY INSTANT>&skn=<SHARED KEY NAME>.
    For information on generating a SAS token, see Generate a Shared Access Signature token and Generate SAS token.
Content-Type Set to application/atom+xml;type=entry;charset=utf-8.

Tasks

You can perform the following management operations: