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.object
WorkspacesOperations

Constructor

WorkspacesOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

Creates or updates a workspace with the specified parameters.

begin_delete

Deletes a machine learning workspace.

get

Gets the properties of the specified machine learning workspace.

list_by_resource_group

Lists all the available machine learning workspaces under the specified resource group.

list_by_subscription

Lists all the available machine learning workspaces under the specified subscription.

list_keys

Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

resync_keys

Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

update

Updates a machine learning workspace with the specified parameters.

begin_create_or_update

Creates or updates a workspace with the specified parameters.

begin_create_or_update(resource_group_name: str, workspace_name: str, parameters: _models.Workspace, **kwargs: Any) -> LROPoller[_models.Workspace]

Parameters

resource_group_name
str
Required

Name of the resource group in which workspace is located.

workspace_name
str
Required

Name of Azure Machine Learning workspace.

parameters
Workspace
Required

The parameters for creating or updating a machine learning workspace.

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

True for ARMPolling, False for no polling, or a polling object for 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 machine learning workspace.

begin_delete(resource_group_name: str, workspace_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name
str
Required

Name of the resource group in which workspace is located.

workspace_name
str
Required

Name of Azure Machine Learning workspace.

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

True for ARMPolling, False for no polling, or a polling object for 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 the properties of the specified machine learning workspace.

get(resource_group_name: str, workspace_name: str, **kwargs: Any) -> _models.Workspace

Parameters

resource_group_name
str
Required

Name of the resource group in which workspace is located.

workspace_name
str
Required

Name of Azure Machine Learning workspace.

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_by_resource_group

Lists all the available machine learning workspaces under the specified resource group.

list_by_resource_group(resource_group_name: str, skiptoken: Optional[str] = None, **kwargs: Any) -> Iterable[_models.WorkspaceListResult]

Parameters

resource_group_name
str
Required

Name of the resource group in which workspace is located.

skiptoken
str
default value: None

Continuation token for pagination.

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

Lists all the available machine learning workspaces under the specified subscription.

list_by_subscription(skiptoken: Optional[str] = None, **kwargs: Any) -> Iterable[_models.WorkspaceListResult]

Parameters

skiptoken
str
default value: None

Continuation token for pagination.

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_keys

Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

list_keys(resource_group_name: str, workspace_name: str, **kwargs: Any) -> _models.ListWorkspaceKeysResult

Parameters

resource_group_name
str
Required

Name of the resource group in which workspace is located.

workspace_name
str
Required

Name of Azure Machine Learning workspace.

cls
callable

A custom type or function that will be passed the direct response

Returns

ListWorkspaceKeysResult, or the result of cls(response)

Return type

Exceptions

resync_keys

Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

resync_keys(resource_group_name: str, workspace_name: str, **kwargs: Any) -> None

Parameters

resource_group_name
str
Required

Name of the resource group in which workspace is located.

workspace_name
str
Required

Name of Azure Machine Learning workspace.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Exceptions

update

Updates a machine learning workspace with the specified parameters.

update(resource_group_name: str, workspace_name: str, parameters: _models.WorkspaceUpdateParameters, **kwargs: Any) -> _models.Workspace

Parameters

resource_group_name
str
Required

Name of the resource group in which workspace is located.

workspace_name
str
Required

Name of Azure Machine Learning workspace.

parameters
WorkspaceUpdateParameters
Required

The parameters for updating a machine learning workspace.

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.machinelearningservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\machinelearningservices\\models\\__init__.py'>