Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure EventGridManagementClient Event…

52 actions 52 updates phrasing extends openapi/microsoft-azure-event-subscriptions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 52 · first 16 shown; the file carries all of them

$.info

$.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}'].get

$.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}'].put

$.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}'].delete

$.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}'].patch

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].put

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].delete

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].patch

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].put

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].delete

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].patch

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}'].get

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}'].put

$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}'].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 Microsoft Azure EventGridManagementClient Event…
  version: 1.0.0
extends: openapi/microsoft-azure-event-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: 51
- target: $.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event subscription at any scope
      effect: read
      questions:
      - What destination and filters does an Event Grid subscription at a given resource scope use?
      - Can I look up an event subscription by its full scope path instead of a topic name?
      instructions:
      - text: Get event subscription {eventSubscriptionName} at scope {scope}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
      - text: Show how {eventSubscriptionName} is configured under {scope}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an event subscription at a scope
      effect: write
      questions:
      - How do I subscribe to events from a resource group or storage account using its scope path?
      - Can I replace an existing event subscription at a scope by putting it again with the same name?
      instructions:
      - text: Create event subscription {eventSubscriptionName} at scope {scope} with properties {properties}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
          properties: requestBody.properties
      - text: Create or overwrite the {eventSubscriptionName} subscription registered on {scope}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event subscription at a scope
      effect: destructive
      questions:
      - How do I remove an Event Grid subscription that sits on an arbitrary resource scope?
      - Does deleting a scope-level event subscription stop deliveries to its endpoint?
      instructions:
      - text: Delete event subscription {eventSubscriptionName} from scope {scope}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
      - text: Remove the {eventSubscriptionName} subscription attached to {scope}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an event subscription at a scope
      effect: write
      questions:
      - Can I change the retry policy or dead-letter destination of a scope-level event subscription?
      - Is it possible to add an expiration time to an event subscription I already made on a resource scope?
      instructions:
      - text: Update the filter on event subscription {eventSubscriptionName} at scope {scope} to {filter}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
          filter: requestBody.filter
      - text: Set expiry {expirationTimeUtc} on the {eventSubscriptionName} subscription under {scope}.
        slots:
          expirationTimeUtc: requestBody.expirationTimeUtc
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a nested subscription on a domain topic
      effect: read
      questions:
      - What endpoint does a nested subscription on one topic inside an Event Grid domain deliver to?
      - Can I inspect a single subscription that belongs to a topic within my domain?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, get {eventSubscriptionName} on topic {topicName} of domain {domainName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          domainName: path.domainName
      - text: Show nested subscription {eventSubscriptionName} for domain topic {topicName} in {domainName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          domainName: path.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a nested subscription on a domain topic
      effect: write
      questions:
      - How do I subscribe an endpoint to just one topic inside an Event Grid domain?
      - Can I create or replace a nested event subscription on a domain topic?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, create {eventSubscriptionName} on topic {topicName} of domain {domainName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          domainName: path.domainName
      - text: Create or replace nested subscription {eventSubscriptionName} on domain topic {topicName} in {domainName} using {properties}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          domainName: path.domainName
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a nested subscription on a domain topic
      effect: destructive
      questions:
      - How can I drop a subscription from a single topic inside my Event Grid domain?
      - Is a nested domain-topic subscription removed permanently when I delete it?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, delete {eventSubscriptionName} from topic {topicName} of domain {domainName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          domainName: path.domainName
      - text: Remove nested subscription {eventSubscriptionName} from domain topic {topicName} in {domainName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          domainName: path.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a nested subscription on a domain topic
      effect: write
      questions:
      - Can I change the retry policy on a subscription tied to one topic in my domain?
      - Which settings of a nested domain-topic subscription can I patch, like labels or dead-lettering?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, patch {eventSubscriptionName} on topic {topicName} of domain {domainName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          domainName: path.domainName
      - text: Set retry policy {retryPolicy} on nested subscription {eventSubscriptionName} for domain topic {topicName} in {domainName}.
        slots:
          retryPolicy: requestBody.retryPolicy
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          domainName: path.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event subscription on a custom topic
      effect: read
      questions:
      - What filters and destination does a subscription on my Event Grid custom topic have?
      - Can I fetch one subscription of a custom topic by its name?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, get subscription {eventSubscriptionName} of custom topic {topicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
      - text: Show event subscription {eventSubscriptionName} on topic {topicName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription on a custom topic
      effect: write
      questions:
      - How do I route events from my custom Event Grid topic to a webhook or queue?
      - Can I create a new subscription on a custom topic or overwrite one with the same name?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, create subscription {eventSubscriptionName} on custom topic {topicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
      - text: Subscribe {eventSubscriptionName} to topic {topicName} with properties {properties}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event subscription on a custom topic
      effect: destructive
      questions:
      - How can I stop a custom topic from sending events to an old endpoint?
      - What happens to a custom topic's subscription once I delete it?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, delete subscription {eventSubscriptionName} of custom topic {topicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
      - text: Unsubscribe {eventSubscriptionName} from topic {topicName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an event subscription on a custom topic
      effect: write
      questions:
      - Can I point an existing custom-topic subscription at a new destination?
      - Is it possible to add labels or a dead-letter target to a subscription on my custom topic?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, patch subscription {eventSubscriptionName} of custom topic {topicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
      - text: Change the destination of {eventSubscriptionName} on topic {topicName} to {destination}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          topicName: path.topicName
          destination: requestBody.destination
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain-level event subscription
      effect: read
      questions:
      - What does a subscription set on an entire Event Grid domain look like?
      - Can I fetch a subscription that covers a whole domain rather than one of its topics?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, get domain-wide subscription {eventSubscriptionName} of domain {domainName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          domainName: path.domainName
      - text: Show domain-level subscription {eventSubscriptionName} on {domainName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          domainName: path.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription on a whole domain
      effect: write
      questions:
      - How do I receive events from every topic in an Event Grid domain with one subscription?
      - Can I create or replace a domain-wide event subscription?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, create domain-wide subscription {eventSubscriptionName} on domain {domainName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          domainName: path.domainName
      - text: Subscribe {eventSubscriptionName} to all of domain {domainName} with properties {properties}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          domainName: path.domainName
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a domain-level event subscription
      effect: destructive
      questions:
      - How do I remove a subscription that listens to an entire Event Grid domain?
      - Does deleting a domain-wide subscription affect subscriptions on the domain's topics?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, delete domain-wide subscription {eventSubscriptionName} of domain {domainName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          domainName: path.domainName
      - text: Remove domain-level subscription {eventSubscriptionName} from {domainName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          domainName: path.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/eventSubscriptions/{eventSubscriptionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a domain-level event subscription
      effect: write
      questions:
      - Can I change the event delivery schema on a subscription that spans my whole domain?
      - Which properties of a domain-wide subscription can be patched after creation?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, patch domain-wide subscription {eventSubscriptionName} of domain {domainName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          domainName: path.domainName
      - text: Set delivery schema {eventDeliverySchema} on domain-level subscription {eventSubscriptionName} for {domainName}.
        slots:
          eventDeliverySchema: requestBody.eventDeliverySchema
          eventSubscriptionName: path.eventSubscriptionName
          domainName: path.domainName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription on a system topic
      effect: read
      questions:
      - How can I inspect a subscription listening to Azure service events through a system topic?
      - Can I fetch one subscription of a system topic by name?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, get {eventSubscriptionName} on system topic {systemTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
      - text: Show system-topic subscription {eventSubscriptionName} of {systemTopicName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription on a system topic
      effect: write
      questions:
      - How do I react to Azure service events like blob uploads by subscribing to a system topic?
      - Can I update an existing system-topic subscription by creating it again?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, create {eventSubscriptionName} on system topic {systemTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
      - text: Subscribe {eventSubscriptionName} to system topic {systemTopicName} with {properties}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription on a system topic
      effect: destructive
      questions:
      - How do I stop receiving Azure service events from a system topic subscription?
      - Can a deleted system-topic subscription be recovered?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, delete {eventSubscriptionName} from system topic {systemTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
      - text: Remove system-topic subscription {eventSubscriptionName} of {systemTopicName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription on a system topic
      effect: write
      questions:
      - Can I tighten the event filter on a subscription to a system topic?
      - What can I patch on a system-topic subscription, such as its destination or retries?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, patch {eventSubscriptionName} on system topic {systemTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
      - text: Update the filter of system-topic subscription {eventSubscriptionName} on {systemTopicName} to {filter}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
          filter: requestBody.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the full URL of a system-topic subscription
      effect: read
      questions:
      - Can I see the full endpoint URL of a subscription on a system topic?
      - Where is the unmasked webhook address of my system-topic subscription?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, get the full URL of {eventSubscriptionName} on system topic {systemTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
      - text: Reveal the endpoint URL of system-topic subscription {eventSubscriptionName} for {systemTopicName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          systemTopicName: path.systemTopicName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getFullUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the full endpoint URL of a scope-level subscription
      effect: read
      questions:
      - Where can I see the complete webhook URL, including query secrets, for an event subscription at a scope?
      - Can I retrieve the unmasked destination URL of a scope-level Event Grid subscription?
      instructions:
      - text: Get the full endpoint URL of event subscription {eventSubscriptionName} at scope {scope}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
      - text: Reveal the complete destination URL for {eventSubscriptionName} on {scope}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          scope: path.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions on a system topic
      effect: read
      questions:
      - Which subscriptions are listening on a given system topic?
      - Can I filter the subscriptions of a system topic and limit the page size?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, list subscriptions on system topic {systemTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          systemTopicName: path.systemTopicName
      - text: List up to {top} system-topic subscriptions on {systemTopicName} matching {filter}.
        slots:
          top: query.$top
          systemTopicName: path.systemTopicName
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription on a partner topic
      effect: read
      questions:
      - How can I inspect a subscription receiving events from a partner topic?
      - Can I fetch a single partner-topic subscription by name?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, get {eventSubscriptionName} on partner topic {partnerTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      - text: Show partner-topic subscription {eventSubscriptionName} of {partnerTopicName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription on a partner topic
      effect: write
      questions:
      - How do I route events coming from a SaaS partner topic to my own endpoint?
      - Can I create or overwrite a subscription on a partner topic?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, create {eventSubscriptionName} on partner topic {partnerTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      - text: Subscribe {eventSubscriptionName} to partner topic {partnerTopicName} with {properties}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription on a partner topic
      effect: destructive
      questions:
      - How do I stop forwarding partner events by removing a partner-topic subscription?
      - Is deleting a partner-topic subscription reversible?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, delete {eventSubscriptionName} from partner topic {partnerTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      - text: Remove partner-topic subscription {eventSubscriptionName} of {partnerTopicName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription on a partner topic
      effect: write
      questions:
      - Can I add a dead-letter destination to a partner-topic subscription?
      - Which parts of a partner-topic subscription can I patch after it is created?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, patch {eventSubscriptionName} on partner topic {partnerTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      - text: Set dead-letter destination {deadLetterDestination} on partner-topic subscription {eventSubscriptionName} for {partnerTopicName}.
        slots:
          deadLetterDestination: requestBody.deadLetterDestination
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the full URL of a partner-topic subscription
      effect: read
      questions:
      - Can I see the complete endpoint URL of a subscription on a partner topic?
      - Where is the unmasked webhook address for my partner-topic subscription?
      instructions:
      - text: In subscription {subscriptionId}, group {resourceGroupName}, get the full URL of {eventSubscriptionName} on partner topic {partnerTopicName}.
        slots:
          subscriptionId: path.subscriptionId
          resourceGroupName: path.resourceGroupName
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      - text: Reveal the endpoint URL of partner-topic subscription {eventSubscriptionName} for {partnerTopicName}.
        slots:
          eventSubscriptionName: path.eventSubscriptionName
          partnerTopicName: path.partnerTopicName
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/overlays/microsoft-azure-event-subscriptions-api-phrasing-overlay.yaml

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
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 overlay

curl "https://apis.io/api/v1/overlays/microsoft-azure-event-subscriptions-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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