WorkspacesOperations Class
WorkspacesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectWorkspacesOperations
Constructor
WorkspacesOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_create_or_update |
Creates or updates a workspace resource. |
| begin_delete |
Deletes a Workspace resource. |
| get |
Returns the Workspace resource associated with the given name. |
| list_by_resource_group |
Gets the list of Workspaces within a resource group. |
| list_by_subscription |
Gets the list of Workspaces within a Subscription. |
| update_tags |
Updates an existing workspace's tags. |
begin_create_or_update
Creates or updates a workspace resource.
begin_create_or_update(resource_group_name: str, workspace_name: str, quantum_workspace: _models.QuantumWorkspace, **kwargs: Any) -> LROPoller[_models.QuantumWorkspace]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either QuantumWorkspace or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes a Workspace resource.
begin_delete(resource_group_name: str, workspace_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
get
Returns the Workspace resource associated with the given name.
get(resource_group_name: str, workspace_name: str, **kwargs: Any) -> _models.QuantumWorkspaceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
QuantumWorkspace, or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Gets the list of Workspaces within a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[_models.WorkspaceListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either WorkspaceListResult or the result of cls(response)
Return type
Exceptions
list_by_subscription
Gets the list of Workspaces within a Subscription.
list_by_subscription(**kwargs: Any) -> Iterable[_models.WorkspaceListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either WorkspaceListResult or the result of cls(response)
Return type
Exceptions
update_tags
Updates an existing workspace's tags.
update_tags(resource_group_name: str, workspace_name: str, workspace_tags: _models.TagsObject, **kwargs: Any) -> _models.QuantumWorkspaceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
QuantumWorkspace, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.quantum.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\quantum\\models\\__init__.py'>Feedback
Submit and view feedback for