Azure Event Hubs Clusters API

openapi: 3.2.0
info:
  title: EventHubManagementClient Clusters API
  version: '2026-01-01'
  description: Azure Event Hubs client
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Clusters
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/clusters:
    get:
      operationId: Clusters_ListBySubscription
      tags:
      - Clusters
      description: Lists the available Event Hubs Clusters within an ARM resource group
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Clusters list by subscription
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters:
    get:
      operationId: Clusters_ListByResourceGroup
      tags:
      - Clusters
      description: Lists the available Event Hubs Clusters within an ARM resource group
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Clusters list by resource group
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}:
    get:
      operationId: Clusters_Get
      tags:
      - Clusters
      description: Gets the resource description of the specified Event Hubs Cluster.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Event Hubs Cluster.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Clusters get
      x-summary-source: derived
    put:
      operationId: Clusters_CreateOrUpdate
      tags:
      - Clusters
      description: Creates or updates an instance of an Event Hubs Cluster.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Event Hubs Cluster.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      responses:
        '200':
          description: Resource 'Cluster' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '201':
          description: Resource 'Cluster' create operation succeeded
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Cluster'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Cluster'
        description: Parameters for creating a eventhub cluster resource.
        required: true
      summary: Clusters create or update
      x-summary-source: derived
    patch:
      operationId: Clusters_Update
      tags:
      - Clusters
      description: Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Event Hubs Cluster.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '201':
          description: Resource 'Cluster' create operation succeeded
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Cluster'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Cluster'
        description: The properties of the Event Hubs Cluster which should be updated.
        required: true
      summary: Clusters update
      x-summary-source: derived
    delete:
      operationId: Clusters_Delete
      tags:
      - Clusters
      description: Deletes an existing Event Hubs Cluster. This operation is idempotent.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Event Hubs Cluster.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Clusters delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces
  : get:
      operationId: Clusters_ListNamespaces
      tags:
      - Clusters
      description: List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Event Hubs Cluster.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EHNamespaceIdListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Clusters list namespaces
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default
  : get:
      operationId: Configuration_Get
      tags:
      - Clusters
      description: Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Event Hubs Cluster.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterQuotaConfigurationProperties'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Configuration get
      x-summary-source: derived
    patch:
      operationId: Configuration_Patch
      tags:
      - Clusters
      description: Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: clusterName
        in: path
        description: The name of the Event Hubs Cluster.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterQuotaConfigurationProperties'
        '201':
          description: Resource 'ClusterQuotaConfigurationProperties' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterQuotaConfigurationProperties'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterQuotaConfigurationProperties'
        description: Parameters for creating an Event Hubs Cluster resource.
        required: true
      summary: Configuration patch
      x-summary-source: derived
components:
  schemas:
    ClusterQuotaConfigurationProperties:
      type: object
      description: Contains all settings for the cluster.
      properties:
        settings:
          type: object
          description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster.
          additionalProperties:
            type: string
    ClusterSkuName:
      type: string
      description: Name of this SKU.
      enum:
      - Dedicated
      x-ms-enum:
        name: ClusterSkuName
        modelAsString: true
        values:
        - name: Dedicated
          value: Dedicated
    ErrorDetail:
      type: object
      description: The error detail.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        target:
          type: string
          description: The error target.
          readOnly: true
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          readOnly: true
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
    Mode:
      type: string
      description: Setting to Enable or Disable Confidential Compute
      enum:
      - Disabled
      - Enabled
      x-ms-enum:
        name: Mode
        modelAsString: true
        values:
        - name: Disabled
          value: Disabled
        - name: Enabled
          value: Enabled
    ClusterSku:
      type: object
      description: SKU parameters particular to a cluster instance.
      properties:
        name:
          $ref: '#/components/schemas/ClusterSkuName'
          description: Name of this SKU.
        capacity:
          type: integer
          format: int32
          description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
          minimum: 1
      required:
      - name
    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'
          description: The error object.
    ClusterProperties:
      type: object
      description: Event Hubs Cluster properties supplied in responses in List or Get operations.
      properties:
        createdAt:
          type: string
          description: The UTC time when the Event Hubs Cluster was created.
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: Provisioning state of the Cluster.
          readOnly: true
        updatedAt:
          type: string
          description: The UTC time when the Event Hubs Cluster was last updated.
          readOnly: true
        metricId:
          type: string
          description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
          readOnly: true
        status:
          type: string
          description: Status of the Cluster resource
          readOnly: true
        supportsScaling:
          type: boolean
          description: A value that indicates whether Scaling is Supported.
        platformCapabilities:
          $ref: '#/components/schemas/PlatformCapabilities'
        zoneRedundant:
          type: boolean
          description: A value that indicates whether the cluster is zone redundant.
    ClusterListResult:
      type: object
      description: The response of a Cluster list operation.
      properties:
        value:
          type: array
          description: The Cluster items on this page
          items:
            $ref: '#/components/schemas/Cluster'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ProvisioningState:
      type: string
      description: Provisioning state of the Cluster.
      enum:
      - Unknown
      - Creating
      - Deleting
      - Scaling
      - Active
      - Failed
      - Succeeded
      - Canceled
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
        - name: Creating
          value: Creating
        - name: Deleting
          value: Deleting
        - name: Scaling
          value: Scaling
        - name: Active
          value: Active
        - name: Failed
          value: Failed
        - name: Succeeded
          value: Succeeded
        - name: Canceled
          value: Canceled
    Cluster:
      type: object
      description: Single Event Hubs Cluster resource in List or Get operations.
      properties:
        properties:
          $ref: '#/components/schemas/ClusterProperties'
          description: Event Hubs Cluster properties supplied in responses in List or Get operations.
          x-ms-client-flatten: true
        sku:
          $ref: '#/components/schemas/ClusterSku'
          description: Properties of the cluster SKU.
        location:
          type: string
          description: Resource location.
          x-ms-mutability:
          - read
          - create
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    EHNamespaceIdListResult:
      type: object
      description: The response of the List Namespace IDs operation
      properties:
        value:
          type: array
          description: Result of the List Namespace IDs operation
          items:
            $ref: '#/components/schemas/EHNamespaceIdContainer'
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    EHNamespaceIdContainer:
      type: object
      description: The full ARM ID of an Event Hubs Namespace
      properties:
        id:
          type: string
          description: id parameter
    ErrorAdditionalInfo:
      type: object
      description: The resource management error additional info.
      properties:
        type:
          type: string
          description: The additional info type.
          readOnly: true
        info:
          description: The additional info.
          readOnly: true
    PlatformCapabilities:
      type: object
      properties:
        confidentialCompute:
          $ref: '#/components/schemas/ConfidentialCompute'
    ConfidentialCompute:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/Mode'
          description: Setting to Enable or Disable Confidential Compute
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.