# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Purview Account Accounts API
  version: 1.0.0
extends: openapi/microsoft-purview-accounts-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.Purview/accounts/{accountName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Purview account's details
      effect: read
      questions:
      - What are the current settings and SKU of my Purview account?
      - Where can I see the location and identity of an existing Purview account?
      instructions:
      - text: Show me Purview account {account} in resource group {rg} of subscription {sub}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Fetch the properties of the {account} Purview account in {rg}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a Purview account
      effect: write
      questions:
      - How do I provision a new Microsoft Purview account in a resource group?
      - Can I set the region, SKU and tags when I create a Purview account?
      instructions:
      - text: Create a Purview account named {account} in resource group {rg} of subscription {sub} in {location}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          location: requestBody.location
      - text: Provision Purview account {account} in {rg} with SKU {sku}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
          sku: requestBody.sku
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Purview account
      effect: destructive
      questions:
      - Can I permanently remove a Purview account I no longer use?
      - What happens when I tear down a Purview account resource?
      instructions:
      - text: Delete Purview account {account} from resource group {rg} in subscription {sub}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Remove the {account} Purview account in {rg}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch tags or properties on a Purview account
      effect: write
      questions:
      - How do I change only the tags on an existing Purview account without recreating it?
      - Can I patch the managed identity of a Purview account in place?
      instructions:
      - text: Update the tags on Purview account {account} in {rg} of subscription {sub} to {tags}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          tags: requestBody.tags
      - text: Patch the identity of existing Purview account {account} in {rg} to {identity}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
          identity: requestBody.identity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Purview accounts in a resource group
      effect: read
      questions:
      - Which Purview accounts live in a particular resource group?
      - How many Purview accounts does one resource group hold?
      instructions:
      - text: List the Purview accounts in resource group {rg} of subscription {sub}.
        slots:
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Get the next page of Purview accounts in {rg} using skip token {skip}.
        slots:
          rg: path.resourceGroupName
          skip: query.$skipToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Purview accounts across a subscription
      effect: read
      questions:
      - What Purview accounts exist anywhere in my Azure subscription?
      - Can I see every Purview account in a subscription regardless of resource group?
      instructions:
      - text: List all Purview accounts in subscription {sub}.
        slots:
          sub: path.subscriptionId
      - text: Continue listing subscription {sub}'s Purview accounts from skip token {skip}.
        slots:
          sub: path.subscriptionId
          skip: query.$skipToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a Purview account's access keys
      effect: read
      questions:
      - Where do I get the Atlas Kafka endpoint keys for my Purview account?
      - How can I read the access keys of a Purview account?
      instructions:
      - text: Get the access keys for Purview account {account} in {rg} of subscription {sub}.
        slots:
          account: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Retrieve the keys of the {account} Purview account.
        slots:
          account: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an admin to the root collection
      effect: write
      questions:
      - How do I grant someone admin rights on a Purview account's root collection?
      - Can I add a collection administrator by their Entra object ID?
      instructions:
      - text: Make object ID {object} an admin of the root collection on Purview account {account} in {rg} of subscription {sub}.
        slots:
          object: requestBody.objectId
          account: path.accountName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Add {object} as root collection administrator for {account}.
        slots:
          object: requestBody.objectId
          account: path.accountName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Purview/checkNameAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a Purview account name is free
      effect: read
      questions:
      - Is a given Purview account name already taken?
      - Can I verify a name is available before creating a Purview account?
      instructions:
      - text: Check if the Purview account name {name} is available in subscription {sub}.
        slots:
          name: requestBody.name
          sub: path.subscriptionId
      - text: Tell me whether {name} can be used as a new Purview account name.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'