WorkspaceCollections interface

Package:

@azure/arm-powerbiembedded

Interface representing a WorkspaceCollections.

Methods

beginDelete(string, string, WorkspaceCollectionsDeleteOptionalParams)	Delete a Power BI Workspace Collection.
beginDeleteAndWait(string, string, WorkspaceCollectionsDeleteOptionalParams)	Delete a Power BI Workspace Collection.
checkNameAvailability(string, CheckNameRequest, WorkspaceCollectionsCheckNameAvailabilityOptionalParams)	Verify the specified Power BI Workspace Collection name is valid and not already in use.
create(string, string, CreateWorkspaceCollectionRequest, WorkspaceCollectionsCreateOptionalParams)	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.
getAccessKeys(string, string, WorkspaceCollectionsGetAccessKeysOptionalParams)	Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
getByName(string, string, WorkspaceCollectionsGetByNameOptionalParams)	Retrieves an existing Power BI Workspace Collection.
listByResourceGroup(string, WorkspaceCollectionsListByResourceGroupOptionalParams)	Retrieves all existing Power BI workspace collections in the specified resource group.
listBySubscription(WorkspaceCollectionsListBySubscriptionOptionalParams)	Retrieves all existing Power BI workspace collections in the specified subscription.
migrate(string, MigrateWorkspaceCollectionRequest, WorkspaceCollectionsMigrateOptionalParams)	Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.
regenerateKey(string, string, WorkspaceCollectionAccessKey, WorkspaceCollectionsRegenerateKeyOptionalParams)	Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
update(string, string, UpdateWorkspaceCollectionRequest, WorkspaceCollectionsUpdateOptionalParams)	Update an existing Power BI Workspace Collection with the specified properties.

Method Details

beginDelete(string, string, WorkspaceCollectionsDeleteOptionalParams)

Delete a Power BI Workspace Collection.

function beginDelete(resourceGroupName: string, workspaceCollectionName: string, options?: WorkspaceCollectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

Azure resource group

workspaceCollectionName

string

Power BI Embedded Workspace Collection name

options

WorkspaceCollectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, WorkspaceCollectionsDeleteOptionalParams)

Delete a Power BI Workspace Collection.

function beginDeleteAndWait(resourceGroupName: string, workspaceCollectionName: string, options?: WorkspaceCollectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Azure resource group

workspaceCollectionName

string

Power BI Embedded Workspace Collection name

options

WorkspaceCollectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(string, CheckNameRequest, WorkspaceCollectionsCheckNameAvailabilityOptionalParams)

Verify the specified Power BI Workspace Collection name is valid and not already in use.

function checkNameAvailability(location: string, body: CheckNameRequest, options?: WorkspaceCollectionsCheckNameAvailabilityOptionalParams): Promise<CheckNameResponse>

Parameters

location

string

Azure location

body

CheckNameRequest

Check name availability request

options

WorkspaceCollectionsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResponse>

create(string, string, CreateWorkspaceCollectionRequest, WorkspaceCollectionsCreateOptionalParams)

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.

function create(resourceGroupName: string, workspaceCollectionName: string, body: CreateWorkspaceCollectionRequest, options?: WorkspaceCollectionsCreateOptionalParams): Promise<WorkspaceCollection>

Parameters

resourceGroupName

string

Azure resource group

workspaceCollectionName

string

Power BI Embedded Workspace Collection name

body

CreateWorkspaceCollectionRequest

Create workspace collection request

options

WorkspaceCollectionsCreateOptionalParams

The options parameters.

Returns

Promise<WorkspaceCollection>

getAccessKeys(string, string, WorkspaceCollectionsGetAccessKeysOptionalParams)

Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.

function getAccessKeys(resourceGroupName: string, workspaceCollectionName: string, options?: WorkspaceCollectionsGetAccessKeysOptionalParams): Promise<WorkspaceCollectionAccessKeys>

Parameters

resourceGroupName

string

Azure resource group

workspaceCollectionName

string

Power BI Embedded Workspace Collection name

options

WorkspaceCollectionsGetAccessKeysOptionalParams

The options parameters.

Returns

Promise<WorkspaceCollectionAccessKeys>

getByName(string, string, WorkspaceCollectionsGetByNameOptionalParams)

Retrieves an existing Power BI Workspace Collection.

function getByName(resourceGroupName: string, workspaceCollectionName: string, options?: WorkspaceCollectionsGetByNameOptionalParams): Promise<WorkspaceCollection>

Parameters

resourceGroupName

string

Azure resource group

workspaceCollectionName

string

Power BI Embedded Workspace Collection name

options

WorkspaceCollectionsGetByNameOptionalParams

The options parameters.

Returns

Promise<WorkspaceCollection>

listByResourceGroup(string, WorkspaceCollectionsListByResourceGroupOptionalParams)

Retrieves all existing Power BI workspace collections in the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: WorkspaceCollectionsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WorkspaceCollection, WorkspaceCollection[], PageSettings>

Parameters

resourceGroupName

string

Azure resource group

options

WorkspaceCollectionsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WorkspaceCollection, WorkspaceCollection[], PageSettings>

listBySubscription(WorkspaceCollectionsListBySubscriptionOptionalParams)

Retrieves all existing Power BI workspace collections in the specified subscription.

function listBySubscription(options?: WorkspaceCollectionsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WorkspaceCollection, WorkspaceCollection[], PageSettings>

Parameters

options

WorkspaceCollectionsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WorkspaceCollection, WorkspaceCollection[], PageSettings>

migrate(string, MigrateWorkspaceCollectionRequest, WorkspaceCollectionsMigrateOptionalParams)

Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.

function migrate(resourceGroupName: string, body: MigrateWorkspaceCollectionRequest, options?: WorkspaceCollectionsMigrateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Azure resource group

body

MigrateWorkspaceCollectionRequest

Workspace migration request

options

WorkspaceCollectionsMigrateOptionalParams

The options parameters.

Returns

Promise<void>

regenerateKey(string, string, WorkspaceCollectionAccessKey, WorkspaceCollectionsRegenerateKeyOptionalParams)

Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.

function regenerateKey(resourceGroupName: string, workspaceCollectionName: string, body: WorkspaceCollectionAccessKey, options?: WorkspaceCollectionsRegenerateKeyOptionalParams): Promise<WorkspaceCollectionAccessKeys>

Parameters

resourceGroupName

string

Azure resource group

workspaceCollectionName

string

Power BI Embedded Workspace Collection name

body

WorkspaceCollectionAccessKey

Access key to regenerate

options

WorkspaceCollectionsRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<WorkspaceCollectionAccessKeys>

update(string, string, UpdateWorkspaceCollectionRequest, WorkspaceCollectionsUpdateOptionalParams)

Update an existing Power BI Workspace Collection with the specified properties.

function update(resourceGroupName: string, workspaceCollectionName: string, body: UpdateWorkspaceCollectionRequest, options?: WorkspaceCollectionsUpdateOptionalParams): Promise<WorkspaceCollection>

Parameters

resourceGroupName

string

Azure resource group

workspaceCollectionName

string

Power BI Embedded Workspace Collection name

body

UpdateWorkspaceCollectionRequest

Update workspace collection request

options

WorkspaceCollectionsUpdateOptionalParams

The options parameters.

Returns

Promise<WorkspaceCollection>