WorkspaceCollectionsOperations Class
WorkspaceCollectionsOperations operations.
- Inheritance
-
builtins.objectWorkspaceCollectionsOperations
Constructor
WorkspaceCollectionsOperations(client, config, serializer, deserializer)Parameters
| Name | Description |
|---|---|
|
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
| Name | Description |
|---|---|
|
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
| Name | Description |
|---|---|
|
location
Required
|
Azure location |
|
name
|
Workspace collection name default value: None
|
|
type
|
Resource type default value: Microsoft.PowerBI/workspaceCollections
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
CheckNameResponse or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
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
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Azure resource group |
|
workspace_collection_name
Required
|
Power BI Embedded Workspace Collection name |
|
location
|
Azure location default value: None
|
|
tags
|
default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
WorkspaceCollection or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
delete
Delete a Power BI Workspace Collection.
delete(resource_group_name, workspace_collection_name, custom_headers=None, raw=False, polling=True, **operation_config)Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Azure resource group |
|
workspace_collection_name
Required
|
Power BI Embedded Workspace Collection name |
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
The poller return type is ClientRawResponse, the direct response alongside the deserialized response default value: False
|
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy default value: True
|
Returns
| Type | Description |
|---|---|
|
<xref:msrestazure.azure_operation.AzureOperationPoller>[None],
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:msrest.pipeline.ClientRawResponse>[None]]
|
An instance of LROPoller that returns None or ClientRawResponse if raw==True |
Exceptions
| Type | Description |
|---|---|
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
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Azure resource group |
|
workspace_collection_name
Required
|
Power BI Embedded Workspace Collection name |
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
WorkspaceCollectionAccessKeys or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
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
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Azure resource group |
|
workspace_collection_name
Required
|
Power BI Embedded Workspace Collection name |
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
WorkspaceCollection or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
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
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Azure resource group |
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of WorkspaceCollection |
Exceptions
| Type | Description |
|---|---|
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
| Name | Description |
|---|---|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of WorkspaceCollection |
Exceptions
| Type | Description |
|---|---|
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
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Azure resource group |
|
target_resource_group
|
Name of the resource group the Power BI workspace collections will be migrated to. default value: None
|
|
resources
|
default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
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
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Azure resource group |
|
workspace_collection_name
Required
|
Power BI Embedded Workspace Collection name |
|
key_name
|
str or
AccessKeyName
Key name. Possible values include: 'key1', 'key2' default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
WorkspaceCollectionAccessKeys or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
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
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Azure resource group |
|
workspace_collection_name
Required
|
Power BI Embedded Workspace Collection name |
|
tags
|
default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
WorkspaceCollection or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.powerbiembedded.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.8\\x64\\Lib\\site-packages\\azure\\mgmt\\powerbiembedded\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for