# 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 ApiManagementClient Subscription API
  version: 1.0.0
extends: openapi/microsoft-azure-subscription-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: 9
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions in an API Management workspace
      effect: read
      questions:
      - Which API Management subscriptions exist in a workspace?
      - Can I filter workspace subscriptions by state or product?
      instructions:
      - text: List subscriptions in workspace {workspace} of API Management service {service}.
        slots:
          workspace: path.workspaceId
          service: path.serviceName
      - text: Show subscriptions in workspace {workspace} matching {filter}.
        slots:
          workspace: path.workspaceId
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API Management workspace subscription
      effect: read
      questions:
      - How can I view one API Management subscription in a workspace?
      - What product and user is a workspace subscription tied to?
      instructions:
      - text: Get workspace subscription {sid} in workspace {workspace} of API Management service {service}.
        slots:
          sid: path.sid
          workspace: path.workspaceId
          service: path.serviceName
      - text: Show the details of workspace subscription {sid}.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a user to a product in a workspace
      effect: write
      questions:
      - How do I subscribe a user to an API Management product in a workspace?
      - Can I create or replace a workspace subscription for a product?
      instructions:
      - text: Create or replace subscription {sid} in workspace {workspace} of API Management service {service}.
        slots:
          sid: path.sid
          workspace: path.workspaceId
          service: path.serviceName
      - text: Subscribe a user to a product as new workspace subscription {sid}.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API Management workspace subscription
      effect: destructive
      questions:
      - Can I cancel a user's API Management subscription in a workspace?
      - What happens to the keys when a workspace subscription is deleted?
      instructions:
      - text: Delete subscription {sid} from workspace {workspace} of API Management service {service}.
        slots:
          sid: path.sid
          workspace: path.workspaceId
          service: path.serviceName
      - text: Remove workspace subscription {sid} so its keys stop working.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API Management workspace subscription
      effect: write
      questions:
      - Can I change the details of an existing workspace subscription?
      - Is it possible to patch an API Management subscription without recreating it?
      instructions:
      - text: Update the details of subscription {sid} in workspace {workspace} of API Management service {service}.
        slots:
          sid: path.sid
          workspace: path.workspaceId
          service: path.serviceName
      - text: Patch existing workspace subscription {sid} in place.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check a workspace subscription's ETag
      effect: read
      questions:
      - How can I get the current ETag version of an API Management subscription?
      - Is there a lightweight way to check a workspace subscription's entity state?
      instructions:
      - text: Get the ETag of subscription {sid} in workspace {workspace} of API Management service {service}.
        slots:
          sid: path.sid
          workspace: path.workspaceId
          service: path.serviceName
      - text: Check the entity state version of workspace subscription {sid}.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regeneratePrimaryKey'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a subscription's primary key
      effect: destructive
      questions:
      - How do I rotate the primary key on an API Management workspace subscription?
      - Will regenerating the primary key break callers using it?
      instructions:
      - text: Regenerate the primary key of subscription {sid} in workspace {workspace} of service {service}.
        slots:
          sid: path.sid
          workspace: path.workspaceId
          service: path.serviceName
      - text: Rotate the primary key of workspace subscription {sid} now.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regenerateSecondaryKey'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a subscription's secondary key
      effect: destructive
      questions:
      - Can I rotate only the secondary key of a workspace subscription?
      - How do I refresh the backup key on an API Management subscription?
      instructions:
      - text: Regenerate the secondary key of subscription {sid} in workspace {workspace} of service {service}.
        slots:
          sid: path.sid
          workspace: path.workspaceId
          service: path.serviceName
      - text: Rotate only the secondary key of workspace subscription {sid}, keeping the primary.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/listSecrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace subscription's keys
      effect: read
      questions:
      - Where can I read the primary and secondary keys of a workspace subscription?
      - Can I retrieve API Management subscription secrets through the API?
      instructions:
      - text: Show the primary and secondary keys of subscription {sid} in workspace {workspace} of service {service}.
        slots:
          sid: path.sid
          workspace: path.workspaceId
          service: path.serviceName
      - text: List the secrets of workspace subscription {sid}.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'