swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector WorkspaceCollections API
schemes:
- https
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.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Workspace collection created successfully
          schema:
            $ref: '#/definitions/WorkspaceCollection'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections Workspacecollectionname
    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.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - name: body
        in: body
        description: Create workspace collection request
        required: true
        schema:
          $ref: '#/definitions/CreateWorkspaceCollectionRequest'
      responses:
        '200':
          description: Workspace collection created successfully
          schema:
            $ref: '#/definitions/WorkspaceCollection'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections Workspacecollectionname
    patch:
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsUpdate
      description: Update an existing Power BI Workspace Collection with the specified properties.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - name: body
        in: body
        description: Update workspace collection request
        required: true
        schema:
          $ref: '#/definitions/UpdateWorkspaceCollectionRequest'
      responses:
        '200':
          description: Workspace collection updated successfully
          schema:
            $ref: '#/definitions/WorkspaceCollection'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections Workspacecollectionname
    delete:
      x-ms-long-running-operation: true
      tags:
      - WorkspaceCollections
      operationId: microsoftAzureWorkspacecollectionsDelete
      description: Delete a Power BI Workspace Collection.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        type: string
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections Workspacecollectionname
  /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.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: location
        in: path
        description: Azure location
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - name: body
        in: body
        description: Check name availability request
        required: true
        schema:
          $ref: '#/definitions/CheckNameRequest'
      responses:
        '200':
          description: Request completed successfully
          schema:
            $ref: '#/definitions/CheckNameResponse'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Powerbi Locations Location Checknameavailability
  /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.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Get workspaces response
          schema:
            $ref: '#/definitions/WorkspaceCollectionList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections
  /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.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Get workspaces response
          schema:
            $ref: '#/definitions/WorkspaceCollectionList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Powerbi Workspacecollections
  ? /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.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Get access keys completed successfully
          schema:
            $ref: '#/definitions/WorkspaceCollectionAccessKeys'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections Workspacecollectionname Listkeys
  ? /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.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        type: string
      - name: workspaceCollectionName
        in: path
        description: Power BI Embedded Workspace Collection name
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - name: body
        in: body
        description: Access key to regenerate
        required: true
        schema:
          $ref: '#/definitions/WorkspaceCollectionAccessKey'
      responses:
        '200':
          description: Get access keys completed successfully
          schema:
            $ref: '#/definitions/WorkspaceCollectionAccessKeys'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections Workspacecollectionname Regeneratekey
  /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.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Azure resource group
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - name: body
        in: body
        description: Workspace migration request
        required: true
        schema:
          $ref: '#/definitions/MigrateWorkspaceCollectionRequest'
      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.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Moveresources
definitions:
  CheckNameRequest:
    type: object
    properties:
      name:
        type: string
        description: Workspace collection name
      type:
        type: string
        description: Resource type
        default: Microsoft.PowerBI/workspaceCollections
  UpdateWorkspaceCollectionRequest:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
      sku:
        $ref: '#/definitions/AzureSku'
  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
  ErrorDetail:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
  CreateWorkspaceCollectionRequest:
    type: object
    properties:
      location:
        type: string
        description: Azure location
      tags:
        type: object
        additionalProperties:
          type: string
      sku:
        $ref: '#/definitions/AzureSku'
  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: '#/definitions/AzureSku'
      properties:
        description: Properties
        type: object
  WorkspaceCollectionAccessKey:
    type: object
    properties:
      keyName:
        description: Key name
        type: string
        enum:
        - key1
        - key2
        x-ms-enum:
          name: AccessKeyName
          modelAsString: false
  WorkspaceCollectionList:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/WorkspaceCollection'
  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.
  WorkspaceCollectionAccessKeys:
    type: object
    properties:
      key1:
        description: Access key 1
        type: string
      key2:
        description: Access key 2
        type: string
  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
  Error:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/ErrorDetail'
        x-ms-identifiers:
        - code
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'