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 |
Creates a Workspace. |
| begin_delete |
Deletes a Workspace. |
| get |
Gets information about a Workspace. |
| list |
Gets a list of Workspaces associated with the given subscription. |
| list_by_resource_group |
Gets a list of Workspaces within the specified resource group. |
| update |
Updates properties of a Workspace. |
begin_create
Creates a Workspace.
begin_create(resource_group_name: str, workspace_name: str, parameters: _models.WorkspaceCreateParameters, **kwargs: Any) -> LROPoller[_models.Workspace]Parameters
- workspace_name
- str
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters
- <xref:batch_ai.models.WorkspaceCreateParameters>
Workspace creation 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 Workspace or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes a Workspace.
begin_delete(resource_group_name: str, workspace_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- workspace_name
- str
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- 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
Gets information about a Workspace.
get(resource_group_name: str, workspace_name: str, **kwargs: Any) -> _models.WorkspaceParameters
- workspace_name
- str
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Workspace, or the result of cls(response)
Return type
Exceptions
list
Gets a list of Workspaces associated with the given subscription.
list(workspaces_list_options: Optional[_models.WorkspacesListOptions] = None, **kwargs: Any) -> Iterable[_models.WorkspaceListResult]Parameters
- workspaces_list_options
- <xref:batch_ai.models.WorkspacesListOptions>
Parameter group.
- 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_resource_group
Gets a list of Workspaces within the specified resource group.
list_by_resource_group(resource_group_name: str, workspaces_list_by_resource_group_options: Optional[_models.WorkspacesListByResourceGroupOptions] = None, **kwargs: Any) -> Iterable[_models.WorkspaceListResult]Parameters
- workspaces_list_by_resource_group_options
- <xref:batch_ai.models.WorkspacesListByResourceGroupOptions>
Parameter group.
- 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
Updates properties of a Workspace.
update(resource_group_name: str, workspace_name: str, parameters: _models.WorkspaceUpdateParameters, **kwargs: Any) -> _models.WorkspaceParameters
- workspace_name
- str
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters
- <xref:batch_ai.models.WorkspaceUpdateParameters>
Additional parameters for workspace update.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Workspace, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.batchai.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\batchai\\models\\__init__.py'>Feedback
Submit and view feedback for