# 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 Power BI Embedded Management Client…
  version: 1.0.0
extends: openapi/microsoft-azure-workspacecollections-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: 10
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Power BI workspace collection
      effect: read
      questions:
      - What SKU and location does one of my Power BI workspace collections have?
      - Can I look up a single workspace collection by name?
      instructions:
      - text: Get workspace collection {workspaceCollectionName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show details of Power BI collection {workspaceCollectionName} in {resourceGroupName}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Power BI workspace collection
      effect: write
      questions:
      - How do I provision a new Power BI Embedded workspace collection?
      - Can I choose the SKU and region when creating a workspace collection?
      instructions:
      - text: Create workspace collection {workspaceCollectionName} in {resourceGroupName} (subscription {subscriptionId}) at {location}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          location: requestBody.location
      - text: Provision Power BI collection {workspaceCollectionName} in group {resourceGroupName} on SKU {sku}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Power BI workspace collection
      effect: destructive
      questions:
      - Can I tear down a Power BI workspace collection I'm no longer using?
      - What removes a workspace collection from a resource group?
      instructions:
      - text: Delete workspace collection {workspaceCollectionName} from {resourceGroupName} in subscription {subscriptionId}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove Power BI collection {workspaceCollectionName} in {resourceGroupName}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags or SKU on a workspace collection
      effect: write
      questions:
      - Can I change the SKU of an existing Power BI workspace collection?
      - How do I retag a workspace collection that already exists?
      instructions:
      - text: Update collection {workspaceCollectionName} in {resourceGroupName} (subscription {subscriptionId}) to SKU {sku}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          sku: requestBody.sku
      - text: Set tags {tags} on existing workspace collection {workspaceCollectionName} in {resourceGroupName}.
        slots:
          tags: requestBody.tags
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/locations/{location}/checkNameAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a workspace collection name is free
      effect: read
      questions:
      - Is a Power BI workspace collection name already taken in a region?
      - Can I validate a collection name before trying to create it?
      instructions:
      - text: Check whether collection name {name} is available in {location} for subscription {subscriptionId}.
        slots:
          name: requestBody.name
          location: path.location
          subscriptionId: path.subscriptionId
      - text: Verify {name} is a valid, unused workspace collection name in region {location}.
        slots:
          name: requestBody.name
          location: path.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspace collections in a resource group
      effect: read
      questions:
      - Which Power BI workspace collections live in a given resource group?
      - Can I see the collections for just one resource group?
      instructions:
      - text: List workspace collections in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the Power BI collections inside group {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/workspaceCollections'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspace collections across a subscription
      effect: read
      questions:
      - What Power BI workspace collections exist anywhere in my subscription?
      - Can I inventory every workspace collection without naming a resource group?
      instructions:
      - text: List all workspace collections in subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Inventory every Power BI collection across subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/listKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace collection's access keys
      effect: read
      questions:
      - Where do I get the primary and secondary keys for a Power BI workspace collection?
      - Can I retrieve the API access keys for embedding?
      instructions:
      - text: Get access keys for collection {workspaceCollectionName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the primary and secondary keys of {workspaceCollectionName} in group {resourceGroupName}.
        slots:
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/regenerateKey'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a workspace collection access key
      effect: destructive
      questions:
      - How do I rotate the secondary access key on a workspace collection?
      - Can I regenerate a compromised Power BI collection key?
      instructions:
      - text: Regenerate the {keyName} key for {workspaceCollectionName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          keyName: requestBody.keyName
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Rotate access key {keyName} on collection {workspaceCollectionName} (group {resourceGroupName}).
        slots:
          keyName: requestBody.keyName
          workspaceCollectionName: path.workspaceCollectionName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a workspace collection to another resource group
      effect: write
      questions:
      - Can I move a Power BI workspace collection to a different resource group or subscription?
      - How do I migrate workspace collections out of a resource group?
      instructions:
      - text: Move resources {resources} from {resourceGroupName} in subscription {subscriptionId} to {targetResourceGroup}.
        slots:
          resources: requestBody.resources
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          targetResourceGroup: requestBody.targetResourceGroup
      - text: Migrate the workspace collections in group {resourceGroupName} over to {targetResourceGroup}.
        slots:
          resourceGroupName: path.resourceGroupName
          targetResourceGroup: requestBody.targetResourceGroup
      method: generated
      generated: '2026-09-26'