azure.mgmt.powerbiembedded.operations module¶

class azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

WorkspaceCollectionsOperations operations.

Parameters:	client – Client for service requests. config – Configuration of service client. serializer – An object model serializer. deserializer – An objec model deserializer.

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

Check that the specified Power BI Workspace Collection name is valid and not in use.

Parameters:	location (str) – Azure location name (str) – Workspace collection name type (str) – Resource type custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`CheckNameResponse`
Return type:	`ClientRawResponse` if raw=true

create(resource_group_name, workspace_collection_name, location=None, tags=None, custom_headers=None, raw=False, **operation_config)[source]¶

Creates a new Power BI Workspace Collection with the specified properties. A Power BI Workspace Collection contains one or more Power BI Workspaces and can be used to provision keys that provide API access to those Power BI Workspaces.

Parameters:	resource_group_name (str) – Azure resource group workspace_collection_name (str) – Power BI Embedded workspace collection name location (str) – Azure location tags (dict) – custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`WorkspaceCollection`
Return type:	`ClientRawResponse` if raw=true

delete(resource_group_name, workspace_collection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Delete a Power BI Workspace Collection.

Parameters:	resource_group_name (str) – Azure resource group workspace_collection_name (str) – Power BI Embedded workspace collection name custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response
Return type:	`AzureOperationPoller` instance that returns None
Return type:	`ClientRawResponse` if raw=true

get_access_keys(resource_group_name, workspace_collection_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters:	resource_group_name (str) – Azure resource group workspace_collection_name (str) – Power BI Embedded workspace collection name custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`WorkspaceCollectionAccessKeys`
Return type:	`ClientRawResponse` if raw=true

get_by_name(resource_group_name, workspace_collection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves an existing Power BI Workspace Collection.

Parameters:	resource_group_name (str) – Azure resource group workspace_collection_name (str) – Power BI Embedded workspace collection name custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`WorkspaceCollection`
Return type:	`ClientRawResponse` if raw=true

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves all existing Power BI Workspace Collections in the specified resource group.

Parameters:	resource_group_name (str) – Azure resource group custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`WorkspaceCollectionPaged`

list_by_subscription(custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves all existing Power BI Workspace Collections in the specified subscription.

Parameters:	custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`WorkspaceCollectionPaged`

migrate(resource_group_name, target_resource_group=None, resources=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters:	resource_group_name (str) – Azure resource group target_resource_group (str) – Name of the resource group that the Power BI Workspace Collections will be migrated to. resources (list of str) – custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	None
Return type:	`ClientRawResponse` if raw=true

regenerate_key(resource_group_name, workspace_collection_name, key_name=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters:	resource_group_name (str) – Azure resource group workspace_collection_name (str) – Power BI Embedded workspace collection name key_name (str or `AccessKeyName`) – Key name. Possible values include: ‘key1’, ‘key2’ custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`WorkspaceCollectionAccessKeys`
Return type:	`ClientRawResponse` if raw=true

update(resource_group_name, workspace_collection_name, tags=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters:	resource_group_name (str) – Azure resource group workspace_collection_name (str) – Power BI Embedded workspace collection name tags (dict) – custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`WorkspaceCollection`
Return type:	`ClientRawResponse` if raw=true

class azure.mgmt.powerbiembedded.operations.WorkspacesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

WorkspacesOperations operations.

Parameters:	client – Client for service requests. config – Configuration of service client. serializer – An object model serializer. deserializer – An objec model deserializer.

list(resource_group_name, workspace_collection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves all existing Power BI Workspaces in the specified Workspace Collection.

Parameters:	resource_group_name (str) – Azure resource group workspace_collection_name (str) – Power BI Embedded workspace collection name custom_headers (dict) – headers that will be added to the request raw (bool) – returns the direct response alongside the deserialized response operation_config – Operation configuration overrides.
Return type:	`WorkspacePaged`