WorkspaceCollectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

PowerBIEmbeddedManagementClient's

<xref:workspace_collections> attribute.

Inheritance

builtins.object

WorkspaceCollectionsOperations

Constructor

WorkspaceCollectionsOperations(*args, **kwargs)

Methods

begin_delete	Delete a Power BI Workspace Collection.
check_name_availability	Verify the specified Power BI Workspace Collection name is valid and not already in use.
create	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.
get_access_keys	Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.
get_by_name	Retrieves an existing Power BI Workspace Collection.
list_by_resource_group	Retrieves all existing Power BI workspace collections in the specified resource group.
list_by_subscription	Retrieves all existing Power BI workspace collections in the specified subscription.
migrate	Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.
regenerate_key	Regenerates the primary or secondary access key for the specified Power BI Workspace Collection.
update	Update an existing Power BI Workspace Collection with the specified properties.

begin_delete

Delete a Power BI Workspace Collection.

begin_delete(resource_group_name: str, workspace_collection_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Azure resource group. Required.
workspace_collection_name Required	str Power BI Embedded Workspace Collection name. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_name_availability

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

check_name_availability(location: str, body: _models.CheckNameRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameResponse

Parameters

Name	Description
location Required	str Azure location. Required.
body Required	CheckNameRequest or IO[bytes] Check name availability request. Is either a CheckNameRequest type or a IO[bytes] type. Required.

Returns

Type	Description
CheckNameResponse	CheckNameResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create

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.

create(resource_group_name: str, workspace_collection_name: str, body: _models.CreateWorkspaceCollectionRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.WorkspaceCollection

Parameters

Name	Description
resource_group_name Required	str Azure resource group. Required.
workspace_collection_name Required	str Power BI Embedded Workspace Collection name. Required.
body Required	CreateWorkspaceCollectionRequest or IO[bytes] Create workspace collection request. Is either a CreateWorkspaceCollectionRequest type or a IO[bytes] type. Required.

Returns

Type	Description
WorkspaceCollection	WorkspaceCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_access_keys

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

get_access_keys(resource_group_name: str, workspace_collection_name: str, **kwargs: Any) -> WorkspaceCollectionAccessKeys

Parameters

Name	Description
resource_group_name Required	str Azure resource group. Required.
workspace_collection_name Required	str Power BI Embedded Workspace Collection name. Required.

Returns

Type	Description
WorkspaceCollectionAccessKeys	WorkspaceCollectionAccessKeys or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_by_name

Retrieves an existing Power BI Workspace Collection.

get_by_name(resource_group_name: str, workspace_collection_name: str, **kwargs: Any) -> WorkspaceCollection

Parameters

Name	Description
resource_group_name Required	str Azure resource group. Required.
workspace_collection_name Required	str Power BI Embedded Workspace Collection name. Required.

Returns

Type	Description
WorkspaceCollection	WorkspaceCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

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

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[WorkspaceCollection]

Parameters

Name	Description
resource_group_name Required	str Azure resource group. Required.

Returns

Type	Description
ItemPaged[WorkspaceCollection]	An iterator like instance of either WorkspaceCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

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

list_by_subscription(**kwargs: Any) -> Iterable[WorkspaceCollection]

Returns

Type	Description
ItemPaged[WorkspaceCollection]	An iterator like instance of either WorkspaceCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

migrate

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

migrate(resource_group_name: str, body: _models.MigrateWorkspaceCollectionRequest, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Azure resource group. Required.
body Required	MigrateWorkspaceCollectionRequest or IO[bytes] Workspace migration request. Is either a MigrateWorkspaceCollectionRequest type or a IO[bytes] type. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

regenerate_key

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

regenerate_key(resource_group_name: str, workspace_collection_name: str, body: _models.WorkspaceCollectionAccessKey, *, content_type: str = 'application/json', **kwargs: Any) -> _models.WorkspaceCollectionAccessKeys

Parameters

Name	Description
resource_group_name Required	str Azure resource group. Required.
workspace_collection_name Required	str Power BI Embedded Workspace Collection name. Required.
body Required	WorkspaceCollectionAccessKey or IO[bytes] Access key to regenerate. Is either a WorkspaceCollectionAccessKey type or a IO[bytes] type. Required.

Returns

Type	Description
WorkspaceCollectionAccessKeys	WorkspaceCollectionAccessKeys or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

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

update(resource_group_name: str, workspace_collection_name: str, body: _models.UpdateWorkspaceCollectionRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.WorkspaceCollection

Parameters

Name	Description
resource_group_name Required	str Azure resource group. Required.
workspace_collection_name Required	str Power BI Embedded Workspace Collection name. Required.
body Required	UpdateWorkspaceCollectionRequest or IO[bytes] Update workspace collection request. Is either a UpdateWorkspaceCollectionRequest type or a IO[bytes] type. Required.

Returns

Type	Description
WorkspaceCollection	WorkspaceCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.powerbiembedded.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\powerbiembedded\\models\\__init__.py'>