WorkspaceCollections | @azure/arm-powerbiembedded

Class representing a WorkspaceCollections.

Hierarchy

WorkspaceCollections

Index

Constructors

constructor

Methods

Constructors

constructor

new WorkspaceCollections(client: PowerBIEmbeddedManagementClientContext): WorkspaceCollections

- Defined in operations/workspaceCollections.ts:20
Create a WorkspaceCollections.

Parameters
- client: PowerBIEmbeddedManagementClientContext
  
  Reference to the service client.
Returns WorkspaceCollections

Methods

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, workspaceCollectionName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/workspaceCollections.ts:340
Delete a Power BI Workspace Collection.

Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

checkNameAvailability

checkNameAvailability(location: string, body: CheckNameRequest, options?: msRest.RequestOptionsBase): Promise<Models.WorkspaceCollectionsCheckNameAvailabilityResponse>
checkNameAvailability(location: string, body: CheckNameRequest, callback: msRest.ServiceCallback<CheckNameResponse>): void
checkNameAvailability(location: string, body: CheckNameRequest, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CheckNameResponse>): void

- Defined in operations/workspaceCollections.ts:155
Verify the specified Power BI Workspace Collection name is valid and not already in use.

Parameters
- location: string
  
  Azure location
- body: CheckNameRequest
  
  Check name availability request
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WorkspaceCollectionsCheckNameAvailabilityResponse>

Promise<Models.WorkspaceCollectionsCheckNameAvailabilityResponse>
- Defined in operations/workspaceCollections.ts:161
Parameters
- location: string
  
  Azure location
- body: CheckNameRequest
  
  Check name availability request
- callback: msRest.ServiceCallback<CheckNameResponse>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:168
Parameters
- location: string
  
  Azure location
- body: CheckNameRequest
  
  Check name availability request
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<CheckNameResponse>
  
  The callback
Returns void

create

create(resourceGroupName: string, workspaceCollectionName: string, body: CreateWorkspaceCollectionRequest, options?: msRest.RequestOptionsBase): Promise<Models.WorkspaceCollectionsCreateResponse>
create(resourceGroupName: string, workspaceCollectionName: string, body: CreateWorkspaceCollectionRequest, callback: msRest.ServiceCallback<WorkspaceCollection>): void
create(resourceGroupName: string, workspaceCollectionName: string, body: CreateWorkspaceCollectionRequest, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceCollection>): void

- Defined in operations/workspaceCollections.ts:72
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
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: CreateWorkspaceCollectionRequest
  
  Create workspace collection request
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WorkspaceCollectionsCreateResponse>

Promise<Models.WorkspaceCollectionsCreateResponse>
- Defined in operations/workspaceCollections.ts:79
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: CreateWorkspaceCollectionRequest
  
  Create workspace collection request
- callback: msRest.ServiceCallback<WorkspaceCollection>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:87
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: CreateWorkspaceCollectionRequest
  
  Create workspace collection request
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<WorkspaceCollection>
  
  The callback
Returns void

deleteMethod

deleteMethod(resourceGroupName: string, workspaceCollectionName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/workspaceCollections.ts:143
Delete a Power BI Workspace Collection.

Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

getAccessKeys

getAccessKeys(resourceGroupName: string, workspaceCollectionName: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkspaceCollectionsGetAccessKeysResponse>
getAccessKeys(resourceGroupName: string, workspaceCollectionName: string, callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>): void
getAccessKeys(resourceGroupName: string, workspaceCollectionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>): void

- Defined in operations/workspaceCollections.ts:239
Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.

Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WorkspaceCollectionsGetAccessKeysResponse>

Promise<Models.WorkspaceCollectionsGetAccessKeysResponse>
- Defined in operations/workspaceCollections.ts:245
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:252
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>
  
  The callback
Returns void

getByName

getByName(resourceGroupName: string, workspaceCollectionName: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkspaceCollectionsGetByNameResponse>
getByName(resourceGroupName: string, workspaceCollectionName: string, callback: msRest.ServiceCallback<WorkspaceCollection>): void
getByName(resourceGroupName: string, workspaceCollectionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceCollection>): void

- Defined in operations/workspaceCollections.ts:37
Retrieves an existing Power BI Workspace Collection.

Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WorkspaceCollectionsGetByNameResponse>

Promise<Models.WorkspaceCollectionsGetByNameResponse>
- Defined in operations/workspaceCollections.ts:43
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- callback: msRest.ServiceCallback<WorkspaceCollection>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:50
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<WorkspaceCollection>
  
  The callback
Returns void

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkspaceCollectionsListByResourceGroupResponse>
listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<WorkspaceCollectionList>): void
listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceCollectionList>): void

- Defined in operations/workspaceCollections.ts:186
Retrieves all existing Power BI workspace collections in the specified resource group.

Parameters
- resourceGroupName: string
  
  Azure resource group
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WorkspaceCollectionsListByResourceGroupResponse>

Promise<Models.WorkspaceCollectionsListByResourceGroupResponse>
- Defined in operations/workspaceCollections.ts:191
Parameters
- resourceGroupName: string
  
  Azure resource group
- callback: msRest.ServiceCallback<WorkspaceCollectionList>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:197
Parameters
- resourceGroupName: string
  
  Azure resource group
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<WorkspaceCollectionList>
  
  The callback
Returns void

listBySubscription

listBySubscription(options?: msRest.RequestOptionsBase): Promise<Models.WorkspaceCollectionsListBySubscriptionResponse>
listBySubscription(callback: msRest.ServiceCallback<WorkspaceCollectionList>): void
listBySubscription(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceCollectionList>): void

- Defined in operations/workspaceCollections.ts:213
Retrieves all existing Power BI workspace collections in the specified subscription.

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WorkspaceCollectionsListBySubscriptionResponse>

Promise<Models.WorkspaceCollectionsListBySubscriptionResponse>
- Defined in operations/workspaceCollections.ts:217
Parameters
- callback: msRest.ServiceCallback<WorkspaceCollectionList>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:222
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<WorkspaceCollectionList>
  
  The callback
Returns void

migrate

migrate(resourceGroupName: string, body: MigrateWorkspaceCollectionRequest, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
migrate(resourceGroupName: string, body: MigrateWorkspaceCollectionRequest, callback: msRest.ServiceCallback<void>): void
migrate(resourceGroupName: string, body: MigrateWorkspaceCollectionRequest, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/workspaceCollections.ts:308
Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.

Parameters
- resourceGroupName: string
  
  Azure resource group
- body: MigrateWorkspaceCollectionRequest
  
  Workspace migration request
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/workspaceCollections.ts:314
Parameters
- resourceGroupName: string
  
  Azure resource group
- body: MigrateWorkspaceCollectionRequest
  
  Workspace migration request
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:321
Parameters
- resourceGroupName: string
  
  Azure resource group
- body: MigrateWorkspaceCollectionRequest
  
  Workspace migration request
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

regenerateKey

regenerateKey(resourceGroupName: string, workspaceCollectionName: string, body: WorkspaceCollectionAccessKey, options?: msRest.RequestOptionsBase): Promise<Models.WorkspaceCollectionsRegenerateKeyResponse>
regenerateKey(resourceGroupName: string, workspaceCollectionName: string, body: WorkspaceCollectionAccessKey, callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>): void
regenerateKey(resourceGroupName: string, workspaceCollectionName: string, body: WorkspaceCollectionAccessKey, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>): void

- Defined in operations/workspaceCollections.ts:272
Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.

Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: WorkspaceCollectionAccessKey
  
  Access key to regenerate
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WorkspaceCollectionsRegenerateKeyResponse>

Promise<Models.WorkspaceCollectionsRegenerateKeyResponse>
- Defined in operations/workspaceCollections.ts:279
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: WorkspaceCollectionAccessKey
  
  Access key to regenerate
- callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:287
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: WorkspaceCollectionAccessKey
  
  Access key to regenerate
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>
  
  The callback
Returns void

update

update(resourceGroupName: string, workspaceCollectionName: string, body: UpdateWorkspaceCollectionRequest, options?: msRest.RequestOptionsBase): Promise<Models.WorkspaceCollectionsUpdateResponse>
update(resourceGroupName: string, workspaceCollectionName: string, body: UpdateWorkspaceCollectionRequest, callback: msRest.ServiceCallback<WorkspaceCollection>): void
update(resourceGroupName: string, workspaceCollectionName: string, body: UpdateWorkspaceCollectionRequest, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceCollection>): void

- Defined in operations/workspaceCollections.ts:108
Update an existing Power BI Workspace Collection with the specified properties.

Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: UpdateWorkspaceCollectionRequest
  
  Update workspace collection request
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WorkspaceCollectionsUpdateResponse>

Promise<Models.WorkspaceCollectionsUpdateResponse>
- Defined in operations/workspaceCollections.ts:115
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: UpdateWorkspaceCollectionRequest
  
  Update workspace collection request
- callback: msRest.ServiceCallback<WorkspaceCollection>
  
  The callback
Returns void
- Defined in operations/workspaceCollections.ts:123
Parameters
- resourceGroupName: string
  
  Azure resource group
- workspaceCollectionName: string
  
  Power BI Embedded Workspace Collection name
- body: UpdateWorkspaceCollectionRequest
  
  Update workspace collection request
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<WorkspaceCollection>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: PowerBIEmbeddedManagementClientContext

Returns WorkspaceCollections

Methods

beginDeleteMethod

Parameters

resourceGroupName: string

workspaceCollectionName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

checkNameAvailability

Parameters

location: string

body: CheckNameRequest

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.WorkspaceCollectionsCheckNameAvailabilityResponse>

Parameters

location: string

body: CheckNameRequest

callback: msRest.ServiceCallback<CheckNameResponse>

Returns void

Parameters

location: string

body: CheckNameRequest

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<CheckNameResponse>

Returns void

create

Parameters

resourceGroupName: string

workspaceCollectionName: string

body: CreateWorkspaceCollectionRequest

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.WorkspaceCollectionsCreateResponse>

Parameters

resourceGroupName: string

workspaceCollectionName: string

body: CreateWorkspaceCollectionRequest

callback: msRest.ServiceCallback<WorkspaceCollection>

Returns void

Parameters

resourceGroupName: string

workspaceCollectionName: string

body: CreateWorkspaceCollectionRequest

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<WorkspaceCollection>

Returns void

deleteMethod

Parameters

resourceGroupName: string

workspaceCollectionName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

getAccessKeys

Parameters

resourceGroupName: string

workspaceCollectionName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.WorkspaceCollectionsGetAccessKeysResponse>

Parameters

resourceGroupName: string

workspaceCollectionName: string

callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>

Returns void

Parameters

resourceGroupName: string

workspaceCollectionName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<WorkspaceCollectionAccessKeys>

Returns void

getByName

Parameters

resourceGroupName: string

workspaceCollectionName: string