Microsoft Azure WorkspaceCollections API

openapi: 3.2.0
info:
  version: '2016-01-29'
  title: Microsoft Azure Power BI Embedded Management Client…
  description: Client to manage your Power BI Embedded workspace collections and retrieve workspaces.
servers:
- url: https://management.azure.com
tags:
- name: WorkspaceCollections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
  : get:
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsGetbyname
      description: Retrieves an existing Power BI Workspace Collection.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        schema:
          type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Workspace collection created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCollection'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsCreate
      description: Creates a new Power BI Workspace Collection with the specified properties. A Power BI Workspace Collection contains one or more workspaces, and can be used to provision keys that provide API access to those workspaces.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        schema:
          type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Workspace collection created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCollection'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceCollectionRequest'
        description: Create workspace collection request
        required: true
    patch:
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsUpdate
      description: Update an existing Power BI Workspace Collection with the specified properties.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        schema:
          type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Workspace collection updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCollection'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceCollectionRequest'
        description: Update workspace collection request
        required: true
    delete:
      x-ms-long-running-operation: true
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsDelete
      description: Delete a Power BI Workspace Collection.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        schema:
          type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: Workspace collection deleted successfully
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/locations/{location}/checkNameAvailability:
    post:
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsChecknameavailability
      description: Verify the specified Power BI Workspace Collection name is valid and not already in use.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: location
        in: path
        description: Azure location
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameResponse'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Powerbi…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckNameRequest'
        description: Check name availability request
        required: true
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections:
    get:
      x-ms-pageable:
        nextLinkName: null
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsListbyresourcegroup
      description: Retrieves all existing Power BI workspace collections in the specified resource group.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Get workspaces response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCollectionList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/workspaceCollections:
    get:
      x-ms-pageable:
        nextLinkName: null
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsListbysubscription
      description: Retrieves all existing Power BI workspace collections in the specified subscription.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Get workspaces response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCollectionList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Powerbi…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/listKeys
  : post:
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsGetaccesskeys
      description: Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        schema:
          type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Get access keys completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCollectionAccessKeys'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/regenerateKey
  : post:
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsRegeneratekey
      description: Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        schema:
          type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Get access keys completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCollectionAccessKeys'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceCollectionAccessKey'
        description: Access key to regenerate
        required: true
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources:
    post:
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsMigrate
      description: Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Migration completed successfully
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MigrateWorkspaceCollectionRequest'
        description: Workspace migration request
        required: true
components:
  schemas:
    AzureSku:
      type: object
      required:
      - name
      - tier
      properties:
        name:
          description: SKU name
          type: string
          enum:
          - S1
          x-ms-enum:
            name: AzureSkuName
            modelAsString: true
        tier:
          description: SKU tier
          type: string
          enum:
          - Standard
          x-ms-enum:
            name: AzureSkuTier
            modelAsString: true
    WorkspaceCollection:
      type: object
      properties:
        id:
          description: Resource id
          type: string
        name:
          description: Workspace collection name
          type: string
        type:
          description: Resource type
          type: string
        location:
          description: Azure location
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
        sku:
          $ref: '#/components/schemas/AzureSku'
        properties:
          description: Properties
          type: object
    CreateWorkspaceCollectionRequest:
      type: object
      properties:
        location:
          type: string
          description: Azure location
        tags:
          type: object
          additionalProperties:
            type: string
        sku:
          $ref: '#/components/schemas/AzureSku'
    WorkspaceCollectionList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceCollection'
    CheckNameRequest:
      type: object
      properties:
        name:
          type: string
          description: Workspace collection name
        type:
          type: string
          description: Resource type
          default: Microsoft.PowerBI/workspaceCollections
    ErrorDetail:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type: string
    CheckNameResponse:
      type: object
      properties:
        nameAvailable:
          type: boolean
          description: Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use.
        reason:
          type: string
          description: Reason why the workspace collection name cannot be used.
          enum:
          - Unavailable
          - Invalid
          x-ms-enum:
            name: CheckNameReason
            modelAsString: true
        message:
          type: string
          description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
          x-ms-identifiers:
          - code
    WorkspaceCollectionAccessKeys:
      type: object
      properties:
        key1:
          description: Access key 1
          type: string
        key2:
          description: Access key 2
          type: string
    WorkspaceCollectionAccessKey:
      type: object
      properties:
        keyName:
          description: Key name
          type: string
          enum:
          - key1
          - key2
          x-ms-enum:
            name: AccessKeyName
            modelAsString: false
    MigrateWorkspaceCollectionRequest:
      type: object
      properties:
        targetResourceGroup:
          type: string
          description: Name of the resource group the Power BI workspace collections will be migrated to.
        resources:
          type: array
          items:
            type: string
    UpdateWorkspaceCollectionRequest:
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
        sku:
          $ref: '#/components/schemas/AzureSku'
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string