Azure Event Hubs Operations API

openapi: 3.1.0
info:
  title: Azure Event Hubs Data Plane REST Authorization Rules Operations API
  description: The Azure Event Hubs Data Plane REST API enables you to send events to and interact with Event Hubs directly. This API operates against the Event Hubs service endpoint at {namespace}.servicebus.windows.net and supports sending individual events, batch events, partition-specific events, and events with publisher identity. Authentication is via Azure Active Directory tokens or Shared Access Signature (SAS) tokens.
  version: 2014-01
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
  license:
    name: Microsoft Azure Terms of Service
    url: https://azure.microsoft.com/en-us/support/legal/
  x-logo:
    url: https://azure.microsoft.com/svghandler/event-hubs/
servers:
- url: https://{namespaceName}.servicebus.windows.net
  description: Azure Event Hubs Service Endpoint
  variables:
    namespaceName:
      description: The Event Hubs namespace name.
      default: my-namespace
security:
- sas_token: []
- bearer_token: []
tags:
- name: Operations
  description: Operations for listing available Event Hub REST API operations.
paths:
  /providers/Microsoft.EventHub/operations:
    get:
      operationId: Operations_List
      summary: Azure Event Hubs List available operations
      description: Lists all of the available Event Hub REST API operations.
      tags:
      - Operations
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationListResult'
        default:
          description: Event Hubs error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorAdditionalInfo:
      type: object
      description: The resource management error additional info.
      properties:
        type:
          type: string
          readOnly: true
          description: The additional info type.
        info:
          type: object
          readOnly: true
          description: The additional info.
    ErrorDetail:
      type: object
      description: The error detail.
      properties:
        code:
          type: string
          readOnly: true
          description: The error code.
        message:
          type: string
          readOnly: true
          description: The error message.
        target:
          type: string
          readOnly: true
          description: The error target.
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
          readOnly: true
          description: The error details.
        additionalInfo:
          type: array
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
          description: The error additional info.
    ErrorResponse:
      type: object
      description: Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
    OperationListResult:
      type: object
      description: Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
          readOnly: true
          description: List of Event Hub operations supported by the Microsoft.EventHub resource provider.
        nextLink:
          type: string
          readOnly: true
          description: URL to get the next set of operation list results.
    Operation:
      type: object
      description: A Event Hub REST API operation.
      properties:
        name:
          type: string
          readOnly: true
          description: 'Operation name: {provider}/{resource}/{operation}'
        isDataAction:
          type: boolean
          description: Indicates whether the operation is a data action.
        display:
          type: object
          properties:
            provider:
              type: string
              readOnly: true
              description: Resource provider of the operation.
            resource:
              type: string
              readOnly: true
              description: Resource of the operation.
            operation:
              type: string
              readOnly: true
              description: Localized friendly name for the operation.
            description:
              type: string
              readOnly: true
              description: Localized friendly description for the operation.
        origin:
          type: string
          description: Origin of the operation.
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client API version.
      schema:
        type: string
        default: '2024-01-01'
  securitySchemes:
    sas_token:
      type: apiKey
      in: header
      name: Authorization
      description: 'Shared Access Signature token. Format: SharedAccessSignature sr={namespace}.servicebus.windows.net&sig={signature}&se={expiry}&skn={keyName}'
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Azure Active Directory (Azure AD) JSON Web Token (JWT). Format: Bearer {Azure AD JWT token}'