WorkspaceCollectionsOperations Class

WorkspaceCollectionsOperations operations.

Inheritance

builtins.object

WorkspaceCollectionsOperations

Constructor

WorkspaceCollectionsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

api_version

Client Api Version. Constant value: "2016-01-29".

Methods

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.
delete	Delete a Power BI Workspace Collection.
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.

check_name_availability

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

check_name_availability(location, name=None, type='Microsoft.PowerBI/workspaceCollections', custom_headers=None, raw=False, **operation_config)

Parameters

location

str

Required

Azure location

name

str

default value: None

Workspace collection name

type

str

default value: Microsoft.PowerBI/workspaceCollections

Resource type

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

CheckNameResponse or ClientRawResponse if raw=true

Return type

CheckNameResponse,

ClientRawResponse

Exceptions

ErrorException

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, workspace_collection_name, location=None, tags=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

Azure resource group

workspace_collection_name

str

Required

Power BI Embedded Workspace Collection name

location

str

default value: None

Azure location

tags

dict[str, str]

default value: None

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

WorkspaceCollection or ClientRawResponse if raw=true

Return type

WorkspaceCollection,

ClientRawResponse

Exceptions

ErrorException

delete

Delete a Power BI Workspace Collection.

delete(resource_group_name, workspace_collection_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name

str

Required

Azure resource group

workspace_collection_name

str

Required

Power BI Embedded Workspace Collection name

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

ErrorException

get_access_keys

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

get_access_keys(resource_group_name, workspace_collection_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

Azure resource group

workspace_collection_name

str

Required

Power BI Embedded Workspace Collection name

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

WorkspaceCollectionAccessKeys or ClientRawResponse if raw=true

Return type

WorkspaceCollectionAccessKeys,

ClientRawResponse

Exceptions

ErrorException

get_by_name

Retrieves an existing Power BI Workspace Collection.

get_by_name(resource_group_name, workspace_collection_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

Azure resource group

workspace_collection_name

str

Required

Power BI Embedded Workspace Collection name

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

WorkspaceCollection or ClientRawResponse if raw=true

Return type

WorkspaceCollection,

ClientRawResponse

Exceptions

ErrorException

list_by_resource_group

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

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

Azure resource group

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of WorkspaceCollection

Return type

WorkspaceCollectionPaged[WorkspaceCollection]

Exceptions

ErrorException

list_by_subscription

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

list_by_subscription(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of WorkspaceCollection

Return type

WorkspaceCollectionPaged[WorkspaceCollection]

Exceptions

ErrorException

migrate

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

migrate(resource_group_name, target_resource_group=None, resources=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

Azure resource group

target_resource_group

str

default value: None

Name of the resource group the Power BI workspace collections will be migrated to.

resources

list[str]

default value: None

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

ErrorException

regenerate_key

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

regenerate_key(resource_group_name, workspace_collection_name, key_name=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

Azure resource group

workspace_collection_name

str

Required

Power BI Embedded Workspace Collection name

key_name

str or AccessKeyName

default value: None

Key name. Possible values include: 'key1', 'key2'

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

WorkspaceCollectionAccessKeys or ClientRawResponse if raw=true

Return type

WorkspaceCollectionAccessKeys,

ClientRawResponse

Exceptions

ErrorException

update

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

update(resource_group_name, workspace_collection_name, tags=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

Azure resource group

workspace_collection_name

str

Required

Power BI Embedded Workspace Collection name

tags

dict[str, str]

default value: None

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

WorkspaceCollection or ClientRawResponse if raw=true

Return type

WorkspaceCollection,

ClientRawResponse

Exceptions

ErrorException

Attributes

models

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