Azure Service Bus · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure Service Bus Management Namespaces API

6 actions 6 updates phrasing extends openapi/azure-service-bus-namespaces-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 6

$.info
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}'].delete

OpenAPI Overlay

Raw ↑
# 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 Namespaces API
  version: 1.0.0
extends: openapi/azure-service-bus-namespaces-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: 5
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Service Bus namespaces in a subscription
      effect: read
      questions:
      - Which Service Bus namespaces exist across my whole Azure subscription?
      - How do I see every messaging namespace in a subscription regardless of resource group?
      instructions:
      - text: List every Service Bus namespace in subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Show all namespaces across all resource groups in my subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List namespaces in a resource group
      effect: read
      questions:
      - What Service Bus namespaces are in this particular resource group?
      - Can I narrow the namespace list down to a single resource group?
      instructions:
      - text: List the Service Bus namespaces in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show only the namespaces inside resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a namespace
      effect: read
      questions:
      - How do I look up the configuration of one specific Service Bus namespace?
      - What SKU and location is my namespace set to?
      instructions:
      - text: Get the details of namespace {namespaceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Describe the {namespaceName} namespace in {resourceGroupName} under subscription {subscriptionId}.
        slots:
          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}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Service Bus namespace
      effect: write
      questions:
      - How do I provision a new Service Bus namespace in a region?
      - Can I change the SKU or tags on an existing namespace?
      - What do I send to set up a messaging namespace in Azure Service Bus?
      instructions:
      - text: Create namespace {namespaceName} in {location} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          namespaceName: path.namespaceName
          location: requestBody.location
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Change the SKU of namespace {namespaceName} in {resourceGroupName} (subscription {subscriptionId}) to {sku}.
        slots:
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          sku: requestBody.sku
      - text: Set tags {tags} on namespace {namespaceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          tags: requestBody.tags
          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}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Service Bus namespace
      effect: destructive
      questions:
      - How do I tear down a Service Bus namespace I no longer need?
      - Does deleting a namespace also remove the queues and topics inside it?
      instructions:
      - text: Delete namespace {namespaceName} from resource group {resourceGroupName} in subscription {subscriptionId}.
        slots:
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the {namespaceName} Service Bus namespace in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          namespaceName: path.namespaceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-10-01'