# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure API Management REST Backend API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-backend-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: 6
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends'].get
  update:
    x-apievangelist-phrasing:
      intent: List the backends in the service
      effect: read
      questions:
      - Which backend services has my API Management instance been configured to call?
      - Can I see all the backends defined for my APIs?
      instructions:
      - text: List the backends configured in my {serviceName} API Management service.
        slots:
          serviceName: path.serviceName
      - text: Show every configured backend.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a backend's details
      effect: read
      questions:
      - How do I look up the URL and protocol of one backend?
      - What credentials and settings does a configured backend use?
      instructions:
      - text: Get the details of backend {backendId} in {serviceName}.
        slots:
          backendId: path.backendId
          serviceName: path.serviceName
      - text: Show the backend definition by its identifier.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a backend
      effect: write
      questions:
      - How do I register a new backend service for my APIs to call?
      - Can I overwrite a backend definition completely?
      instructions:
      - text: Create or replace backend {backendId} in my {serviceName} service.
        slots:
          backendId: path.backendId
          serviceName: path.serviceName
      - text: Create or replace this backend definition.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a backend
      effect: destructive
      questions:
      - Can I remove a backend that's no longer in use?
      - Will APIs break if I delete the backend they route to?
      instructions:
      - text: Delete backend {backendId} from service {serviceName}.
        slots:
          backendId: path.backendId
          serviceName: path.serviceName
      - text: Remove the unused backend from the service.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing backend
      effect: write
      questions:
      - Can I change just the URL or description of a backend?
      - Is a partial update supported for backends?
      instructions:
      - text: Patch the URL settings of existing backend {backendId} in {serviceName}.
        slots:
          backendId: path.backendId
          serviceName: path.serviceName
      - text: Patch the backend's URL settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check a backend's ETag
      effect: read
      questions:
      - How do I get a backend's current ETag?
      - Can I check that a backend exists without fetching it?
      instructions:
      - text: Get the ETag version of backend {backendId} on service {serviceName}.
        slots:
          backendId: path.backendId
          serviceName: path.serviceName
      - text: Check the backend's ETag.
      method: generated
      generated: '2026-10-01'