# 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 Collection API
  version: 1.0.0
extends: openapi/microsoft-azure-collection-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: 16
- target: $.paths['/collections/{collectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data catalog collection
      effect: read
      questions:
      - What are the details of one collection in my data catalog account?
      - Can I see a collection's friendly name and parent collection?
      instructions:
      - text: Get the collection {collection}.
        slots:
          collection: path.collectionName
      - text: Show the friendly name and parent of collection {collection}.
        slots:
          collection: path.collectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a data catalog collection
      effect: write
      questions:
      - How do I create a new collection under a parent collection?
      - Can I rename a collection's friendly name after creating it?
      instructions:
      - text: Create collection {collection} under parent {parent}.
        slots:
          collection: path.collectionName
          parent: requestBody.parentCollection
      - text: Set the friendly name of collection {collection} to {friendly_name}.
        slots:
          collection: path.collectionName
          friendly_name: requestBody.friendlyName
      - text: Update the description of collection {collection} to {description}.
        slots:
          collection: path.collectionName
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data catalog collection
      effect: destructive
      questions:
      - Can I delete a collection I no longer use in the catalog?
      - What happens when I remove a collection entity?
      instructions:
      - text: Delete the collection {collection}.
        slots:
          collection: path.collectionName
      - text: Remove collection {collection} from the account.
        slots:
          collection: path.collectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List collections in the account
      effect: read
      questions:
      - Which collections exist in my data catalog account?
      - How do I page through all collections when there are many?
      instructions:
      - text: List every collection in the account.
      - text: Continue listing account collections from skip token {skip_token}.
        slots:
          skip_token: query.$skipToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionName}/getChildCollectionNames'].get
  update:
    x-apievangelist-phrasing:
      intent: List child collection names
      effect: read
      questions:
      - What child collections sit directly under a given collection?
      - Can I get just the names of a collection's children?
      instructions:
      - text: List the child collection names of {collection}.
        slots:
          collection: path.collectionName
      - text: Show which collections are nested under {collection}.
        slots:
          collection: path.collectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionName}/getCollectionPath'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a collection's parent path
      effect: read
      questions:
      - How do I find the full chain of parents above a collection?
      - Can I get the parent friendly names that make up a collection's path?
      instructions:
      - text: Get the collection path for {collection}.
        slots:
          collection: path.collectionName
      - text: Show the parent name chain from the root down to collection {collection}.
        slots:
          collection: path.collectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List healthcare API services in a subscription
      effect: read
      questions:
      - Which Azure API for FHIR service instances exist in my subscription?
      - Can I list all healthcare API services across a subscription?
      instructions:
      - text: List all healthcare API service instances in subscription {subscription}.
        slots:
          subscription: path.subscriptionId
      - text: Show every Microsoft.HealthcareApis service in subscription {subscription}.
        slots:
          subscription: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List healthcare API services in a resource group
      effect: read
      questions:
      - What healthcare API services are deployed in one resource group?
      - Can I narrow the FHIR service list to a single resource group?
      instructions:
      - text: List healthcare API services in resource group {resource_group} of subscription {subscription}.
        slots:
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the Microsoft.HealthcareApis services inside resource group {resource_group}.
        slots:
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell'].get
  update:
    x-apievangelist-phrasing:
      intent: List M365 SCC PowerShell private links in a subscription
      effect: read
      questions:
      - Which M365 Security and Compliance PowerShell private link services are in my subscription?
      - Can I list the Microsoft.M365SecurityAndCompliance private link instances subscription-wide?
      instructions:
      - text: List the M365 Security and Compliance PowerShell private link services in my subscription.
      - text: Show every Microsoft.M365SecurityAndCompliance SCC PowerShell private link across the subscription.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell'].get
  update:
    x-apievangelist-phrasing:
      intent: List M365 SCC PowerShell private links in a group
      effect: read
      questions:
      - What M365 Security and Compliance PowerShell private links are in one resource group?
      - Can I scope the Microsoft.M365SecurityAndCompliance private link list to a resource group?
      instructions:
      - text: List M365 SCC PowerShell private link services in one of my resource groups.
      - text: Show Microsoft.M365SecurityAndCompliance PowerShell private links scoped to a resource group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionName}/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List scans of a collection
      effect: read
      questions:
      - Which data source scans are set up for a collection?
      - Can I see all the scans registered under one collection?
      instructions:
      - text: List the scans of collection {collection}.
        slots:
          collection: path.collectionName
      - text: Show every scan configured in collection {collection}.
        slots:
          collection: path.collectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collection}/entity'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an entity in a collection
      effect: write
      questions:
      - How do I add a single data asset entity to a collection?
      - Is an existing entity matched by its GUID or qualifiedName when I upsert it?
      instructions:
      - text: Create or update the entity {entity} in collection {collection}.
        slots:
          entity: requestBody.entity
          collection: path.collection
      - text: Upsert one entity {entity} into collection {collection} with referred entities {referred}.
        slots:
          entity: requestBody.entity
          collection: path.collection
          referred: requestBody.referredEntities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collection}/entity/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create or update entities in a collection
      effect: write
      questions:
      - Can I upsert many catalog entities into a collection in one request?
      - What is the bulk way to load assets into a collection?
      instructions:
      - text: Bulk upsert the entities {entities} into collection {collection}.
        slots:
          entities: requestBody.entities
          collection: path.collection
      - text: Load this batch of entities {entities} into {collection} in one call.
        slots:
          entities: requestBody.entities
          collection: path.collection
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collection}/entity/moveHere'].post
  update:
    x-apievangelist-phrasing:
      intent: Move entities into a collection
      effect: write
      questions:
      - How do I move existing assets from one collection to another?
      - Can I relocate entities by their GUIDs to a target collection?
      instructions:
      - text: Move the entities {entity_guids} into collection {collection}.
        slots:
          entity_guids: requestBody.entityGuids
          collection: path.collection
      - text: Relocate existing assets with GUIDs {entity_guids} to target collection {collection}.
        slots:
          entity_guids: requestBody.entityGuids
          collection: path.collection
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCC PowerShell private links in a subscription
      effect: read
      questions:
      - Which Security and Compliance Center PowerShell private links exist under the Microsoft.SecurityAndCompliance namespace?
      - Can I list SCC PowerShell private link services for my whole subscription?
      instructions:
      - text: List Microsoft.SecurityAndCompliance SCC PowerShell private link services in my subscription.
      - text: Get all Security and Compliance Center PowerShell private link instances subscription-wide.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCC PowerShell private links in a group
      effect: read
      questions:
      - What Security and Compliance Center PowerShell private links live in one resource group?
      - Can I filter the Microsoft.SecurityAndCompliance SCC PowerShell links by resource group?
      instructions:
      - text: List Microsoft.SecurityAndCompliance SCC PowerShell private links in a single resource group.
      - text: Get Security and Compliance Center PowerShell private link services for one resource group.
      method: generated
      generated: '2026-09-26'