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]

Verify the specified Power BI Workspace Collection name is valid and not already 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_configOperation configuration overrides.
Return type:

CheckNameResponse

Return type:

ClientRawResponse if raw=true

Raises:

ErrorException

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 workspaces, and can be used to provision keys that provide API access to those 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_configOperation configuration overrides.
Return type:

WorkspaceCollection

Return type:

ClientRawResponse if raw=true

Raises:

ErrorException

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

Raises:

ErrorException

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_configOperation configuration overrides.
Return type:

WorkspaceCollectionAccessKeys

Return type:

ClientRawResponse if raw=true

Raises:

ErrorException

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_configOperation configuration overrides.
Return type:

WorkspaceCollection

Return type:

ClientRawResponse if raw=true

Raises:

ErrorException

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_configOperation configuration overrides.
Return type:

WorkspaceCollectionPaged

Raises:

ErrorException

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

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

Parameters:
Return type:

WorkspaceCollectionPaged

Raises:

ErrorException

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

ErrorException

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_configOperation configuration overrides.
Return type:

WorkspaceCollectionAccessKeys

Return type:

ClientRawResponse if raw=true

Raises:

ErrorException

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_configOperation configuration overrides.
Return type:

WorkspaceCollection

Return type:

ClientRawResponse if raw=true

Raises:

ErrorException

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_configOperation configuration overrides.
Return type:

WorkspacePaged

Raises:

ErrorException