Microsoft Azure Integration Services Subscriptions API

The Subscriptions API from Microsoft Azure Integration Services — 3 operation(s) for subscriptions.

GitHub OpenAPI

Operations 5

POST /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/checkNameAvailability Namespaces check name availability #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions Subscriptions list by topic #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName} Subscriptions get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName} Subscriptions create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName} Subscriptions delete #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-integration-services:microsoft-azure-integration-services-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-integration-services-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ServiceBusManagementClient Subscriptions API
  version: '2026-01-01'
  description: Azure Service Bus client
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Subscriptions
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/checkNameAvailability:
    post:
      operationId: Namespaces_CheckNameAvailability
      description: Check the give namespace name availability.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameAvailabilityResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckNameAvailability'
        description: The request body
        required: true
      tags:
      - Subscriptions
      summary: Namespaces check name availability
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions
  : get:
      operationId: Subscriptions_ListByTopic
      tags:
      - Subscriptions
      description: List all the subscriptions under a specified topic.
      externalDocs:
        url: https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: namespaceName
        in: path
        description: The namespace name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      - name: topicName
        in: path
        description: The topic name.
        required: true
        schema:
          type: string
          minLength: 1
      - name: $skip
        in: query
        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
        schema:
          type: integer
          format: int32
          maximum: 1000
      - name: $top
        in: query
        description: May be used to limit the number of results to the most recent N usageDetails.
        required: false
        schema:
          type: integer
          format: int32
          maximum: 1000
          minimum: 1
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SBSubscriptionListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Subscriptions list by topic
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  : get:
      operationId: Subscriptions_Get
      tags:
      - Subscriptions
      description: Returns a subscription description for the specified topic.
      externalDocs:
        url: https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: namespaceName
        in: path
        description: The namespace name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      - name: topicName
        in: path
        description: The topic name.
        required: true
        schema:
          type: string
          minLength: 1
      - name: subscriptionName
        in: path
        description: The subscription name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SBSubscription'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Subscriptions get
      x-summary-source: derived
    put:
      operationId: Subscriptions_CreateOrUpdate
      tags:
      - Subscriptions
      description: Creates a topic subscription.
      externalDocs:
        url: https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: namespaceName
        in: path
        description: The namespace name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      - name: topicName
        in: path
        description: The topic name.
        required: true
        schema:
          type: string
          minLength: 1
      - name: subscriptionName
        in: path
        description: The subscription name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      responses:
        '200':
          description: Resource 'SBSubscription' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SBSubscription'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SBSubscription'
        description: Parameters supplied to create a subscription resource.
        required: true
      summary: Subscriptions create or update
      x-summary-source: derived
    delete:
      operationId: Subscriptions_Delete
      tags:
      - Subscriptions
      description: Deletes a subscription from the specified topic.
      externalDocs:
        url: https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: namespaceName
        in: path
        description: The namespace name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      - name: topicName
        in: path
        description: The topic name.
        required: true
        schema:
          type: string
          minLength: 1
      - name: subscriptionName
        in: path
        description: The subscription name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Subscriptions delete
      x-summary-source: derived
components:
  schemas:
    SBSubscriptionProperties:
      type: object
      description: Description of Subscription Resource.
      properties:
        messageCount:
          type: integer
          format: int64
          description: Number of messages.
          readOnly: true
        createdAt:
          type: string
          format: date-time
          description: Exact time the message was created.
          readOnly: true
        accessedAt:
          type: string
          format: date-time
          description: Last time there was a receive request to this subscription.
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          description: The exact time the message was updated.
          readOnly: true
        countDetails:
          $ref: '#/components/schemas/MessageCountDetails'
          description: Message count details
          readOnly: true
        lockDuration:
          type: string
          format: duration
          description: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.
        requiresSession:
          type: boolean
          description: Value indicating if a subscription supports the concept of sessions.
        defaultMessageTimeToLive:
          type: string
          format: duration
          description: ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
        deadLetteringOnFilterEvaluationExceptions:
          type: boolean
          description: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
        deadLetteringOnMessageExpiration:
          type: boolean
          description: Value that indicates whether a subscription has dead letter support when a message expires.
        duplicateDetectionHistoryTimeWindow:
          type: string
          format: duration
          description: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
        maxDeliveryCount:
          type: integer
          format: int32
          description: Number of maximum deliveries.
        status:
          $ref: '#/components/schemas/EntityStatus'
          description: Enumerates the possible values for the status of a messaging entity.
        enableBatchedOperations:
          type: boolean
          description: Value that indicates whether server-side batched operations are enabled.
        autoDeleteOnIdle:
          type: string
          format: duration
          description: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
        forwardTo:
          type: string
          description: Queue/Topic name to forward the messages
        forwardDeadLetteredMessagesTo:
          type: string
          description: Queue/Topic name to forward the Dead Letter message
        isClientAffine:
          type: boolean
          description: Value that indicates whether the subscription has an affinity to the client id.
        userMetadata:
          type: string
          description: Gets and Sets Metadata of User.
        clientAffineProperties:
          $ref: '#/components/schemas/SBClientAffineProperties'
          description: Properties specific to client affine subscriptions.
    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
    CheckNameAvailability:
      type: object
      description: Description of a Check Name availability request properties.
      properties:
        name:
          type: string
          description: The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.
      required:
      - name
    MessageCountDetails:
      type: object
      description: Message Count Details.
      properties:
        activeMessageCount:
          type: integer
          format: int64
          description: Number of active messages in the queue, topic, or subscription.
          readOnly: true
        deadLetterMessageCount:
          type: integer
          format: int64
          description: Number of messages that are dead lettered.
          readOnly: true
        scheduledMessageCount:
          type: integer
          format: int64
          description: Number of scheduled messages.
          readOnly: true
        transferMessageCount:
          type: integer
          format: int64
          description: Number of messages transferred to another queue, topic, or subscription.
          readOnly: true
        transferDeadLetterMessageCount:
          type: integer
          format: int64
          description: Number of messages transferred into dead letters.
          readOnly: true
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    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'
    EntityStatus:
      type: string
      description: Entity status.
      enum:
      - Active
      - Disabled
      - Restoring
      - SendDisabled
      - ReceiveDisabled
      - Creating
      - Deleting
      - Renaming
      - Unknown
      x-ms-enum:
        name: EntityStatus
        modelAsString: false
    ErrorResponse:
      type: object
      description: The resource management error response.
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseError'
          description: The error object.
    ErrorResponseError:
      type: object
      description: The error object.
      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/ErrorResponse'
          readOnly: true
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
    SBSubscriptionListResult:
      type: object
      description: The response of a SBSubscription list operation.
      properties:
        value:
          type: array
          description: The SBSubscription items on this page
          items:
            $ref: '#/components/schemas/SBSubscription'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    CheckNameAvailabilityResult:
      type: object
      description: Description of a Check Name availability request properties.
      properties:
        message:
          type: string
          description: The detailed info regarding the reason associated with the namespace.
          readOnly: true
        nameAvailable:
          type: boolean
          description: Value indicating namespace is availability, true if the namespace is available; otherwise, false.
        reason:
          $ref: '#/components/schemas/UnavailableReason'
          description: The reason for unavailability of a namespace.
    UnavailableReason:
      type: string
      description: Specifies the reason for the unavailability of the service.
      enum:
      - None
      - InvalidName
      - SubscriptionIsDisabled
      - NameInUse
      - NameInLockdown
      - TooManyNamespaceInCurrentSubscription
      x-ms-enum:
        name: UnavailableReason
        modelAsString: false
    SBClientAffineProperties:
      type: object
      description: Properties specific to client affine subscriptions.
      properties:
        clientId:
          type: string
          description: Indicates the Client ID of the application that created the client-affine subscription.
        isDurable:
          type: boolean
          description: For client-affine subscriptions, this value indicates whether the subscription is durable or not.
        isShared:
          type: boolean
          description: For client-affine subscriptions, this value indicates whether the subscription is shared or not.
    SBSubscription:
      type: object
      description: Description of subscription resource.
      properties:
        properties:
          $ref: '#/components/schemas/SBSubscriptionProperties'
          description: Properties of subscriptions resource.
          x-ms-client-flatten: true
        location:
          type: string
          description: The geo-location where the resource lives
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
  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
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      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.