# 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 Account API
  version: 1.0.0
extends: openapi/microsoft-azure-account-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: 21
- target: $.paths['/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Purview account from its data plane
      effect: read
      questions:
      - How do I read my Purview account's properties from the data plane endpoint?
      - Can I check my connected Purview account's details without the management API?
      instructions:
      - text: Get the properties of the connected Purview account.
      - text: Show my Purview account details from its data plane using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename the Purview account from its data plane
      effect: write
      questions:
      - Can I change the friendly name of my Purview account without going through Azure Resource Manager?
      - Which account property can I edit from the account's own data plane endpoint?
      instructions:
      - text: Set the friendly name of the connected Purview account to {friendly_name}.
        slots:
          friendly_name: requestBody.friendlyName
      - text: Rename this catalog account on its data plane to {friendly_name}.
        slots:
          friendly_name: requestBody.friendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/listkeys'].post
  update:
    x-apievangelist-phrasing:
      intent: List managed Event Hub connection strings
      effect: read
      questions:
      - Where do I get the connection strings for the managed Event Hub that feeds ATLAS_ENTITIES?
      - What connection string lets me send hook messages into the Purview managed Event Hub?
      instructions:
      - text: Fetch the managed Event Hub connection strings for this Purview account.
      - text: Give me the ATLAS_HOOK and ATLAS_ENTITIES Event Hub connection strings using API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/regeneratekeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a managed Event Hub key
      effect: destructive
      questions:
      - Can I rotate just the secondary key of my Purview managed Event Hub?
      - How would I regenerate the primary Event Hub key if it leaked?
      instructions:
      - text: Regenerate the {key_type} key of the managed Event Hub.
        slots:
          key_type: requestBody.keyType
      - text: Rotate the managed Event Hub {key_type} key for this Purview account now.
        slots:
          key_type: requestBody.keyType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Data Share accounts in a subscription
      effect: read
      questions:
      - Which Azure Data Share accounts exist anywhere in my subscription?
      - Can I page through every Data Share account across all resource groups?
      instructions:
      - text: List all Data Share accounts in subscription {subscription_id}.
        slots:
          subscription_id: path.subscriptionId
      - text: Get the next page of Data Share accounts in subscription {subscription_id} using token {skip_token}.
        slots:
          subscription_id: path.subscriptionId
          skip_token: query.$skipToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Data Share account
      effect: read
      questions:
      - What are the details of one specific Data Share account in my resource group?
      - Can I check the identity and location configured on a Data Share account?
      instructions:
      - text: Show Data Share account {account_name} in resource group {resource_group}, subscription {subscription_id}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
      - text: Look up the Data Share account named {account_name} in {resource_group}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Data Share account
      effect: write
      questions:
      - How do I set up a new Azure Data Share account in a resource group?
      - Does creating a Data Share account require a managed identity?
      instructions:
      - text: Create Data Share account {account_name} in resource group {resource_group} of subscription {subscription_id} with identity {identity}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
          identity: requestBody.identity
      - text: Provision a Data Share account called {account_name} in {location} under {resource_group}.
        slots:
          account_name: path.accountName
          location: requestBody.location
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Data Share account
      effect: destructive
      questions:
      - How do I remove a Data Share account I no longer use?
      - Can I delete a whole Azure Data Share account from a resource group?
      instructions:
      - text: Delete Data Share account {account_name} in resource group {resource_group}, subscription {subscription_id}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
      - text: Tear down the Data Share account {account_name}.
        slots:
          account_name: path.accountName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags on a Data Share account
      effect: write
      questions:
      - Can I change the tags on an existing Data Share account?
      - What can be patched on a Data Share account after it is created?
      instructions:
      - text: Set the tags on Data Share account {account_name} in {resource_group} to {tags}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          tags: requestBody.tags
      - text: Patch Data Share account {account_name} in subscription {subscription_id} with tags {tags}.
        slots:
          account_name: path.accountName
          subscription_id: path.subscriptionId
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Data Share accounts in a resource group
      effect: read
      questions:
      - Which Data Share accounts live in one particular resource group?
      - Is there a skip token for paging Data Share accounts inside a resource group?
      instructions:
      - text: List the Data Share accounts in resource group {resource_group} of subscription {subscription_id}.
        slots:
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
      - text: Show every Data Share account under {resource_group}.
        slots:
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer accounts for a communication service
      effect: read
      questions:
      - Which customer accounts have I set up for my Teams Direct Routing service?
      - Can I page customer account records with maxpagesize and skip?
      instructions:
      - text: List my customer accounts, {page_size} per page.
        slots:
          page_size: query.maxpagesize
      - text: Show customer account records starting after the first {skip}.
        slots:
          skip: query.skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one customer account
      effect: read
      questions:
      - What is configured on a single customer account I provide service to?
      - Can I see the Direct Routing settings for one customer?
      instructions:
      - text: Show the customer account {account_name}.
        slots:
          account_name: path.accountName
      - text: Get customer account {account_name} including its {status} status details.
        slots:
          account_name: path.accountName
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a customer account
      effect: write
      questions:
      - How do I onboard a new customer account for Teams Direct Routing?
      - Can I overwrite a customer's Direct Routing configuration in one call?
      instructions:
      - text: Create customer account {account_name} with Direct Routing settings {direct_routing}.
        slots:
          account_name: path.accountName
          direct_routing: requestBody.directRouting
      - text: Replace customer account {account_name} only if its ETag still matches {etag}.
        slots:
          account_name: path.accountName
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{accountName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer account
      effect: destructive
      questions:
      - How do I offboard a customer and delete their account record?
      - Can I remove a customer account from my Direct Routing service?
      instructions:
      - text: Delete customer account {account_name}.
        slots:
          account_name: path.accountName
      - text: Offboard the customer {account_name} by removing their account.
        slots:
          account_name: path.accountName
      method: generated
      generated: '2026-09-26'
- 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 Microsoft Purview accounts are in my resource group?
      - Can I page through Purview accounts in one resource group with a skip token?
      instructions:
      - text: List Purview accounts in resource group {resource_group}, subscription {subscription_id}.
        slots:
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
      - text: Show the Purview governance accounts under {resource_group}.
        slots:
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Purview accounts in a subscription
      effect: read
      questions:
      - What Purview accounts exist across my whole subscription?
      - How many data governance accounts have been created subscription-wide?
      instructions:
      - text: List all Purview accounts in subscription {subscription_id}.
        slots:
          subscription_id: path.subscriptionId
      - text: Continue listing Purview accounts in {subscription_id} from skip token {skip_token}.
        slots:
          subscription_id: path.subscriptionId
          skip_token: query.$skipToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Purview account resource
      effect: read
      questions:
      - What SKU and endpoints does my Purview account resource have?
      - Can I read the ARM details of a single Purview account?
      instructions:
      - text: Show Purview account {account_name} in resource group {resource_group}, subscription {subscription_id}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
      - text: Get the Purview account resource {account_name}.
        slots:
          account_name: path.accountName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Purview account
      effect: write
      questions:
      - How do I provision a new Microsoft Purview account?
      - Can I change the SKU of a Purview account by re-submitting it?
      instructions:
      - text: Create Purview account {account_name} in {resource_group}, subscription {subscription_id}, located in {location}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
          location: requestBody.location
      - text: Create or update Purview account {account_name} with SKU {sku}.
        slots:
          account_name: path.accountName
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Purview account
      effect: destructive
      questions:
      - How do I delete a Purview account resource?
      - Can I remove a data governance account from my resource group?
      instructions:
      - text: Delete Purview account {account_name} in resource group {resource_group}, subscription {subscription_id}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
      - text: Remove the Purview account {account_name}.
        slots:
          account_name: path.accountName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Purview account's properties or tags
      effect: write
      questions:
      - Can I patch the tags or properties of an existing Purview account?
      - What is the lightweight way to update a Purview account resource without resubmitting it?
      instructions:
      - text: Patch Purview account {account_name} in {resource_group} with tags {tags}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          tags: requestBody.tags
      - text: Update properties of Purview account {account_name} in subscription {subscription_id} to {properties}.
        slots:
          account_name: path.accountName
          subscription_id: path.subscriptionId
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys'].post
  update:
    x-apievangelist-phrasing:
      intent: List a Purview account's authorization keys
      effect: read
      questions:
      - Where can I find the authorization keys for my Purview account?
      - Which keys are associated with a Purview account resource?
      instructions:
      - text: List the authorization keys for Purview account {account_name} in {resource_group}, subscription {subscription_id}.
        slots:
          account_name: path.accountName
          resource_group: path.resourceGroupName
          subscription_id: path.subscriptionId
      - text: Get the access keys of Purview account {account_name}.
        slots:
          account_name: path.accountName
      method: generated
      generated: '2026-09-26'