Azure Service Bus · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure Service Bus Management Subscriptions API

5 actions 5 updates phrasing extends openapi/azure-service-bus-subscriptions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Azure Service Bus's API. It is a proposal applied on top of the contract, not a document Azure Service Bus publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'].put

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure Service Bus Management Subscriptions API
  version: 1.0.0
extends: openapi/azure-service-bus-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the subscriptions on a topic
      effect: read
      questions:
      - Which subscriptions are listening on my Service Bus topic?
      - How can I see every subscriber attached to a topic?
      instructions:
      - text: List the subscriptions on topic {topicName} in namespace {namespaceName}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show all topic subscriptions under {topicName} in {namespaceName} ({resourceGroupName}, Azure subscription {subscriptionId}).
        slots:
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a topic subscription's description
      effect: read
      questions:
      - How do I look up the settings of one subscription on a topic?
      - What properties are configured on my topic subscription?
      instructions:
      - text: Get subscription {subscriptionName} on topic {topicName} in namespace {namespaceName}, resource group {resourceGroupName}, Azure subscription {subscriptionId}.
        slots:
          subscriptionName: path.subscriptionName
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Describe topic subscription {subscriptionName} of {topicName} ({namespaceName}, {resourceGroupName}, {subscriptionId}).
        slots:
          subscriptionName: path.subscriptionName
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a topic subscription
      effect: write
      questions:
      - How do I subscribe a new consumer to a Service Bus topic?
      - Can I change the properties of an existing topic subscription?
      instructions:
      - text: Create subscription {subscriptionName} on topic {topicName} in {namespaceName}, group {resourceGroupName}, Azure subscription {subscriptionId}.
        slots:
          subscriptionName: path.subscriptionName
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Update topic subscription {subscriptionName} on {topicName} ({namespaceName}, {resourceGroupName}, {subscriptionId}) with properties {properties}.
        slots:
          subscriptionName: path.subscriptionName
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a topic subscription
      effect: destructive
      questions:
      - How do I stop a subscriber from receiving a topic's messages by removing its subscription?
      - Does deleting a topic subscription leave the topic itself intact?
      instructions:
      - text: Delete subscription {subscriptionName} from topic {topicName} in {namespaceName}, group {resourceGroupName}, Azure subscription {subscriptionId}.
        slots:
          subscriptionName: path.subscriptionName
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove topic subscription {subscriptionName} on {topicName} ({namespaceName}, {resourceGroupName}, {subscriptionId}).
        slots:
          subscriptionName: path.subscriptionName
          topicName: path.topicName
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'