AzureBlobDatastore Clase

Representa un almacén de datos que guarda la información de conexión a Azure Blob Storage.

No debe trabajar directamente con esta clase. Para crear un almacén de datos de este tipo, use el método register_azure_blob_container de Datastore.

Nota: Cuando se usa un almacén de datos para acceder a los datos, debe tener permiso para acceder a ellos, lo que depende de las credenciales registradas en el almacén de datos.

Inicialice un nuevo almacén de datos de blobs de Azure.

Herencia
AzureBlobDatastore

Constructor

AzureBlobDatastore(workspace, name, container_name, account_name, sas_token=None, account_key=None, protocol=None, endpoint=None, request_session=None, workspace_msi_has_access=False, subscription_id=None, resource_group=None, service_data_access_auth_identity=None)

Parámetros

workspace
Workspace
Requerido

Área de trabajo a la que pertenece este almacén de datos.

name
str
Requerido

Nombre del almacén de datos. Solo puede contener caracteres alfanuméricos, o bien - o _.

container_name
str
Requerido

Nombre del contenedor de blobs.

account_name
str
Requerido

El nombre de la cuenta de almacenamiento.

sas_token
str, <xref:optional>
valor predeterminado: None

Token de SAS para acceder a este contenedor. El valor predeterminado es None.

account_key
str, <xref:optional>
valor predeterminado: None

La clave de la cuenta de almacenamiento. El valor predeterminado es None.

protocol
str, <xref:optional>
valor predeterminado: None

Protocolo que se va a usar para conectarse a la cuenta de almacenamiento. Si es None, el valor predeterminado es https.

endpoint
str, <xref:optional>
valor predeterminado: None

Punto de conexión del contenedor de blobs. Si es None, el valor predeterminado es core.windows.net.

request_session
<xref:requests.Session>, <xref:optional>
valor predeterminado: None

Objeto de sesión que se usará para las solicitudes HTTP. El valor predeterminado es None.

workspace
Workspace
Requerido

Área de trabajo a la que pertenece este almacén de datos.

name
str
Requerido

Nombre del almacén de datos. Solo puede contener caracteres alfanuméricos, o bien - o _.

container_name
str
Requerido

Nombre del contenedor de blobs.

account_name
str
Requerido

El nombre de la cuenta de almacenamiento.

sas_token
str, <xref:optional>
Requerido

Token de SAS para acceder a este contenedor. El valor predeterminado es None.

account_key
str, <xref:optional>
Requerido

La clave de la cuenta de almacenamiento. El valor predeterminado es None.

protocol
str, <xref:optional>
Requerido

Protocolo que se va a usar para conectarse a la cuenta de almacenamiento. Si es None, el valor predeterminado es https.

endpoint
str, <xref:optional>
Requerido

Punto de conexión del contenedor de blobs. Si es None, el valor predeterminado es core.windows.net.

request_session
<xref:requests.Session>, <xref:optional>
Requerido

Objeto de sesión que se usará para las solicitudes HTTP. El valor predeterminado es None.

workspace_msi_has_access
bool, <xref:optional>
valor predeterminado: False

Si el MSI del área de trabajo tiene acceso a esta cuenta de almacenamiento. (En desuso)

subscription_id
str, <xref:optional>
valor predeterminado: None

Identificador de suscripción de la cuenta de almacenamiento.

resource_group
str, <xref:optional>
valor predeterminado: None

El grupo de recursos de la cuenta de almacenamiento.

service_data_access_auth_identity
str o <xref:_restclient.models.ServiceDataAccessAuthIdentity>
valor predeterminado: None

Indica qué identidad se va a usar para autenticar el acceso a datos de servicio para el almacenamiento del cliente. Los valores posibles son: "None", "WorkspaceSystemAssignedIdentity", "WorkspaceUserAssignedIdentity"

Métodos

download

Descargue los datos del contenedor de blobs en el sistema de archivos local.

upload

Carga los datos del sistema de archivos local al contenedor de blobs al que apunta este almacén de datos.

Nota: Para que este método funcione, el objeto de almacén de datos debe tener rellenada la clave de cuenta o la propiedad de token de SAS. Si el objeto de almacén de datos no contiene ninguna forma de credencial, se producirá un error en este método. Además, este método ha quedado en desuso y puede que se quite en el futuro. Se recomienda usar el método Dataset.File.upload_directory para cargar los archivos desde el directorio local y crear FileDataset en una sola llamada de método.

upload_files

Carga los datos del sistema de archivos local al contenedor de blobs al que apunta este almacén de datos.

Nota: Este método está en desuso y ya no se admite. Se recomienda usar FileDatasetFactory.upload_directory en su lugar.

download

Descargue los datos del contenedor de blobs en el sistema de archivos local.

download(target_path, prefix=None, overwrite=False, show_progress=True)

Parámetros

target_path
str
Requerido

Directorio local en el que se descargará el archivo.

prefix
str, <xref:optional>
valor predeterminado: None

Ruta de acceso de la carpeta en el contenedor de blobs que se va a descargar. Si se establece en None, descargará todo el contenido del blob. El valor predeterminado es None.

overwrite
bool, <xref:optional>
valor predeterminado: False

Indica si se van a sobrescribir los archivos existentes. El valor predeterminado es False.

show_progress
bool, <xref:optional>
valor predeterminado: True

Indica si se debe mostrar el progreso de la descarga en la consola. El valor predeterminado es True.

Devoluciones

Número de archivos descargados correctamente.

Tipo de valor devuelto

int

upload

Carga los datos del sistema de archivos local al contenedor de blobs al que apunta este almacén de datos.

Nota: Para que este método funcione, el objeto de almacén de datos debe tener rellenada la clave de cuenta o la propiedad de token de SAS. Si el objeto de almacén de datos no contiene ninguna forma de credencial, se producirá un error en este método. Además, este método ha quedado en desuso y puede que se quite en el futuro. Se recomienda usar el método Dataset.File.upload_directory para cargar los archivos desde el directorio local y crear FileDataset en una sola llamada de método.

upload(src_dir, target_path=None, overwrite=False, show_progress=True)

Parámetros

src_dir
str
Requerido

Directorio local que se cargará.

target_path
str
Requerido

Ubicación en el contenedor de blobs en el que se cargará. Si es None, se carga en la raíz. El valor predeterminado es None.

overwrite
bool, <xref:optional>
Requerido

Indica si se van a sobrescribir los archivos existentes. El valor predeterminado es False.

show_progress
bool, <xref:optional>
Requerido

Indica si se debe mostrar el progreso de la carga en la consola. El valor predeterminado es True.

Devoluciones

Instancia de DataReference para la ruta de acceso de destino de carga.

Tipo de valor devuelto

upload_files

Carga los datos del sistema de archivos local al contenedor de blobs al que apunta este almacén de datos.

Nota: Este método está en desuso y ya no se admite. Se recomienda usar FileDatasetFactory.upload_directory en su lugar.

upload_files(files, relative_root=None, target_path=None, overwrite=False, show_progress=True)

Parámetros

files
list[str]
Requerido

Lista de rutas de acceso absolutas de los archivos que se cargarán.

relative_root
str, <xref:optional>
Requerido

Raíz que se usa para determinar la ruta de acceso de los archivos del blob. Por ejemplo, si cargamos /path/to/file.txt y definimos la ruta de acceso base como /path, cuando file.txt se cargue en el almacenamiento de blobs, tendrá la ruta de acceso /to/file.txt. Si también se proporciona target_path, se usará como prefijo para la ruta de acceso derivada de la anterior. La ruta de acceso base debe ser una ruta de acceso común de todos los archivos; de lo contrario, se producirá una excepción. El valor predeterminado es None, que encontrará la ruta de acceso común.

target_path
str, <xref:optional>
Requerido

Ubicación del contenedor de blobs en el que se cargarán los datos. El valor predeterminado es None, la raíz.

overwrite
bool, <xref:optional>
Requerido

Indica si se van a sobrescribir los archivos existentes. El valor predeterminado es False.

show_progress
bool, <xref:optional>
Requerido

Indica si se debe mostrar el progreso de la carga en la consola. El valor predeterminado es True.

Devoluciones

Instancia de DataReference para la ruta de acceso de destino de carga.

Tipo de valor devuelto