@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Power BI Embedded Management Client
@base https://management.azure.com
@version 2016-01-29
@common_fields {api-version: any # Client Api Version.}
@endpoints 12
@toc subscriptions(11), providers(1)

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
@desc Retrieves an existing Power BI Workspace Collection.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group, workspaceCollectionName: any # Power BI Embedded Workspace Collection name}
@returns(200) Workspace collection created successfully

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
@desc 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.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group, workspaceCollectionName: any # Power BI Embedded Workspace Collection name, body: map # Create workspace collection request}
@returns(200) Workspace collection created successfully

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
@desc Update an existing Power BI Workspace Collection with the specified properties.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group, workspaceCollectionName: any # Power BI Embedded Workspace Collection name, body: map # Update workspace collection request}
@returns(200) Workspace collection updated successfully

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}
@desc Delete a Power BI Workspace Collection.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group, workspaceCollectionName: any # Power BI Embedded Workspace Collection name}
@returns(202) Workspace collection deleted successfully

@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/locations/{location}/checkNameAvailability
@desc Verify the specified Power BI Workspace Collection name is valid and not already in use.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., location: any # Azure location, body: map # Check name availability request}
@returns(200) Request completed successfully

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections
@desc Retrieves all existing Power BI workspace collections in the specified resource group.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group}
@returns(200) Get workspaces response

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.PowerBI/workspaceCollections
@desc Retrieves all existing Power BI workspace collections in the specified subscription.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}
@returns(200) Get workspaces response

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/listKeys
@desc Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group, workspaceCollectionName: any # Power BI Embedded Workspace Collection name}
@returns(200) Get access keys completed successfully

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/regenerateKey
@desc Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group, workspaceCollectionName: any # Power BI Embedded Workspace Collection name, body: map # Access key to regenerate}
@returns(200) Get access keys completed successfully

@endgroup

@group providers
@endpoint GET /providers/Microsoft.PowerBI/operations
@desc Indicates which operations can be performed by the Power BI Resource Provider.
@returns(200) Request completed successfully

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/workspaces
@desc Retrieves all existing Power BI workspaces in the specified workspace collection.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group, workspaceCollectionName: any # Power BI Embedded Workspace Collection name}
@returns(200) Get workspaces completed successfully

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
@desc Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.
@required {subscriptionId: any # Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # Azure resource group, body: map # Workspace migration request}
@returns(200) Migration completed successfully

@endgroup

@end
