azure.storage.blob.BlobClient class

Anule una operación de copia en curso.

Esto dejará un blob de destino con longitud cero y metadatos completos. Esto generará un error si la operación de copia ya ha finalizado.

abort_copy(copy_id: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> None

Parámetros

copy_id: str o BlobProperties

Requerido

Operación de copia que se va a anular. Puede ser una cadena de identificador o una instancia de BlobProperties.

Tipo de valor devuelto

None

Solicita una nueva concesión.

Si el blob no tiene una concesión activa, Blob Service crea una concesión en el blob y devuelve una nueva concesión.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs: Any) -> BlobLeaseClient

Parámetros

lease_duration: int

Requerido

Especifica la duración de la concesión, en segundos, o bien un valor negativo (-1) para una concesión que no expira nunca. Un concesión no infinita puede durar entre 15 y 60 segundos. Una duración de concesión no se puede cambiar mediante renovación o cambio. El valor predeterminado es -1 (concesión infinita).

lease_id: str

Requerido

Identificador de concesión propuesto, con formato de cadena de GUID. Blob Service devuelve 400 (solicitud no válida) si el identificador de concesión propuesto no tiene el formato correcto.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Un objeto BlobLeaseClient.

Tipo de valor devuelto

BlobLeaseClient

Confirma un nuevo bloque de datos al final del blob en anexos existente.

append_block(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Parámetros

data: bytes o str o Iterable

Requerido

Contenido del bloque. Puede ser bytes, texto, un objeto iterable o similar a un archivo.

length: int

Requerido

Tamaño del bloque en bytes.

validate_content: bool

Si es true, calcula un hash MD5 del contenido del bloque. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si se usa http en lugar de https, como https (el valor predeterminado), ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el blob.

maxsize_condition: int

Encabezado condicional opcional. Longitud máxima en bytes permitida para el blob en anexos. Si la operación Append Block haría que el blob supere ese límite o si el tamaño del blob ya es mayor que el valor especificado en este encabezado, la solicitud producirá un error MaxBlobSizeConditionNotMet (código de estado HTTP 412 - Error de condición previa).

appendpos_condition: int

Encabezado condicional opcional, que solo se usa para la operación Append Block. Número que indica el desplazamiento de bytes que se va a comparar. Append Block solo se realizará correctamente si la posición de anexión es igual a este número. Si no es así, se producirá un error en la solicitud con el error AppendPositionConditionNotMet (código de estado HTTP 412 - Error de condición previa).

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

encoding: str

El valor predeterminado es UTF-8.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedad de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag, última modificación, desplazamiento de anexión, recuento de bloques confirmado).

Tipo de valor devuelto

dict(str, Any)

Crea un nuevo bloque que se va a confirmar como parte de un blob, donde el contenido se lee desde una dirección URL de origen.

append_block_from_url(copy_source_url: str, source_offset: int | None = None, source_length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Parámetros

copy_source_url: str

Requerido

Dirección URL de los datos de origen. Puede apuntar a cualquier blob o archivo de Azure, que sea público o tenga asociada una firma de acceso compartido.

source_offset: int

Requerido

Esto indica el inicio del intervalo de bytes (inclusive) que se debe tomar del origen de copia.

source_length: int

Requerido

Esto indica el final del intervalo de bytes que se debe tomar del origen de copia.

source_content_md5: bytearray

Si se indica, el servicio calculará el hash MD5 del contenido del bloque y se comparará con este valor.

maxsize_condition: int

Encabezado condicional opcional. Longitud máxima en bytes permitida para el blob en anexos. Si la operación Append Block haría que el blob supere ese límite o si el tamaño del blob ya es mayor que el valor especificado en este encabezado, la solicitud producirá un error MaxBlobSizeConditionNotMet (código de estado HTTP 412 - Error de condición previa).

appendpos_condition: int

Encabezado condicional opcional, que solo se usa para la operación Append Block. Número que indica el desplazamiento de bytes que se va a comparar. Append Block solo se realizará correctamente si la posición de anexión es igual a este número. Si no es así, se producirá un error en la solicitud con el error AppendPositionConditionNotMet (código de estado HTTP 412 - Error de condición previa).

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag de destino o carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia de destino que se va a usar en la etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

source_if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si el recurso de origen se ha modificado desde la hora especificada.

source_if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si el recurso de origen no se ha modificado desde la fecha y hora especificadas.

source_etag: str

Valor ETag de origen o carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

source_match_condition: MatchConditions

Condición de coincidencia de origen que se va a usar en el etag.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedad de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

source_authorization: str

Autentíquese como entidad de servicio mediante un secreto de cliente para acceder a un blob de origen. Asegúrese de que "bearer" es el prefijo de la cadena source_authorization.

Borra un intervalo de páginas.

clear_page(offset: int, length: int, **kwargs: Any) -> Dict[str, str | datetime]

Parámetros

offset: int

Requerido

Inicio del intervalo de bytes que se va a usar para escribir en una sección del blob. Las páginas deben alinearse con límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

length: int

Requerido

Número de bytes que se van a usar para escribir en una sección del blob. Las páginas deben alinearse con límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_sequence_number_lte: int

Si el número de secuencia del blob es menor o igual que el valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_sequence_number_lt: int

Si el número de secuencia del blob es menor que el valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_sequence_number_eq: int

Si el número de secuencia del blob es igual al valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

Este método consiste en cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contextos.

close()

La operación Commit Block List escribe un blob especificando la lista de identificadores de bloque que componen el blob.

commit_block_list(block_list: List[BlobBlock], content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Parámetros

block_list: list

Requerido

Lista de blockblobs.

content_settings: ContentSettings

Requerido

Objeto ContentSettings usado para establecer propiedades de blob. Se usa para establecer el tipo de contenido, la codificación, el idioma, la disposición, md5 y el control de caché.

metadata: dict[str, str]

Requerido

Pares nombre-valor asociados al blob como metadatos.

tags: dict(str, str)

Pares nombre-valor asociados al blob como etiqueta. Las etiquetas distinguen mayúsculas de minúsculas. El conjunto de etiquetas puede contener como máximo 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres y los valores de etiqueta deben tener entre 0 y 256 caracteres. Los caracteres válidos de clave y valor de etiqueta incluyen: letras minúsculas y mayúsculas, dígitos (0-9), espacio (), más ( >><<+), menos (-), punto (.), solidus (/), dos puntos (:), iguales (=), subrayado (_)

Novedades de la versión 12.4.0.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

immutability_policy: ImmutabilityPolicy

Especifica la directiva de inmutabilidad de un blob, una instantánea de blob o una versión de blob.

Novedad de la versión 12.10.0: se introdujo en la versión de API "2020-10-02".

legal_hold: bool

Se especifica si se debe establecer una suspensión legal en el blob.

Novedad de la versión 12.10.0: se introdujo en la versión de API "2020-10-02".

validate_content: bool

Si es true, calcula un hash MD5 del contenido de la página. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si usa http en lugar de https, como https (valor predeterminado), ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el blob.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para que funcione solo en el blob de destino con un valor coincidente.

Novedades de la versión 12.4.0.

standard_blob_tier: StandardBlobTier

Valor de nivel de blob estándar en el que se va a establecer el blob. Para esta versión de la biblioteca, esto solo se aplica a blobs en bloques en cuentas de almacenamiento estándar.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Un ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedades de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

Crea un nuevo blob en anexos. Esta operación crea un nuevo blob en anexos de 0 longitud. El contenido de cualquier blob existente se sobrescribe con el blob en anexos recién inicializado. Para agregar contenido al blob en anexos, llame al append_block método o append_block_from_url .

create_append_blob(content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parámetros

content_settings: ContentSettings

Requerido

Objeto ContentSettings usado para establecer propiedades de blob. Se usa para establecer el tipo de contenido, la codificación, el idioma, la disposición, md5 y el control de caché.

metadata: dict(str, str)

Requerido

Pares nombre-valor asociados al blob como metadatos.

tags: dict(str, str)

Pares nombre-valor asociados al blob como etiqueta. Las etiquetas distinguen mayúsculas de minúsculas. El conjunto de etiquetas puede contener como máximo 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres y los valores de etiqueta deben tener entre 0 y 256 caracteres. Los caracteres válidos de clave y valor de etiqueta incluyen: letras minúsculas y mayúsculas, dígitos (0-9), espacio (), más ( >><<+), menos (-), punto (.), solidus (/), dos puntos (:), iguales (=), subrayado (_)

Novedades de la versión 12.4.0.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

immutability_policy: ImmutabilityPolicy

Especifica la directiva de inmutabilidad de un blob, una instantánea de blob o una versión de blob.

Novedad de la versión 12.10.0: se introdujo en la versión de API "2020-10-02".

legal_hold: bool

Se especifica si se debe establecer una suspensión legal en el blob.

Novedad de la versión 12.10.0: se introdujo en la versión de API "2020-10-02".

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedad de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación).

Tipo de valor devuelto

dict[str, Any]

Crea un nuevo blob en páginas del tamaño especificado.

create_page_blob(size: int, content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, premium_page_blob_tier: str | PremiumPageBlobTier | None = None, **kwargs) -> Dict[str, str | datetime]

Parámetros

size: int

Requerido

Especifica el tamaño máximo del blob en páginas, hasta 1 TB. El tamaño del blob en páginas se debe alinear con un límite de 512 bytes.

content_settings: ContentSettings

Requerido

Objeto ContentSettings usado para establecer propiedades de blob. Se usa para establecer el tipo de contenido, la codificación, el idioma, la disposición, md5 y el control de caché.

metadata: dict(str, str)

Requerido

Pares nombre-valor asociados al blob como metadatos.

premium_page_blob_tier: PremiumPageBlobTier

Requerido

Valor de nivel de blob en páginas en el que se va a establecer el blob. El nivel se correlaciona con el tamaño del blob y el número de IOPS permitidas. Esto solo se aplica a los blobs en páginas en cuentas de Premium Storage.

tags: dict(str, str)

Pares nombre-valor asociados al blob como etiqueta. Las etiquetas distinguen mayúsculas de minúsculas. El conjunto de etiquetas puede contener como máximo 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres y los valores de etiqueta deben tener entre 0 y 256 caracteres. Entre los caracteres de clave y valor válidos se incluyen: letras minúsculas y mayúsculas, dígitos (0-9), espacio (), más ( >><<+), menos (-), punto (.), solidus (/), dos puntos (:), iguales (=), subrayado (_)

Novedad de la versión 12.4.0.

sequence_number: int

Solo para blobs en páginas. El número de secuencia es un valor controlado por el usuario que se puede utilizar para hacer un seguimiento de las solicitudes. El valor del número de secuencia debe estar comprendido entre 0 y 2^63 - 1. El valor predeterminado es 0.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

immutability_policy: ImmutabilityPolicy

Especifica la directiva de inmutabilidad de un blob, una instantánea de blob o una versión de blob.

Novedad de la versión 12.10.0: Se introdujo en la versión de API "2020-10-02".

legal_hold: bool

Se especifica si se debe establecer una suspensión legal en el blob.

Novedad de la versión 12.10.0: Se introdujo en la versión de API "2020-10-02".

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedad de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación).

Tipo de valor devuelto

dict[str, Any]

Crea una instantánea del blob.

Una instantánea es una versión de solo lectura de un blob que se ha realizado en un momento dado. Se puede leer, copiar o eliminar, pero no modificar. Las instantáneas le ofrecen una oportunidad de realizar una copia de seguridad de un blob en el momento en que éste aparezca.

Una instantánea de un blob tiene el mismo nombre que el blob base desde el que se toma la instantánea, con un valor DateTime anexado para indicar la hora en la que se tomó la instantánea.

create_snapshot(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parámetros

metadata: dict(str, str)

Requerido

Pares nombre-valor asociados al blob como metadatos.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob de destino con un valor coincidente.

Novedad de la versión 12.4.0.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedades de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (id. de instantánea, Etag y última modificación).

Tipo de valor devuelto

dict[str, Any]

Marca el blob especificado para su eliminación.

El blob se elimina posteriormente durante la recolección de elementos no utilizados. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo con la operación delete_blob().

Si se habilita una directiva de retención de eliminación para el servicio, esta operación elimina temporalmente el blob y conserva el blob durante un número especificado de días. Después del número de días especificado, los datos del blob se quitan del servicio durante la recolección de elementos no utilizados. Se puede acceder al blob eliminado temporalmente mediante list_blobs la especificación de la opción include=['deleted']. El blob eliminado temporalmente se puede restaurar mediante <xref:azure.storage.blob.undelete> la operación .

delete_blob(delete_snapshots: str = None, **kwargs: Any) -> None

Parámetros

delete_snapshots: str

Requerido

Obligatorio si el blob tiene instantáneas asociadas. Estos valores incluyen:

"only": elimina solo las instantáneas de blobs.
"include": elimina el blob junto con todas las instantáneas.

version_id: str

El parámetro version id es un valor DateTime opaco que, cuando está presente, especifica la versión del blob que se va a eliminar.

Novedades de la versión 12.4.0.

Este argumento de palabra clave se introdujo en la versión de API "2019-12-12".

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. Si se especifica, delete_blob solo se realiza correctamente si la concesión del blob está activa y coincide con este identificador. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Tipo de valor devuelto

None

La operación Eliminar directiva de inmutabilidad elimina la directiva de inmutabilidad en el blob.

Novedad de la versión 12.10.0: esta operación se introdujo en la versión de API "2020-10-02".

delete_immutability_policy(**kwargs: Any) -> None

Parámetros

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Pares clave-valor de etiquetas de blob.

Tipo de valor devuelto

Dict[str, str]

Descarga un blob en StorageStreamDownloader. El método readall() debe usarse para leer todo el contenido o readinto() para descargar el blob en una secuencia. El uso de chunks() devuelve un iterador que permite al usuario iterar el contenido en fragmentos.

download_blob(offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]

Parámetros

offset: int

Requerido

Inicio del intervalo de bytes que se va a usar para descargar una sección del blob. Debe establecerse si se proporciona longitud.

length: int

Requerido

Número de bytes que se van a leer de la secuencia. Esto es opcional, pero debe proporcionarse para obtener un rendimiento óptimo.

version_id: str

El parámetro version id es un valor DateTime opaco que, cuando está presente, especifica la versión del blob que se va a descargar.

Novedades de la versión 12.4.0.

Este argumento de palabra clave se introdujo en la versión de API "2019-12-12".

validate_content: bool

Si es true, calcula un hash MD5 para cada fragmento del blob. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si usa http en lugar de https, como https (valor predeterminado), ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el blob. Tenga en cuenta también que, si está habilitado, el algoritmo de carga eficaz para memoria no se usará porque la computación del hash MD5 requiere almacenamiento en búfer de bloques completos y, al hacerlo, se anula el propósito del algoritmo eficiente en memoria.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. Si se especifica, download_blob solo se realiza correctamente si la concesión del blob está activa y coincide con este identificador. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

max_concurrency: int

Número de conexiones paralelas con las que se va a descargar.

encoding: str

Codificación para descodificar los bytes descargados. El valor predeterminado es None, es decir, sin descodificación.

progress_hook: Callable[[int, int], None]

Devolución de llamada para realizar un seguimiento del progreso de una descarga de larga duración. La firma es function(current: int, total: int) donde current es el número de bytes transferidos hasta ahora, y total es el tamaño total de la descarga.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí. Este método puede realizar varias llamadas al servicio y el tiempo de espera se aplicará a cada llamada individualmente. varias llamadas al servicio de Azure y el tiempo de espera se aplicará a cada llamada individualmente.

Devoluciones

Objeto de streaming (StorageStreamDownloader)

Tipo de valor devuelto

StorageStreamDownloader

Devuelve True si existe un blob con los parámetros definidos y devuelve False de lo contrario.

exists(**kwargs: Any) -> bool

Parámetros

version_id: str

El parámetro version id es un valor DateTime opaco que, cuando está presente, especifica la versión del blob para comprobar si existe.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

boolean

Tipo de valor devuelto

bool

Cree BlobClient a partir de una dirección URL de blob. Esto no admite la dirección URL de blob personalizada con "/" en el nombre del blob.

from_blob_url(blob_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, snapshot: str | Dict[str, Any] | None = None, **kwargs: Any) -> Self

Parámetros

blob_url: str

Requerido

Dirección URL completa del punto de conexión al blob, incluido el token de SAS y la instantánea si se usa. Puede ser el punto de conexión principal o el punto de conexión secundario en función del location_mode actual.

credential: Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>

valor predeterminado: None

Credenciales con las que se va a autenticar. Esto es opcional si la dirección URL de la cuenta ya tiene un token de SAS o el cadena de conexión ya tiene valores de clave de acceso compartido. El valor puede ser una cadena de token de SAS, una instancia de AzureSasCredential o AzureNamedKeyCredential de azure.core.credentials, una clave de acceso compartido de cuenta o una instancia de una clase TokenCredentials de azure.identity. Si el URI del recurso ya contiene un token de SAS, se omitirá en favor de una credencial explícita.

excepto en el caso de AzureSasCredential, donde los tokens de SAS en conflicto generarán un valor ValueError. Si usa una instancia de AzureNamedKeyCredential, "name" debe ser el nombre de la cuenta de almacenamiento y "key" debe ser la clave de la cuenta de almacenamiento.

snapshot: str

valor predeterminado: None

Instantánea de blob opcional en la que se va a operar. Puede ser la cadena de identificador de instantánea o la respuesta devuelta desde create_snapshot. Si se especifica, esto invalidará la instantánea en la dirección URL.

version_id: str

El parámetro version id es un valor DateTime opaco en el que, cuando está presente, especifica la versión del blob en el que se va a operar.

Devoluciones

Un cliente de blobs.

Tipo de valor devuelto

BlobClient

Cree BlobClient a partir de una cadena de conexión.

from_connection_string(conn_str: str, container_name: str, blob_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parámetros

conn_str: str

Requerido

Una cadena de conexión a una cuenta de Azure Storage.

container_name: str

Requerido

Nombre del contenedor del blob.

blob_name: str

Requerido

Nombre del blob con el que se va a interactuar.

snapshot: str

valor predeterminado: None

Instantánea de blob opcional en la que se va a operar. Puede ser la cadena de identificador de instantánea o la respuesta devuelta desde create_snapshot.

credential: Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>

valor predeterminado: None

Credenciales con las que se va a autenticar. Esto es opcional si la dirección URL de la cuenta ya tiene un token de SAS o el cadena de conexión ya tiene valores de clave de acceso compartido. El valor puede ser una cadena de token de SAS, una instancia de AzureSasCredential o AzureNamedKeyCredential de azure.core.credentials, una clave de acceso compartido de cuenta o una instancia de una clase TokenCredentials de azure.identity. Las credenciales proporcionadas aquí tendrán prioridad sobre las de la cadena de conexión. Si usa una instancia de AzureNamedKeyCredential, "name" debe ser el nombre de la cuenta de almacenamiento y "key" debe ser la clave de la cuenta de almacenamiento.

version_id: str

El parámetro version id es un valor DateTime opaco en el que, cuando está presente, especifica la versión del blob en el que se va a operar.

Devoluciones

Un cliente de blobs.

Tipo de valor devuelto

BlobClient

Obtiene información relacionada con la cuenta de almacenamiento en la que reside el blob.

La información también se puede recuperar si el usuario tiene una SAS en un contenedor o blob. Las claves del diccionario devuelto incluyen "sku_name" y "account_kind".

get_account_information(**kwargs: Any) -> Dict[str, str]

Devoluciones

Un dict de información de cuenta (SKU y tipo de cuenta).

Tipo de valor devuelto

dict(str, str)

Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el blob. No devuelve el contenido de los blobs.

get_blob_properties(**kwargs: Any) -> BlobProperties

Parámetros

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

version_id: str

El parámetro version id es un valor DateTime opaco que, cuando está presente, especifica la versión del blob para obtener propiedades.

Novedades de la versión 12.4.0.

Este argumento de palabra clave se introdujo en la versión de API "2019-12-12".

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

BlobProperties

Tipo de valor devuelto

BlobProperties

La operación Obtener etiquetas permite a los usuarios obtener etiquetas en una versión de blob o blob específica, o instantánea.

Novedad de la versión 12.4.0: Esta operación se introdujo en la versión de API "2019-12-12".

get_blob_tags(**kwargs: Any) -> Dict[str, str]

Parámetros

version_id: str

El parámetro version id es un valor DateTime opaco al que, cuando está presente, especifica la versión del blob al que se van a agregar etiquetas.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para que funcione solo en el blob de destino con un valor coincidente. P. ej. "\"tagname\"='my tag'"

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Pares clave-valor de etiquetas de blob.

Tipo de valor devuelto

Dict[str, str]

La operación Obtener lista de bloques recupera la lista de bloques que se han cargado como parte de un blob en bloques.

get_block_list(block_list_type: str | None = 'committed', **kwargs: Any) -> Tuple[List[BlobBlock], List[BlobBlock]]

Parámetros

block_list_type: str

Requerido

Especifica si se debe devolver la lista de bloques confirmados, la lista de bloques sin confirmar o ambas listas. Entre los valores posibles se incluyen: 'committed', 'uncommitted', 'all'

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para que funcione solo en el blob de destino con un valor coincidente.

Novedades de la versión 12.4.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Una tupla de dos listas: bloques confirmados y no confirmados

Tipo de valor devuelto

tuple(list(BlobBlock), list(BlobBlock))

Devuelve la lista de intervalos de páginas válidos para un disco administrado o una instantánea.

Nota

Esta operación solo está disponible para las cuentas de disco administrado.

Novedad de la versión 12.2.0: esta operación se introdujo en la versión de API "2019-07-07".

get_page_range_diff_for_managed_disk(previous_snapshot_url: str, offset: int | None = None, length: int | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Parámetros

previous_snapshot_url

Requerido

Especifica la dirección URL de una instantánea anterior del disco administrado. La respuesta solo contendrá páginas que se cambiaron entre el blob de destino y su instantánea anterior.

offset: int

Requerido

Inicio del intervalo de bytes que se va a usar para obtener intervalos de páginas válidos. Si no se especifica ninguna longitud, se buscarán todos los bytes después del desplazamiento. Las páginas deben alinearse con límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

length: int

Requerido

Número de bytes que se van a usar para obtener intervalos de página válidos. Si se proporciona longitud, se debe proporcionar el desplazamiento. Este intervalo devolverá intervalos de página válidos desde el inicio de desplazamiento hasta la longitud especificada. Las páginas deben alinearse con límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Una tupla de dos listas de intervalos de páginas como diccionarios con claves "start" y "end". El primer elemento son intervalos de páginas rellenados, el segundo elemento está borrado de intervalos de páginas.

Tipo de valor devuelto

tuple(list(dict(str, str), list(dict(str, str))

EN DESUSO: devuelve la lista de intervalos de páginas válidos para un blob en páginas o una instantánea de un blob en páginas.

get_page_ranges(offset: int | None = None, length: int | None = None, previous_snapshot_diff: str | Dict[str, Any] | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Parámetros

offset: int

Requerido

Inicio del intervalo de bytes que se va a usar para obtener intervalos de páginas válidos. Si no se especifica ninguna longitud, se buscarán todos los bytes después del desplazamiento. Las páginas deben alinearse con límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

length: int

Requerido

Número de bytes que se van a usar para obtener intervalos de página válidos. Si se proporciona longitud, se debe proporcionar el desplazamiento. Este intervalo devolverá intervalos de página válidos desde el inicio de desplazamiento hasta la longitud especificada. Las páginas deben alinearse con límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

previous_snapshot_diff: str

Requerido

Parámetro de diferencia de instantánea que contiene un valor DateTime opaco que especifica una instantánea de blob anterior que se va a comparar con una instantánea más reciente o el blob actual.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Una tupla de dos listas de intervalos de páginas como diccionarios con claves "start" y "end". El primer elemento son intervalos de páginas rellenados, el segundo elemento está borrado de intervalos de páginas.

Tipo de valor devuelto

tuple(list(dict(str, str), list(dict(str, str))

Devuelve la lista de intervalos de páginas válidos para un blob en páginas o una instantánea de un blob en páginas. Si se especifica previous_snapshot , el resultado será una diferencia de los cambios entre el blob de destino y la instantánea anterior.

list_page_ranges(*, offset: int | None = None, length: int | None = None, previous_snapshot: str | Dict[str, Any] | None = None, **kwargs: Any) -> ItemPaged[PageRange]

Parámetros

offset: int

Inicio del intervalo de bytes que se va a usar para obtener intervalos de páginas válidos. Si no se especifica ninguna longitud, se buscarán todos los bytes después del desplazamiento. Las páginas deben alinearse con límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

length: int

Número de bytes que se van a usar para obtener intervalos de página válidos. Si se proporciona longitud, se debe proporcionar el desplazamiento. Este intervalo devolverá intervalos de página válidos desde el inicio de desplazamiento hasta la longitud especificada. Las páginas deben alinearse con límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

previous_snapshot: str o Dict[str, Any]

Valor de instantánea que especifica que la respuesta contendrá solo las páginas que se cambiaron entre el blob de destino y la instantánea anterior. Las páginas modificadas incluyen páginas actualizadas y desactivadas. El blob de destino puede ser una instantánea, siempre que la instantánea especificada por previous_snapshot sea la anterior de las dos.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

results_per_page: int

Número máximo de intervalos de páginas que se van a recuperar por llamada API.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Iterable (paginación automática) de PageRange.

Tipo de valor devuelto

ItemPaged[PageRange]

Permite a los usuarios seleccionar o proyectar en los datos de instantáneas de blobs o blobs proporcionando expresiones de consulta simples. Estas operaciones devuelven un BlobQueryReader, los usuarios deben usar readall() o readinto() para obtener datos de consulta.

query_blob(query_expression: str, **kwargs: Any) -> BlobQueryReader

Parámetros

query_expression: str

Requerido

Necesario. una instrucción de consulta. Para más información, consulte https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

on_error: Callable[BlobQueryError]

Función a la que se llamará en los errores de procesamiento devueltos por el servicio.

blob_format: DelimitedTextDialect o DelimitedJsonDialect o QuickQueryDialect o str

Opcional. Define la serialización de los datos almacenados actualmente en el blob. El valor predeterminado es tratar los datos del blob como datos CSV con formato en el dialecto predeterminado. Esto se puede invalidar con un DelimitedTextDialect personalizado o DelimitedJsonDialect o "ParquetDialect" (pasado como una cadena o enumeración). Estos dialectos se pueden pasar a través de sus respectivas clases, la enumeración QuickQueryDialect o como una cadena

output_format: DelimitedTextDialect o DelimitedJsonDialect o list[ArrowDialect] o QuickQueryDialect o str

Opcional. Define la serialización de salida para el flujo de datos. De forma predeterminada, los datos se devolverán, ya que se representan en el blob (los formatos Parquet tienen como valor predeterminado DelimitedTextDialect). Al proporcionar un formato de salida, los datos del blob se volverán a formatear según ese perfil. Este valor puede ser DelimitedTextDialect o DelimitedJsonDialect o ArrowDialect. Estos dialectos se pueden pasar a través de sus respectivas clases, la enumeración QuickQueryDialect o como una cadena

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Objeto de streaming (BlobQueryReader)

Tipo de valor devuelto

BlobQueryReader

Cambia el tamaño de un blob en páginas por el tamaño especificado.

Si el valor especificado es menor que el tamaño actual del blob, se borran todas las páginas cuyo valor sea mayor que el especificado.

resize_blob(size: int, **kwargs: Any) -> Dict[str, str | datetime]

Parámetros

size: int

Requerido

Tamaño usado para cambiar el tamaño del blob. El tamaño máximo de un blob en páginas es de hasta 1 TB. El tamaño del blob en páginas se debe alinear con un límite de 512 bytes.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

premium_page_blob_tier: PremiumPageBlobTier

Valor de nivel de blob en páginas en el que se va a establecer el blob. El nivel se correlaciona con el tamaño del blob y el número de IOPS permitidas. Esto solo se aplica a blobs en páginas en cuentas de Premium Storage.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

La operación Seal sella el blob en anexos para que sea de solo lectura.

Novedades de la versión 12.4.0.

seal_append_blob(**kwargs) -> Dict[str, str | datetime | int]

Parámetros

appendpos_condition: int

Encabezado condicional opcional, que solo se usa para la operación Append Block. Número que indica el desplazamiento de bytes que se va a comparar. Append Block solo se realizará correctamente si la posición de anexión es igual a este número. Si no es así, se producirá un error en la solicitud con el error AppendPositionConditionNotMet (código de estado HTTP 412 - Error de condición previa).

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag, última modificación, desplazamiento de anexión, recuento de bloques confirmado).

Tipo de valor devuelto

dict(str, Any)

Establece los metadatos definidos por el usuario para el blob como uno o varios pares nombre-valor.

set_blob_metadata(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parámetros

metadata: dict(str, str)

Requerido

Dict que contiene pares nombre y valor. Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntados al blob. Para quitar todos los metadatos del blob, llame a esta operación sin encabezados de metadatos.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Un ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedades de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación)

La operación Establecer etiquetas permite a los usuarios establecer etiquetas en una versión de blob o de blob específica, pero no instantáneas. Cada llamada a esta operación reemplaza todas las etiquetas existentes asociadas al blob. Para quitar todas las etiquetas del blob, llame a esta operación sin establecer etiquetas.

Novedad de la versión 12.4.0: Esta operación se introdujo en la versión de API "2019-12-12".

set_blob_tags(tags: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, Any]

Parámetros

tags: dict(str, str)

Requerido

Pares nombre-valor asociados al blob como etiqueta. Las etiquetas distinguen mayúsculas de minúsculas. El conjunto de etiquetas puede contener como máximo 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres y los valores de etiqueta deben tener entre 0 y 256 caracteres. Los caracteres válidos de clave y valor de etiqueta incluyen: letras minúsculas y mayúsculas, dígitos (0-9), espacio (), más ( >><<+), menos (-), punto (.), solidus (/), dos puntos (:), iguales (=), subrayado (_)

version_id: str

El parámetro version id es un valor DateTime opaco al que, cuando está presente, especifica la versión del blob al que se van a agregar etiquetas.

validate_content: bool

Si es true, calcula un hash MD5 del contenido de las etiquetas. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si usa http en lugar de https, como https (valor predeterminado), ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el blob.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para que funcione solo en el blob de destino con un valor coincidente. P. ej. "\"tagname\"='my tag'"

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación)

Tipo de valor devuelto

Dict[str, Any]

Establece las propiedades del sistema en el blob.

Si se establece una propiedad para el content_settings, todas las propiedades se invalidarán.

set_http_headers(content_settings: ContentSettings | None = None, **kwargs: Any) -> None

Parámetros

content_settings: ContentSettings

Requerido

Objeto ContentSettings usado para establecer propiedades de blob. Se usa para establecer el tipo de contenido, la codificación, el idioma, la disposición, md5 y el control de caché.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación)

Tipo de valor devuelto

Dict[str, Any]

La operación Establecer directiva de inmutabilidad establece la directiva de inmutabilidad en el blob.

Novedad de la versión 12.10.0: esta operación se introdujo en la versión de API "2020-10-02".

set_immutability_policy(immutability_policy: ImmutabilityPolicy, **kwargs: Any) -> Dict[str, str]

Parámetros

immutability_policy: ImmutabilityPolicy

Requerido

Especifica la directiva de inmutabilidad de un blob, una instantánea de blob o una versión de blob.

Novedad de la versión 12.10.0: se introdujo en la versión de API "2020-10-02".

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Pares clave-valor de etiquetas de blob.

Tipo de valor devuelto

Dict[str, str]

La operación Establecer suspensión legal establece una suspensión legal en el blob.

Novedad de la versión 12.10.0: esta operación se introdujo en la versión de API "2020-10-02".

set_legal_hold(legal_hold: bool, **kwargs: Any) -> Dict[str, str | datetime | bool]

Parámetros

legal_hold: bool

Requerido

Se especifica si se debe establecer una suspensión legal en el blob.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Pares clave-valor de etiquetas de blob.

Tipo de valor devuelto

Dict[str, Union[str, datetime, bool]]

Establece los niveles de blob en páginas del blob. Esta API solo se admite para blobs en páginas en cuentas Premium.

set_premium_page_blob_tier(premium_page_blob_tier: str | PremiumPageBlobTier, **kwargs: Any) -> None

Parámetros

premium_page_blob_tier: PremiumPageBlobTier

Requerido

Valor de nivel de blob en páginas en el que se va a establecer el blob. El nivel se correlaciona con el tamaño del blob y el número de IOPS permitidas. Esto solo se aplica a los blobs en páginas en cuentas de Premium Storage.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

Tipo de valor devuelto

None

Establece el número de secuencia del blob.

set_sequence_number(sequence_number_action: str | SequenceNumberAction, sequence_number: str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parámetros

sequence_number_action: str

Requerido

Esta propiedad indica el modo en que el servicio debe modificar el número de secuencia del blob. Consulte SequenceNumberAction para obtener más información.

sequence_number: str

Requerido

Esta propiedad establece el número de secuencia del blob. El número de secuencia es una propiedad controlada por el usuario que se puede utilizar para hacer un seguimiento de las solicitudes y administrar los problemas de simultaneidad.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

Esta operación establece el nivel en un blob en bloques.

El nivel de un blob en bloques determina el tipo de almacenamiento de acceso frecuente, esporádico o de archivo. Esta operación no actualiza la etiqueta ETag del blob.

set_standard_blob_tier(standard_blob_tier: str | StandardBlobTier, **kwargs: Any) -> None

Parámetros

standard_blob_tier: str o StandardBlobTier

Requerido

Indica el nivel que se va a establecer en el blob. Entre las opciones se incluyen "Frecuente", "Esporádico", "Archivo". El nivel de acceso frecuente está optimizado para almacenar datos a los que se accede con frecuencia. El nivel de almacenamiento esporádico está optimizado para almacenar datos a los que se accede con poca frecuencia y se almacena durante al menos un mes. El nivel de archivo está optimizado para almacenar datos a los que rara vez se accede y se almacena durante al menos seis meses con requisitos de latencia flexibles.

rehydrate_priority: RehydratePriority

Indica la prioridad con la que rehidratar un blob archivado.

version_id: str

El parámetro version id es un valor DateTime opaco que, cuando está presente, especifica la versión del blob que se va a descargar.

Novedad de la versión 12.4.0.

Este argumento de palabra clave se introdujo en la versión de API "2019-12-12".

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

Tipo de valor devuelto

None

Crea un nuevo bloque que se confirmará como parte de un blob.

stage_block(block_id: str, data: Iterable | IO, length: int | None = None, **kwargs) -> Dict[str, Any]

Parámetros

block_id: str

Requerido

Valor de cadena que identifica el bloque. La cadena debe tener un tamaño inferior o igual a 64 bytes. Para un blob determinado, el block_id debe tener el mismo tamaño para cada bloque.

data

Requerido

Los datos del blob.

length: int

Requerido

Tamaño del bloque.

validate_content: bool

Si es true, calcula un hash MD5 para cada fragmento del blob. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si se usa http en lugar de https, como https (el valor predeterminado), ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el blob. Tenga en cuenta también que si está habilitado, el algoritmo de carga eficaz para memoria no se usará porque calcular el hash MD5 requiere almacenar en búfer bloques completos y, al hacerlo, se anula el propósito del algoritmo eficiente en memoria.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

encoding: str

El valor predeterminado es UTF-8.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedad de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad de blob.

Tipo de valor devuelto

dict[str, Any]

Crea un nuevo bloque que se confirmará como parte de un blob donde el contenido se lee desde una dirección URL.

stage_block_from_url(block_id: str | int, source_url: str, source_offset: int | None = None, source_length: int | None = None, source_content_md5: bytes | bytearray | None = None, **kwargs) -> Dict[str, Any]

Parámetros

block_id: str

Requerido

Valor de cadena que identifica el bloque. La cadena debe tener un tamaño inferior o igual a 64 bytes. Para un blob determinado, el block_id debe tener el mismo tamaño para cada bloque.

source_url: str

Requerido

La dirección URL.

source_offset: int

Requerido

Inicio del intervalo de bytes que se va a usar para el bloque . Debe establecerse si se proporciona la longitud del origen.

source_length: int

Requerido

Tamaño del bloque en bytes.

source_content_md5: bytearray

Requerido

Especifique el md5 calculado para el intervalo de bytes que se deben leer del origen de copia.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Un ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedades de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

source_authorization: str

Autentíquese como entidad de servicio mediante un secreto de cliente para acceder a un blob de origen. Asegúrese de que "portador" es el prefijo de la cadena source_authorization.

Devoluciones

Dict de la propiedad Blob.

Tipo de valor devuelto

dict[str, Any]

Copia un blob de la dirección URL especificada.

Esta operación devuelve un diccionario que contiene copy_status y copy_id, que se puede usar para comprobar el estado de o anular la operación de copia. copy_status será "correcto" si la copia se completó de forma sincrónica o "pendiente" si la copia se ha iniciado de forma asincrónica. Para las copias asincrónicas, el estado se puede comprobar sondeando el get_blob_properties método y comprobando el estado de la copia. Establezca requires_sync en True para forzar que la copia sea sincrónica. Blob service copia blobs en función de la mejor opción.

El blob de origen de una operación de copia puede ser un blob en bloques, un blob en anexos o un blob en páginas. Si el blob de destino ya existe, debe ser del mismo tipo que el blob de origen. Si existe un blob de destino, se sobrescribirá. El blob de destino no puede modificarse mientras haya una operación de copia en curso.

Al copiar desde un blob en páginas, Blob service crea un blob en páginas de destino de la longitud del blob de origen, que inicialmente contiene todos los ceros. A continuación, los intervalos de páginas de origen se enumeran, y se copian los intervalos no vacíos.

Para un blob en bloques o un blob en anexos, Blob service crea un blob confirmado de longitud cero antes de volver de esta operación. Al copiar desde un blob en bloques, se copian todos los bloques confirmados y sus identificadores de bloque. Los bloques no confirmados no se copian. Al final de la operación de copia, el blob de destino tendrá el mismo número de bloques confirmados que el origen.

Al copiar desde un blob en anexos, se copian todos los bloques confirmados. Al final de la operación de copia, el blob de destino tendrá el mismo número de bloques confirmados que el origen.

start_copy_from_url(source_url: str, metadata: Dict[str, str] | None = None, incremental_copy: bool = False, **kwargs: Any) -> Dict[str, str | datetime]

Parámetros

source_url: str

Requerido

Dirección URL de hasta 2 KB de longitud que especifica un archivo o un blob. El valor debe estar codificado para URL tal y como aparecería en un URI de solicitud. Si el origen está en otra cuenta, el origen debe ser público o debe autenticarse a través de una firma de acceso compartido. Si el origen es público, no se requiere autenticación. Ejemplos: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

metadata: dict(str, str)

Requerido

Pares nombre-valor asociados al blob como metadatos. Si no se especifica ningún par nombre-valor, la operación copiará los metadatos del blob o archivo de origen en el blob de destino. Si se especifican uno o varios pares nombre-valor, el blob de destino se crea con los metadatos especificados y los metadatos no se copian del blob o archivo de origen.

incremental_copy: bool

Requerido

Copia la instantánea del blob en páginas de origen en un blob en páginas de destino. La instantánea se copia de forma que solo se transfieren los cambios diferenciales entre la instantánea copiada anteriormente al destino. Las instantáneas copiadas son copias completas de la instantánea original y se pueden leer o copiar de la forma habitual. El valor predeterminado es False.

tags: dict(str, str) o Literal["COPY"]

Pares nombre-valor asociados al blob como etiqueta. Las etiquetas distinguen mayúsculas de minúsculas. El conjunto de etiquetas puede contener como máximo 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres y los valores de etiqueta deben tener entre 0 y 256 caracteres. Los caracteres de clave y valor válidos incluyen: minúsculas y mayúsculas, dígitos (0-9), espacio (), más ( >><<+), menos (-), punto (.), solidus (/), dos puntos (:), iguales (=), subrayado (_).

En su lugar, se puede pasar el literal "COPY" (con distinción entre mayúsculas y minúsculas) para copiar etiquetas del blob de origen. Esta opción solo está disponible cuando incremental_copy=False y requires_sync=True.

Novedades de la versión 12.4.0.

immutability_policy: ImmutabilityPolicy

Especifica la directiva de inmutabilidad de un blob, una instantánea de blob o una versión de blob.

Novedad de la versión 12.10.0: se introdujo en la versión de API "2020-10-02".

legal_hold: bool

Se especifica si se debe establecer una suspensión legal en el blob.

Novedad de la versión 12.10.0: se introdujo en la versión de API "2020-10-02".

source_if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado condicional para copiar el blob solo si el blob de origen se ha modificado desde la fecha u hora especificadas.

source_if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado condicional para copiar el blob solo si el blob de origen no se ha modificado desde la fecha u hora especificadas.

source_etag: str

Valor ETag de origen o carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

source_match_condition: MatchConditions

Condición de coincidencia de origen que se va a usar en el etag.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado condicional para copiar el blob solo si el blob de destino se ha modificado desde la fecha u hora especificadas. Si el blob de destino no se ha modificado, el servicio Blob devuelve el código de estado 412 (Error de condición previa).

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado condicional para copiar el blob solo si el blob de destino no se ha modificado desde la fecha u hora especificadas. Si el blob de destino se ha modificado, el servicio Blob devuelve el código de estado 412 (Error de condición previa).

etag: str

Valor ETag de destino o carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia de destino que se va a usar en el etag.

destination_lease: BlobLeaseClient o str

El identificador de concesión especificado para este encabezado debe coincidir con el identificador de concesión del blob de destino. Si la solicitud no incluye el identificador de concesión o este no es válido, la operación produce un error con el código de estado 412 (Error de condición previa).

source_lease: BlobLeaseClient o str

Especifique esto para realizar la operación Copiar blob solo si el identificador de concesión especificado coincide con el identificador de concesión activo del blob de origen.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

premium_page_blob_tier: PremiumPageBlobTier

Valor de nivel de blob en páginas en el que se va a establecer el blob. El nivel se correlaciona con el tamaño del blob y el número de IOPS permitidas. Esto solo se aplica a blobs en páginas en cuentas de Premium Storage.

standard_blob_tier: StandardBlobTier

Valor de nivel de blob estándar en el que se va a establecer el blob. Para esta versión de la biblioteca, esto solo se aplica a blobs en bloques en cuentas de almacenamiento estándar.

rehydrate_priority: RehydratePriority

Indica la prioridad con la que rehidratar un blob archivado.

seal_destination_blob: bool

Sellar el blob en anexos de destino. Esta operación solo es para el blob en anexos.

Novedades de la versión 12.4.0.

requires_sync: bool

Exige que el servicio no devuelva una respuesta hasta que se complete la copia.

source_authorization: str

Autentíquese como entidad de servicio mediante un secreto de cliente para acceder a un blob de origen. Asegúrese de que "portador" es el prefijo de la cadena source_authorization. Esta opción solo está disponible cuando incremental_copy se establece en False y requires_sync se establece en True.

Novedades de la versión 12.9.0.

encryption_scope: str

Un ámbito de cifrado predefinido que se usa para cifrar los datos en el blob copiado de sincronización. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedades de la versión 12.10.0.

Devoluciones

Diccionario de propiedades de copia (etag, last_modified, copy_id, copy_status).

Tipo de valor devuelto

dict[str, Union[str, datetime]]

Restaura blobs o instantáneas eliminados temporalmente.

La operación solo se realizará correctamente si se usa dentro del número de días especificado establecido en la directiva de retención de eliminación.

Si el control de versiones de blobs está habilitado, el blob base no se puede restaurar mediante este método. En su lugar, use start_copy_from_url con la dirección URL de la versión del blob que desea promover a la versión actual.

undelete_blob(**kwargs: Any) -> None

Parámetros

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Tipo de valor devuelto

None

Crea un nuevo blob a partir de un origen de datos con fragmentación automática.

upload_blob(data: bytes | str | Iterable | IO, blob_type: str | BlobType = BlobType.BLOCKBLOB, length: int | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, Any]

Parámetros

data

Requerido

Datos del blob que se van a cargar.

blob_type: BlobType

Requerido

Tipo de blob. Puede ser BlockBlob, PageBlob o AppendBlob. El valor predeterminado es BlockBlob.

length: int

Requerido

Número de bytes que se van a leer de la secuencia. Esto es opcional, pero debe proporcionarse para obtener un rendimiento óptimo.

metadata: dict(str, str)

Requerido

Pares nombre-valor asociados al blob como metadatos.

tags: dict(str, str)

Pares nombre-valor asociados al blob como etiqueta. Las etiquetas distinguen mayúsculas de minúsculas. El conjunto de etiquetas puede contener como máximo 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres y los valores de etiqueta deben tener entre 0 y 256 caracteres. Entre los caracteres de clave y valor válidos se incluyen: letras minúsculas y mayúsculas, dígitos (0-9), espacio (), más ( >><<+), menos (-), punto (.), solidus (/), dos puntos (:), iguales (=), subrayado (_)

Novedad de la versión 12.4.0.

overwrite: bool

Si el blob que se va a cargar debe sobrescribir los datos actuales. Si es True, upload_blob sobrescribirá los datos existentes. Si se establece en False, se producirá un error en la operación con ResourceExistsError. La excepción a lo anterior es con los tipos de blobs append: si se establece en False y los datos ya existen, no se generará un error y los datos se anexarán al blob existente. Si se establece overwrite=True, se eliminará el blob en anexos existente y se creará uno nuevo. El valor predeterminado es False.

content_settings: ContentSettings

Objeto ContentSettings usado para establecer propiedades de blob. Se usa para establecer el tipo de contenido, la codificación, el idioma, la disposición, md5 y el control de caché.

validate_content: bool

Si es true, calcula un hash MD5 para cada fragmento del blob. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si se usa http en lugar de https, como https (el valor predeterminado), ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el blob. Tenga en cuenta también que si está habilitado, el algoritmo de carga eficaz para memoria no se usará porque calcular el hash MD5 requiere almacenar en búfer bloques completos y, al hacerlo, se anula el propósito del algoritmo eficiente en memoria.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. Si se especifica, upload_blob solo se realiza correctamente si la concesión del blob está activa y coincide con este identificador. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en la etiqueta electrónica.

if_tags_match_condition: str

Especifique una cláusula SQL where en las etiquetas de blob para operar solo en el blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedad de la versión 12.4.0.

premium_page_blob_tier: PremiumPageBlobTier

Valor de nivel de blob en páginas en el que se va a establecer el blob. El nivel se correlaciona con el tamaño del blob y el número de IOPS permitidas. Esto solo se aplica a los blobs en páginas en cuentas de Premium Storage.

standard_blob_tier: StandardBlobTier

Valor de nivel de blob estándar en el que se va a establecer el blob. Para esta versión de la biblioteca, esto solo se aplica a blobs en bloques en cuentas de almacenamiento estándar.

immutability_policy: ImmutabilityPolicy

Especifica la directiva de inmutabilidad de un blob, una instantánea de blob o una versión de blob. Actualmente, este parámetro de upload_blob() API es solo para BlockBlob.

Novedad de la versión 12.10.0: Se introdujo en la versión de API "2020-10-02".

legal_hold: bool

Se especifica si se debe establecer una suspensión legal en el blob. Actualmente, este parámetro de upload_blob() API es solo para BlockBlob.

Novedad de la versión 12.10.0: Se introdujo en la versión de API "2020-10-02".

maxsize_condition: int

Encabezado condicional opcional. Longitud máxima en bytes permitida para el blob en anexos. Si la operación Append Block haría que el blob supere ese límite o si el tamaño del blob ya es mayor que el valor especificado en este encabezado, la solicitud producirá un error MaxBlobSizeConditionNotMet (código de estado HTTP 412 - Error de condición previa).

max_concurrency: int

Número máximo de conexiones paralelas que se usarán cuando el tamaño del blob supere los 64 MB.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedad de la versión 12.2.0.

encoding: str

El valor predeterminado es UTF-8.

progress_hook: Callable[[int, Optional[int]], None]

Devolución de llamada para realizar un seguimiento del progreso de una carga de larga duración. La firma es function(current: int, total: Optional[int]), donde current es el número de bytes transferidos hasta ahora, y total es el tamaño del blob o None si se desconoce el tamaño.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí. Este método puede realizar varias llamadas al servicio y el tiempo de espera se aplicará a cada llamada individualmente.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación)

Tipo de valor devuelto

dict[str, Any]

Crea un nuevo blob en bloques donde se lee el contenido del blob desde una dirección URL determinada. El contenido de un blob existente se sobrescribe con el nuevo blob.

upload_blob_from_url(source_url: str, **kwargs: Any) -> Dict[str, Any]

Parámetros

source_url: str

Requerido

Dirección URL de hasta 2 KB de longitud que especifica un archivo o un blob. El valor debe estar codificado para URL tal y como aparecería en un URI de solicitud. Si el origen está en otra cuenta, el origen debe ser público o debe autenticarse a través de una firma de acceso compartido. Si el origen es público, no se requiere autenticación. Ejemplos: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

overwrite: bool

Si el blob que se va a cargar debe sobrescribir los datos actuales. Si es True, upload_blob sobrescribirá los datos existentes. Si se establece en False, se producirá un error en la operación con ResourceExistsError.

include_source_blob_properties: bool

Indica si se deben copiar las propiedades del blob de origen. El valor predeterminado es True.

tags: dict(str, str)

Pares nombre-valor asociados al blob como etiqueta. Las etiquetas distinguen mayúsculas de minúsculas. El conjunto de etiquetas puede contener como máximo 10 etiquetas. Las claves de etiqueta deben tener entre 1 y 128 caracteres y los valores de etiqueta deben tener entre 0 y 256 caracteres. Los caracteres válidos de clave y valor de etiqueta incluyen: letras minúsculas y mayúsculas, dígitos (0-9), espacio (), más ( >><<+), menos (-), punto (.), solidus (/), dos puntos (:), iguales (=), subrayado (_)

source_content_md5: bytearray

Especifique el md5 que se usa para comprobar la integridad de los bytes de origen.

source_if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si el recurso de origen se ha modificado desde la hora especificada.

source_if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si el recurso de origen no se ha modificado desde la fecha y hora especificadas.

source_etag: str

Valor ETag de origen o carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

source_match_condition: MatchConditions

Condición de coincidencia de origen que se va a usar en el etag.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag de destino o carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia de destino que se va a usar en el etag.

destination_lease: BlobLeaseClient o str

El identificador de concesión especificado para este encabezado debe coincidir con el identificador de concesión del blob de destino. Si la solicitud no incluye el identificador de concesión o este no es válido, la operación produce un error con el código de estado 412 (Error de condición previa).

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

content_settings: ContentSettings

Objeto ContentSettings usado para establecer propiedades de blob. Se usa para establecer el tipo de contenido, la codificación, el idioma, la disposición, md5 y el control de caché.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Un ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

standard_blob_tier: StandardBlobTier

Valor de nivel de blob estándar en el que se va a establecer el blob. Para esta versión de la biblioteca, esto solo se aplica a blobs en bloques en cuentas de almacenamiento estándar.

source_authorization: str

Autentíquese como entidad de servicio mediante un secreto de cliente para acceder a un blob de origen. Asegúrese de que "portador" es el prefijo de la cadena source_authorization.

La operación Cargar páginas escribe un intervalo de páginas en un blob en páginas.

upload_page(page: bytes, offset: int, length: int, **kwargs) -> Dict[str, str | datetime]

Parámetros

page: bytes

Requerido

Contenido de la página.

offset: int

Requerido

Inicio del intervalo de bytes que se va a usar para escribir en una sección del blob. Las páginas deben estar alineadas con los límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

length: int

Requerido

Número de bytes que se usarán para escribir en una sección del blob. Las páginas deben estar alineadas con los límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

validate_content: bool

Si es true, calcula un hash MD5 del contenido de la página. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si usa http en lugar de https, como https (valor predeterminado), ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el blob.

if_sequence_number_lte: int

Si el número de secuencia del blob es menor o igual que el valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_sequence_number_lt: int

Si el número de secuencia del blob es menor que el valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_sequence_number_eq: int

Si el número de secuencia del blob es igual al valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Un ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedades de la versión 12.2.0.

encoding: str

El valor predeterminado es UTF-8.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por blobs (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

La operación Cargar páginas escribe un intervalo de páginas en un blob de páginas donde el contenido se lee desde una dirección URL.

upload_pages_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs) -> Dict[str, Any]

Parámetros

source_url: str

Requerido

Dirección URL de los datos de origen. Puede apuntar a cualquier blob o archivo de Azure, que sea público o tenga asociada una firma de acceso compartido.

offset: int

Requerido

Inicio del intervalo de bytes que se va a usar para escribir en una sección del blob. Las páginas deben estar alineadas con los límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

length: int

Requerido

Número de bytes que se usarán para escribir en una sección del blob. Las páginas deben estar alineadas con los límites de 512 bytes, el desplazamiento inicial debe ser un módulo de 512 y la longitud debe ser un módulo de 512.

source_offset: int

Requerido

Esto indica el inicio del intervalo de bytes (inclusive) que se debe tomar del origen de copia. El servicio leerá el mismo número de bytes que el intervalo de destino (desplazamiento de longitud).

source_content_md5: bytes

Si se da, el servicio calculará el hash MD5 del contenido del bloque y comparará con este valor.

source_if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si el recurso de origen se ha modificado desde la hora especificada.

source_if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si el recurso de origen no se ha modificado desde la fecha y hora especificadas.

source_etag: str

Valor ETag de origen o carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

source_match_condition: MatchConditions

Condición de coincidencia de origen que se va a usar en el etag.

lease: BlobLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto BlobLeaseClient o el identificador de concesión como una cadena.

if_sequence_number_lte: int

Si el número de secuencia del blob es menor o igual que el valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_sequence_number_lt: int

Si el número de secuencia del blob es menor que el valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_sequence_number_eq: int

Si el número de secuencia del blob es igual al valor especificado, la solicitud continúa; de lo contrario, se produce un error.

if_modified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.

if_unmodified_since: datetime

Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

etag: str

Valor ETag de destino o carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .

match_condition: MatchConditions

Condición de coincidencia de destino que se va a usar en el etag.

if_tags_match_condition: str

Especifique una cláusula SQL where en etiquetas de blob para que funcione solo en blob con un valor coincidente. P. ej. "\"tagname\"='my tag'"

Novedades de la versión 12.4.0.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Como la propia clave de cifrado se proporciona en la solicitud, se debe establecer una conexión segura para transferir la clave.

encryption_scope: str

Un ámbito de cifrado predefinido que se usa para cifrar los datos en el servicio. Se puede crear un ámbito de cifrado mediante la API de administración y hacer referencia aquí por su nombre. Si se ha definido un ámbito de cifrado predeterminado en el contenedor, este valor lo invalidará si el ámbito de nivel de contenedor está configurado para permitir invalidaciones. De lo contrario, se generará un error.

Novedades de la versión 12.2.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

source_authorization: str

Autentíquese como entidad de servicio mediante un secreto de cliente para acceder a un blob de origen. Asegúrese de que "portador" es el prefijo de la cadena source_authorization.

La versión de la API de storage que se usa para las solicitudes.

Modo de ubicación que el cliente está usando actualmente.

De forma predeterminada, será "principal". Las opciones incluyen "primary" y "secondary".

Dirección URL completa del punto de conexión principal.

Nombre de host del punto de conexión principal.

Dirección URL completa del punto de conexión secundario si está configurada.

Si no está disponible, se generará un valor ValueError. Para especificar explícitamente un nombre de host secundario, use el argumento opcional secondary_hostname palabra clave en la creación de instancias.

Excepciones

ValueError

Nombre de host del punto de conexión secundario.

Si no está disponible, será Ninguno. Para especificar explícitamente un nombre de host secundario, use el argumento opcional secondary_hostname palabra clave en la creación de instancias.

Dirección URL completa del punto de conexión a esta entidad, incluido el token de SAS si se usa.

Puede ser el punto de conexión principal o el punto de conexión secundario según el actual location_mode. :returns: la dirección URL completa del punto de conexión a esta entidad, incluido el token de SAS si se usa. :rtype: str

abort_copy	Anule una operación de copia en curso. Esto dejará un blob de destino con longitud cero y metadatos completos. Esto generará un error si la operación de copia ya ha finalizado.
acquire_lease	Solicita una nueva concesión. Si el blob no tiene una concesión activa, Blob Service crea una concesión en el blob y devuelve una nueva concesión.
append_block	Confirma un nuevo bloque de datos al final del blob en anexos existente.
append_block_from_url	Crea un nuevo bloque que se va a confirmar como parte de un blob, donde el contenido se lee desde una dirección URL de origen.
clear_page	Borra un intervalo de páginas.
close	Este método consiste en cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contextos.
commit_block_list	La operación Commit Block List escribe un blob especificando la lista de identificadores de bloque que componen el blob.
create_append_blob	Crea un nuevo blob en anexos. Esta operación crea un nuevo blob en anexos de 0 longitud. El contenido de cualquier blob existente se sobrescribe con el blob en anexos recién inicializado. Para agregar contenido al blob en anexos, llame al append_block método o append_block_from_url .
create_page_blob	Crea un nuevo blob en páginas del tamaño especificado.
create_snapshot	Crea una instantánea del blob. Una instantánea es una versión de solo lectura de un blob que se ha realizado en un momento dado. Se puede leer, copiar o eliminar, pero no modificar. Las instantáneas le ofrecen una oportunidad de realizar una copia de seguridad de un blob en el momento en que éste aparezca. Una instantánea de un blob tiene el mismo nombre que el blob base desde el que se toma la instantánea, con un valor DateTime anexado para indicar la hora en la que se tomó la instantánea.
delete_blob	Marca el blob especificado para su eliminación. El blob se elimina posteriormente durante la recolección de elementos no utilizados. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo con la operación delete_blob(). Si se habilita una directiva de retención de eliminación para el servicio, esta operación elimina temporalmente el blob y conserva el blob durante un número especificado de días. Después del número de días especificado, los datos del blob se quitan del servicio durante la recolección de elementos no utilizados. Se puede acceder al blob eliminado temporalmente mediante list_blobs la especificación de la opción include=['deleted']. El blob eliminado temporalmente se puede restaurar mediante <xref:azure.storage.blob.undelete> la operación .
delete_immutability_policy	La operación Eliminar directiva de inmutabilidad elimina la directiva de inmutabilidad en el blob. Novedad de la versión 12.10.0: esta operación se introdujo en la versión de API "2020-10-02".
download_blob	Descarga un blob en StorageStreamDownloader. El método readall() debe usarse para leer todo el contenido o readinto() para descargar el blob en una secuencia. El uso de chunks() devuelve un iterador que permite al usuario iterar el contenido en fragmentos.
exists	Devuelve True si existe un blob con los parámetros definidos y devuelve False de lo contrario.
from_blob_url	Cree BlobClient a partir de una dirección URL de blob. Esto no admite la dirección URL de blob personalizada con "/" en el nombre del blob.
from_connection_string	Cree BlobClient a partir de una cadena de conexión.
get_account_information	Obtiene información relacionada con la cuenta de almacenamiento en la que reside el blob. La información también se puede recuperar si el usuario tiene una SAS en un contenedor o blob. Las claves del diccionario devuelto incluyen "sku_name" y "account_kind".
get_blob_properties	Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el blob. No devuelve el contenido de los blobs.
get_blob_tags	La operación Obtener etiquetas permite a los usuarios obtener etiquetas en una versión de blob o blob específica, o instantánea. Novedad de la versión 12.4.0: Esta operación se introdujo en la versión de API "2019-12-12".
get_block_list	La operación Obtener lista de bloques recupera la lista de bloques que se han cargado como parte de un blob en bloques.
get_page_range_diff_for_managed_disk	Devuelve la lista de intervalos de páginas válidos para un disco administrado o una instantánea. Nota Esta operación solo está disponible para las cuentas de disco administrado. Novedad de la versión 12.2.0: esta operación se introdujo en la versión de API "2019-07-07".
get_page_ranges	EN DESUSO: devuelve la lista de intervalos de páginas válidos para un blob en páginas o una instantánea de un blob en páginas.
list_page_ranges	Devuelve la lista de intervalos de páginas válidos para un blob en páginas o una instantánea de un blob en páginas. Si se especifica previous_snapshot , el resultado será una diferencia de los cambios entre el blob de destino y la instantánea anterior.
query_blob	Permite a los usuarios seleccionar o proyectar en los datos de instantáneas de blobs o blobs proporcionando expresiones de consulta simples. Estas operaciones devuelven un BlobQueryReader, los usuarios deben usar readall() o readinto() para obtener datos de consulta.
resize_blob	Cambia el tamaño de un blob en páginas por el tamaño especificado. Si el valor especificado es menor que el tamaño actual del blob, se borran todas las páginas cuyo valor sea mayor que el especificado.
seal_append_blob	La operación Seal sella el blob en anexos para que sea de solo lectura. Novedades de la versión 12.4.0.
set_blob_metadata	Establece los metadatos definidos por el usuario para el blob como uno o varios pares nombre-valor.
set_blob_tags	La operación Establecer etiquetas permite a los usuarios establecer etiquetas en una versión de blob o de blob específica, pero no instantáneas. Cada llamada a esta operación reemplaza todas las etiquetas existentes asociadas al blob. Para quitar todas las etiquetas del blob, llame a esta operación sin establecer etiquetas. Novedad de la versión 12.4.0: Esta operación se introdujo en la versión de API "2019-12-12".
set_http_headers	Establece las propiedades del sistema en el blob. Si se establece una propiedad para el content_settings, todas las propiedades se invalidarán.
set_immutability_policy	La operación Establecer directiva de inmutabilidad establece la directiva de inmutabilidad en el blob. Novedad de la versión 12.10.0: esta operación se introdujo en la versión de API "2020-10-02".
set_legal_hold	La operación Establecer suspensión legal establece una suspensión legal en el blob. Novedad de la versión 12.10.0: esta operación se introdujo en la versión de API "2020-10-02".
set_premium_page_blob_tier	Establece los niveles de blob en páginas del blob. Esta API solo se admite para blobs en páginas en cuentas Premium.
set_sequence_number	Establece el número de secuencia del blob.
set_standard_blob_tier	Esta operación establece el nivel en un blob en bloques. El nivel de un blob en bloques determina el tipo de almacenamiento de acceso frecuente, esporádico o de archivo. Esta operación no actualiza la etiqueta ETag del blob.
stage_block	Crea un nuevo bloque que se confirmará como parte de un blob.
stage_block_from_url	Crea un nuevo bloque que se confirmará como parte de un blob donde el contenido se lee desde una dirección URL.
start_copy_from_url	Copia un blob de la dirección URL especificada. Esta operación devuelve un diccionario que contiene copy_status y copy_id, que se puede usar para comprobar el estado de o anular la operación de copia. copy_status será "correcto" si la copia se completó de forma sincrónica o "pendiente" si la copia se ha iniciado de forma asincrónica. Para las copias asincrónicas, el estado se puede comprobar sondeando el get_blob_properties método y comprobando el estado de la copia. Establezca requires_sync en True para forzar que la copia sea sincrónica. Blob service copia blobs en función de la mejor opción. El blob de origen de una operación de copia puede ser un blob en bloques, un blob en anexos o un blob en páginas. Si el blob de destino ya existe, debe ser del mismo tipo que el blob de origen. Si existe un blob de destino, se sobrescribirá. El blob de destino no puede modificarse mientras haya una operación de copia en curso. Al copiar desde un blob en páginas, Blob service crea un blob en páginas de destino de la longitud del blob de origen, que inicialmente contiene todos los ceros. A continuación, los intervalos de páginas de origen se enumeran, y se copian los intervalos no vacíos. Para un blob en bloques o un blob en anexos, Blob service crea un blob confirmado de longitud cero antes de volver de esta operación. Al copiar desde un blob en bloques, se copian todos los bloques confirmados y sus identificadores de bloque. Los bloques no confirmados no se copian. Al final de la operación de copia, el blob de destino tendrá el mismo número de bloques confirmados que el origen. Al copiar desde un blob en anexos, se copian todos los bloques confirmados. Al final de la operación de copia, el blob de destino tendrá el mismo número de bloques confirmados que el origen.
undelete_blob	Restaura blobs o instantáneas eliminados temporalmente. La operación solo se realizará correctamente si se usa dentro del número de días especificado establecido en la directiva de retención de eliminación. Si el control de versiones de blobs está habilitado, el blob base no se puede restaurar mediante este método. En su lugar, use start_copy_from_url con la dirección URL de la versión del blob que desea promover a la versión actual.
upload_blob	Crea un nuevo blob a partir de un origen de datos con fragmentación automática.
upload_blob_from_url	Crea un nuevo blob en bloques donde se lee el contenido del blob desde una dirección URL determinada. El contenido de un blob existente se sobrescribe con el nuevo blob.
upload_page	La operación Cargar páginas escribe un intervalo de páginas en un blob en páginas.
upload_pages_from_url	La operación Cargar páginas escribe un intervalo de páginas en un blob de páginas donde el contenido se lee desde una dirección URL.

BlobClient Clase

Constructor

Parámetros

Métodos

abort_copy

Parámetros

Tipo de valor devuelto

acquire_lease

Parámetros

Devoluciones

Tipo de valor devuelto

append_block

Parámetros

Devoluciones

Tipo de valor devuelto

append_block_from_url

Parámetros

clear_page

Parámetros

Devoluciones

Tipo de valor devuelto

close

commit_block_list

Parámetros

Devoluciones

Tipo de valor devuelto

create_append_blob

Parámetros

Devoluciones

Tipo de valor devuelto

create_page_blob

Parámetros

Devoluciones

Tipo de valor devuelto

create_snapshot

Parámetros

Devoluciones

Tipo de valor devuelto

delete_blob

Parámetros

Tipo de valor devuelto

delete_immutability_policy

Parámetros

Devoluciones

Tipo de valor devuelto

download_blob

Parámetros

Devoluciones

Tipo de valor devuelto

exists

Parámetros

Devoluciones

Tipo de valor devuelto

from_blob_url

Parámetros

Devoluciones

Tipo de valor devuelto

from_connection_string

Parámetros

Devoluciones

Tipo de valor devuelto

get_account_information

Devoluciones

Tipo de valor devuelto

get_blob_properties

Parámetros

Devoluciones

Tipo de valor devuelto

get_blob_tags

Parámetros

Devoluciones

Tipo de valor devuelto

get_block_list

Parámetros

Devoluciones

Tipo de valor devuelto

get_page_range_diff_for_managed_disk

Parámetros

Devoluciones

Tipo de valor devuelto