AzureBlobStoreWorkspaceConnection Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

A connection to an Azure Blob Store. Connections of this type are read-only, creation operations with them are not supported, and this class is only meant to be instantiated from GET and LIST workspace connection operations.

Inheritance

azure.ai.ml.entities._workspace.connections.workspace_connection.WorkspaceConnection

AzureBlobStoreWorkspaceConnection

Constructor

AzureBlobStoreWorkspaceConnection(*, target: str, container_name: str, account_name: str, **kwargs)

Parameters

Name	Description
name Required	str Name of the workspace connection.
target Required	str The URL or ARM resource ID of the external resource.
tags Required	dict Tag dictionary. Tags can be added, removed, and updated.
container_name Required	str The name of the container.
account_name Required	str The name of the account.

Methods

dump	Dump the workspace connection spec into a file in yaml format.

dump

Dump the workspace connection spec into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name	Description
dest Required	Union[<xref:PathLike>, str, IO[AnyStr]] The destination to receive this workspace connection's spec. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.

Attributes

account_name

The name of the workspace connection's account

Returns

Type	Description
Optional[str]	The name of the account.

base_path

The base path of the resource.

Returns

Type	Description
str	The base path of the resource.

container_name

The name of the workspace connection's container.

Returns

Type	Description
Optional[str]	The name of the container.

creation_context

The creation context of the resource.

Returns

Type	Description
Optional[SystemData]	The creation metadata for the resource.

credentials

Credentials for workspace connection.

]

Returns

Type	Description
Union[ PatTokenConfiguration, SasTokenConfiguration, UsernamePasswordConfiguration, ServicePrincipalConfiguration, AccessKeyConfiguration, ApiKeyConfiguration	Credentials for workspace connection.

id

The resource ID.

Returns

Type	Description
Optional[str]	The global ID of the resource, an Azure Resource Manager (ARM) ID.

is_shared

Get the Boolean describing if this connection is shared amongst its cohort within a workspace hub. Only applicable for connections created within a lean workspace.

Returns

Type	Description
bool

metadata

Deprecated. Use tags. :return: This connection's tags. :rtype: Dict[str, Any]

target

Target url for the workspace connection.

Returns

Type	Description
str	Target of the workspace connection.

type

Type of the workspace connection, supported are 'git', 'python_feed' and 'container_registry'.

Returns

Type	Description
str	Type of the job.