# 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 Hubs API
  version: 1.0.0
extends: openapi/microsoft-azure-hubs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 20
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Customer Insights hub
      effect: read
      questions:
      - What settings does my Customer Insights hub currently have?
      - Can I look up a single Customer Insights hub by its name?
      instructions:
      - text: Show me Customer Insights hub {hub} in resource group {rg}.
        slots:
          hub: path.hubName
          rg: path.resourceGroupName
      - text: Get the details of the {hub} Customer Insights hub in subscription {sub}.
        slots:
          hub: path.hubName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a Customer Insights hub
      effect: write
      questions:
      - How do I create a new Customer Insights hub in Azure?
      - Can I provision a Customer Insights hub in a specific region?
      instructions:
      - text: Create Customer Insights hub {hub} in resource group {rg} in {location}.
        slots:
          hub: path.hubName
          rg: path.resourceGroupName
          location: requestBody.location
      - text: Provision a new Customer Insights hub named {hub} in subscription {sub}.
        slots:
          hub: path.hubName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Customer Insights hub
      effect: destructive
      questions:
      - How do I remove a Customer Insights hub I no longer use?
      - What happens when I delete a Customer Insights hub?
      instructions:
      - text: Delete Customer Insights hub {hub} from resource group {rg}.
        slots:
          hub: path.hubName
          rg: path.resourceGroupName
      - text: Remove the {hub} Customer Insights hub from subscription {sub}.
        slots:
          hub: path.hubName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing Customer Insights hub
      effect: write
      questions:
      - Can I change the tags on an existing Customer Insights hub?
      - How do I patch just some properties of a Customer Insights hub?
      instructions:
      - text: Update the tags on Customer Insights hub {hub} to {tags}.
        slots:
          hub: path.hubName
          tags: requestBody.tags
      - text: Patch the properties of existing hub {hub} in resource group {rg}, subscription {sub}.
        slots:
          hub: path.hubName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Customer Insights hubs in a resource group
      effect: read
      questions:
      - Which Customer Insights hubs live in this resource group?
      - Can I see only the hubs in one resource group rather than the whole subscription?
      instructions:
      - text: List the Customer Insights hubs in resource group {rg}.
        slots:
          rg: path.resourceGroupName
      - text: Show every hub under resource group {rg} in subscription {sub}.
        slots:
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.CustomerInsights/hubs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Customer Insights hubs in a subscription
      effect: read
      questions:
      - What Customer Insights hubs exist across my whole subscription?
      - How many Customer Insights hubs does my subscription have?
      instructions:
      - text: List all Customer Insights hubs in subscription {sub}.
        slots:
          sub: path.subscriptionId
      - text: Show every hub in the subscription regardless of resource group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a notification hub name is available
      effect: read
      questions:
      - Is a notification hub name already taken in my namespace?
      - How can I check a notification hub name before creating it?
      instructions:
      - text: Check whether notification hub name {name} is available in namespace {ns}.
        slots:
          name: requestBody.name
          ns: path.namespaceName
      - text: See if I can use {name} as a new notification hub name.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification hub
      effect: read
      questions:
      - What are the settings of my Azure notification hub?
      - Can I fetch a single notification hub by name?
      instructions:
      - text: Get notification hub {hub} in namespace {ns}.
        slots:
          hub: path.notificationHubName
          ns: path.namespaceName
      - text: Show me the details of notification hub {hub}.
        slots:
          hub: path.notificationHubName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a notification hub
      effect: write
      questions:
      - How do I create a notification hub for push notifications?
      - Can I pick a SKU when I create a notification hub?
      instructions:
      - text: Create notification hub {hub} in namespace {ns}.
        slots:
          hub: path.notificationHubName
          ns: path.namespaceName
      - text: Create notification hub {hub} with SKU {sku}.
        slots:
          hub: path.notificationHubName
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification hub
      effect: destructive
      questions:
      - How do I delete a notification hub from a namespace?
      - Will deleting a notification hub stop pushes to its devices?
      instructions:
      - text: Delete notification hub {hub} from namespace {ns}.
        slots:
          hub: path.notificationHubName
          ns: path.namespaceName
      - text: Remove the {hub} notification hub.
        slots:
          hub: path.notificationHubName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing notification hub
      effect: write
      questions:
      - Can I change the tags or SKU of an existing notification hub?
      - How do I patch a notification hub without recreating it?
      instructions:
      - text: Patch notification hub {hub} in namespace {ns} with tags {tags}.
        slots:
          hub: path.notificationHubName
          ns: path.namespaceName
          tags: requestBody.tags
      - text: Change the SKU of existing notification hub {hub} to {sku}.
        slots:
          hub: path.notificationHubName
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification hubs in a namespace
      effect: read
      questions:
      - Which notification hubs are in my namespace?
      - Can I page through notification hubs a few at a time?
      instructions:
      - text: List the notification hubs in namespace {ns}.
        slots:
          ns: path.namespaceName
      - text: Show the first {top} notification hubs in namespace {ns}.
        slots:
          top: query.$top
          ns: path.namespaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test push through a notification hub
      effect: write
      questions:
      - How do I send a debug test notification through my hub?
      - Can I test push delivery on a notification hub without real traffic?
      instructions:
      - text: Send a debug test notification through hub {hub} in namespace {ns}.
        slots:
          hub: path.notificationHubName
          ns: path.namespaceName
      - text: Run a debug send on notification hub {hub}.
        slots:
          hub: path.notificationHubName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification hub authorization rule
      effect: read
      questions:
      - What rights does a specific authorization rule on my notification hub grant?
      - Can I view one access policy on a notification hub?
      instructions:
      - text: Get authorization rule {rule} on notification hub {hub}.
        slots:
          rule: path.authorizationRuleName
          hub: path.notificationHubName
      - text: Show access policy {rule} for hub {hub} in namespace {ns}.
        slots:
          rule: path.authorizationRuleName
          hub: path.notificationHubName
          ns: path.namespaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a notification hub access policy
      effect: write
      questions:
      - How do I add a new shared access policy to a notification hub?
      - Can I change the rights on an existing notification hub authorization rule?
      instructions:
      - text: Create authorization rule {rule} on notification hub {hub} in namespace {ns}.
        slots:
          rule: path.authorizationRuleName
          hub: path.notificationHubName
          ns: path.namespaceName
      - text: Add a shared access policy called {rule} to hub {hub}.
        slots:
          rule: path.authorizationRuleName
          hub: path.notificationHubName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification hub authorization rule
      effect: destructive
      questions:
      - How do I revoke a shared access policy on a notification hub?
      - Can I delete an authorization rule that clients still use?
      instructions:
      - text: Delete authorization rule {rule} from notification hub {hub}.
        slots:
          rule: path.authorizationRuleName
          hub: path.notificationHubName
      - text: Remove access policy {rule} on hub {hub} in namespace {ns}.
        slots:
          rule: path.authorizationRuleName
          hub: path.notificationHubName
          ns: path.namespaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a notification hub's authorization rules
      effect: read
      questions:
      - Which access policies are defined on my notification hub?
      - What shared access rules does a notification hub have?
      instructions:
      - text: List the authorization rules on notification hub {hub} in namespace {ns}.
        slots:
          hub: path.notificationHubName
          ns: path.namespaceName
      - text: Show every access policy for hub {hub}.
        slots:
          hub: path.notificationHubName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/listKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Get connection keys for a hub access policy
      effect: read
      questions:
      - Where do I find the connection string for my notification hub?
      - How do I get the primary and secondary keys of a hub access policy?
      instructions:
      - text: Get the keys and connection strings for rule {rule} on hub {hub}.
        slots:
          rule: path.authorizationRuleName
          hub: path.notificationHubName
      - text: Show the connection string for access policy {rule} in namespace {ns}.
        slots:
          rule: path.authorizationRuleName
          ns: path.namespaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a notification hub access key
      effect: destructive
      questions:
      - How do I rotate a leaked notification hub key?
      - Can I regenerate only the primary or only the secondary key?
      instructions:
      - text: Regenerate the {key} key of rule {rule} on hub {hub}.
        slots:
          key: requestBody.policyKey
          rule: path.authorizationRuleName
          hub: path.notificationHubName
      - text: Rotate the {key} key for access policy {rule} in namespace {ns}.
        slots:
          key: requestBody.policyKey
          rule: path.authorizationRuleName
          ns: path.namespaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Get push service credentials of a hub
      effect: read
      questions:
      - Which APNs or FCM credentials are configured on my notification hub?
      - Can I see the platform notification service credentials for a hub?
      instructions:
      - text: Get the PNS credentials for notification hub {hub} in namespace {ns}.
        slots:
          hub: path.notificationHubName
          ns: path.namespaceName
      - text: Show the push platform credentials configured on hub {hub}.
        slots:
          hub: path.notificationHubName
      method: generated
      generated: '2026-09-26'