Compartir a través de


BaseBlobService Clase

Esta es la clase principal que administra los recursos de Blob.

Blob service almacena datos binarios y texto como blobs en la nube. El servicio Blob proporciona los tres recursos siguientes: la cuenta de almacenamiento, los contenedores y los blobs. En la cuenta de almacenamiento, los contenedores proporcionan una manera de organizar conjuntos de blobs. Para obtener más información, consulte: https://msdn.microsoft.com/en-us/library/azure/ee691964.aspx

:type ~azure.storage.common.TokenCredential

Herencia
BaseBlobService

Constructor

BaseBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, connection_string=None, socket_timeout=None, token_credential=None)

Parámetros

account_name
str
valor predeterminado: None

El nombre de la cuenta de almacenamiento. Se usa para autenticar las solicitudes firmadas con una clave de cuenta y para construir el punto de conexión de almacenamiento. Se requiere a menos que se especifique un cadena de conexión o si se usa un dominio personalizado con autenticación anónima.

account_key
str
valor predeterminado: None

La clave de la cuenta de almacenamiento. Se usa para la autenticación de clave compartida. Si no se especifica ninguna clave de cuenta o token sas, se usará el acceso anónimo.

sas_token
str
valor predeterminado: None

Un token de firma de acceso compartido que se va a usar para autenticar solicitudes en lugar de la clave de cuenta. Si se especifican la clave de cuenta y el token sas, se usará la clave de cuenta para firmar. Si no se especifica ninguno, se usará el acceso anónimo.

is_emulated
bool
valor predeterminado: False

Si se va a usar el emulador. El valor predeterminado es False. Si se especifica, invalidará todos los demás parámetros además de cadena de conexión y la sesión de solicitud.

protocol
str
valor predeterminado: https

Protocolo que se va a usar para las solicitudes. El valor predeterminado es https.

endpoint_suffix
str
valor predeterminado: core.windows.net

Componente base de host de la dirección URL, menos el nombre de la cuenta. El valor predeterminado es Azure (core.windows.net). Invalide esta opción para usar la nube de China (core.chinacloudapi.cn).

custom_domain
str
valor predeterminado: None

Dominio personalizado que se va a usar. Esto se puede establecer en Azure Portal. Por ejemplo, "www.mydomain.com".

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

Objeto de sesión que se usará para las solicitudes HTTP.

connection_string
str
valor predeterminado: None

Si se especifica, esto invalidará todos los demás parámetros además de la sesión de solicitud. Consulte http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ para obtener el formato de cadena de conexión

socket_timeout
int
valor predeterminado: None

Si se especifica, esto invalidará el tiempo de espera de socket predeterminado. El tiempo de espera especificado es en segundos. Consulte DEFAULT_SOCKET_TIMEOUT en _constants.py para obtener el valor predeterminado.

token_credential
valor predeterminado: None

Credencial de token usada para autenticar solicitudes HTTPS. El valor del token debe actualizarse antes de su expiración.

Variables

MAX_SINGLE_GET_SIZE
int

El tamaño del primer intervalo se realiza mediante métodos get_blob_to_* si max_connections es mayor que 1. Se devolverán menos datos si el blob es menor que este.

MAX_CHUNK_GET_SIZE
int

El tamaño del intervalo posterior se realiza mediante métodos get_blob_to_* si max_connections es mayor que 1 y el blob es mayor que MAX_SINGLE_GET_SIZE. Se devolverán menos datos si el resto del blob es menor que este. Si se establece en más de 4 MB, content_validation producirá un error si está habilitado. Sin embargo, si content_validation no se desea un tamaño superior a 4 MB puede ser óptimo. No se recomienda establecer esto por debajo de 4 MB.

key_encryption_key
object

Key-encryption-key opcionalmente proporcionado por el usuario. Si se proporciona, se usará para cifrar o descifrar en métodos admitidos. Para los métodos que requieren descifrado, se debe proporcionar el key_encryption_key O la resolución. Si se proporcionan ambos, el solucionador tendrá prioridad. Debe implementar los métodos siguientes para las API que requieren cifrado: wrap_key(clave)–encapsula la clave especificada (bytes) mediante un algoritmo de la elección del usuario. Devuelve la clave cifrada como bytes. get_key_wrap_algorithm(): devuelve el algoritmo utilizado para encapsular la clave simétrica especificada. get_kid() : devuelve un identificador de clave de cadena para esta clave-cifrado-clave. Debe implementar los métodos siguientes para las API que requieren descifrado: unwrap_key(clave, algoritmo) : devuelve la forma desencapsulada de la clave simétrica especificada mediante el algoritmo especificado por la cadena. get_kid() : devuelve un identificador de clave de cadena para esta clave-cifrado-clave.

key_resolver_function
kid) (<xref:function>

Función para resolver las claves proporcionadas opcionalmente por el usuario. Si se proporciona, se usará para descifrar en los métodos admitidos. Para los métodos que requieren descifrado, se debe proporcionar el key_encryption_key O la resolución. Si se proporcionan ambos, el solucionador tendrá prioridad. Usa la cadena kid para devolver una clave de cifrado de claves que implementa la interfaz definida anteriormente.

require_encryption
bool

Marca que se puede establecer para asegurarse de que todos los mensajes cargados correctamente en la cola y todos los descargados y leídos correctamente de la cola se cifraron o se cifraron en el servidor. Si se establece esta marca, se deben proporcionar todos los parámetros necesarios para el cifrado o descifrado. Consulte los comentarios anteriores sobre el key_encryption_key y la resolución.

Métodos

abort_copy_blob

Anula una operación de copy_blob pendiente y deja un blob de destino con una longitud cero y metadatos completos.

acquire_blob_lease

Solicita una nueva concesión. Si el blob no tiene una concesión activa, el servicio Blob crea una concesión sobre el blob y devuelve un nuevo identificador de concesión.

acquire_container_lease

Solicita una nueva concesión. Si el contenedor no tiene una concesión activa, Blob service crea una concesión sobre el contenedor y devuelve un nuevo identificador de concesión.

batch_delete_blobs

Envía un lote de varias solicitudes de eliminación de blobs.

El método de eliminación de blobs elimina el blob o la instantánea especificados. Tenga en cuenta que la eliminación de un blob también elimina todas sus instantáneas. Para obtener más información, vea https://docs.microsoft.com/rest/api/storageservices/delete-blob.

break_blob_lease

Interrumpe la concesión, si el blob tiene una concesión activa. Una vez que se interrumpe una concesión, no es posible renovarla. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Cuando se interrumpe una concesión, el período de interrupción de la concesión puede transcurrir, durante el cual no se puede realizar ninguna operación de concesión, excepto la interrupción y liberación en el blob. Cuando una concesión se interrumpe correctamente, la respuesta indica el intervalo en segundos que debe transcurrir hasta que se pueda obtener una nueva concesión.

Una concesión interrumpida también puede liberarse, en cuyo caso otro cliente puede adquirir inmediatamente la concesión sobre el blob.

break_container_lease

Interrumpa la concesión, si el contenedor tiene una concesión activa. Una vez que se interrumpe una concesión, no es posible renovarla. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Cuando se interrumpe una concesión, el período de interrupción de la concesión puede transcurrir, durante el cual no se puede realizar ninguna operación de concesión excepto la interrupción y liberación en el contenedor. Cuando una concesión se interrumpe correctamente, la respuesta indica el intervalo en segundos que debe transcurrir hasta que se pueda obtener una nueva concesión.

change_blob_lease

Cambia el identificador de concesión de una concesión activa. Un cambio debe incluir el identificador de concesión actual y un nuevo identificador de concesión.

change_container_lease

Cambie el identificador de concesión de una concesión activa. Un cambio debe incluir el identificador de concesión actual y un nuevo identificador de concesión.

copy_blob

Copia un blob de forma asincrónica. Esta operación devuelve un objeto de propiedades de operación de copia, incluido un identificador de copia que puede usar para comprobar o anular la operación de copia. 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.

Para todos los tipos de blobs, puede llamar a get_blob_properties en el blob de destino para comprobar el estado de la operación de copia. El blob final se confirmará cuando se complete la copia.

create_container

Crea un nuevo contenedor en la cuenta especificada. Si el contenedor con el mismo nombre ya existe, se produce un error en la operación si fail_on_exist es True.

delete_blob

Marca el blob o la instantánea especificados 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 Eliminar blob.

Si se habilita una directiva de retención de eliminación para el servicio, esta operación elimina temporalmente el blob o la instantánea y conserva el blob o la instantánea durante el número de días especificado. Después del número especificado de días, los datos del blob se quitan del servicio durante la recolección de elementos no utilizados. Se puede acceder a blobs o instantáneas eliminadas temporalmente a través de list Blobs API que especifica la opción include=Include.Deleted. El blob o la instantánea eliminados temporalmente se pueden restaurar mediante la API Undelete.

delete_container

Marca el contenedor especificado para su eliminación. El contenedor y los blobs incluidos en él se eliminan posteriormente durante la recolección de elementos no utilizados.

exists

Devuelve un valor booleano que indica si el contenedor existe (si blob_name es None) o un valor booleano que indica si el blob existe.

extract_date_and_request_id
generate_account_shared_access_signature

Genera una firma de acceso compartido para blob service. Use la firma devuelta con el parámetro sas_token de cualquier BlobService.

generate_blob_shared_access_signature

Genera una firma de acceso compartido para el blob o una de sus instantáneas. Use la firma devuelta con el parámetro sas_token de cualquier BlobService.

generate_container_shared_access_signature

Genera una firma de acceso compartido para el contenedor. Use la firma devuelta con el parámetro sas_token de cualquier BlobService.

get_blob_account_information

Obtiene información relacionada con la cuenta de almacenamiento. La información también se puede recuperar si el usuario tiene una SAS en un contenedor o blob.

get_blob_metadata

Devuelve todos los metadatos definidos por el usuario para el blob o la instantánea especificados.

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. Devuelve Blob con BlobProperties y un dict de metadatos.

get_blob_service_properties

Obtiene las propiedades de blob service de una cuenta de almacenamiento, incluido Azure Storage Analytics.

get_blob_service_stats

Recupera las estadísticas relacionadas con la replicación para el servicio Blob. Solo está disponible cuando la replicación con redundancia geográfica con acceso de lectura está habilitada para la cuenta de almacenamiento.

Con la replicación con redundancia geográfica, Azure Storage mantiene los datos duraderos en dos ubicaciones. En las dos ubicaciones, Azure Storage mantiene constantemente réplicas en estado correcto de los datos. La ubicación en la que lee, crea, actualiza o elimina los datos es la ubicación de la cuenta de almacenamiento principal. La ubicación principal existe en la región que elija en el momento de crear una cuenta a través del Portal de Azure clásico de Administración de Azure, por ejemplo, Centro-norte de EE. UU. La ubicación en la que se replican los datos es la ubicación secundaria. La ubicación secundaria se determina automáticamente según la ubicación de la principal; está en un segundo centro de datos que se encuentra en la misma región que la ubicación principal. El acceso de solo lectura está disponible en la ubicación secundaria, si la replicación con redundancia geográfica con acceso de lectura está habilitada para la cuenta de almacenamiento.

get_blob_to_bytes

Descarga un blob como una matriz de bytes, con notificaciones automáticas de fragmentación y progreso. Devuelve una instancia de Blob con propiedades, metadatos y contenido.

get_blob_to_path

Descarga un blob en una ruta de acceso de archivo, con notificaciones automáticas de fragmentación y progreso. Devuelve una instancia de Blob con propiedades y metadatos.

get_blob_to_stream

Descarga un blob en una secuencia, con notificaciones automáticas de fragmentación y progreso. Devuelve una instancia de Blob con propiedades y metadatos.

get_blob_to_text

Descarga un blob como texto Unicode, con notificaciones automáticas de fragmentación y progreso. Devuelve una instancia de Blob con propiedades, metadatos y contenido.

get_container_acl

Obtiene los permisos para el contenedor especificado. Los permisos indican si el acceso a los datos de un contenedor es público.

get_container_metadata

Devuelve todos los metadatos definidos por el usuario para el contenedor especificado.

get_container_properties

Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el contenedor especificado. Los datos devueltos no incluyen la lista de blobs del contenedor.

get_user_delegation_key

Obtenga una clave de delegación de usuarios con el fin de firmar tokens de SAS. Una credencial de token debe estar presente en el objeto de servicio para que esta solicitud se realice correctamente.

list_blob_names

Devuelve un generador para enumerar los nombres de blob en el contenedor especificado. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio y se detendrá cuando se hayan devuelto todos los blobs o se alcance num_results.

Si se especifica num_results y la cuenta tiene más de ese número de blobs, el generador tendrá un campo next_marker rellenado una vez que finalice. Este marcador se puede usar para crear un nuevo generador si se desean más resultados.

list_blobs

Devuelve un generador para enumerar los blobs en el contenedor especificado. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio y se detendrá cuando se hayan devuelto todos los blobs o se alcance num_results.

Si se especifica num_results y la cuenta tiene más de ese número de blobs, el generador tendrá un campo next_marker rellenado una vez que finalice. Este marcador se puede usar para crear un nuevo generador si se desean más resultados.

list_containers

Devuelve un generador para enumerar los contenedores de la cuenta especificada. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio y se detendrá cuando se hayan devuelto todos los contenedores o se alcance num_results.

Si se especifica num_results y la cuenta tiene más de ese número de contenedores, el generador tendrá un campo next_marker rellenado una vez que finalice. Este marcador se puede usar para crear un nuevo generador si se desean más resultados.

make_blob_url

Crea la dirección URL para acceder a un blob.

make_container_url

Crea la dirección URL para acceder a un contenedor.

release_blob_lease

Libera la concesión. La concesión se puede liberar si el identificador de concesión especificado en la solicitud coincide con el que está asociado al blob. Liberar la concesión permite a otro cliente adquirir inmediatamente la concesión sobre el blob en cuanto finaliza la operación de liberación.

release_container_lease

Liberar la concesión. La concesión se puede liberar si el lease_id especificado coincide con el asociado al contenedor. Liberar la concesión permite a otro cliente adquirir inmediatamente la concesión sobre el contenedor en cuanto finaliza la operación de liberación.

renew_blob_lease

Renueva la concesión. La concesión se puede renovar si el identificador de concesión especificado en la solicitud coincide con el que está asociado al blob. Tenga en cuenta que la concesión se puede renovar incluso si ha expirado, siempre que el blob no se haya modificado o concedido de nuevo desde la caducidad de la concesión. Cuando se renueva una concesión, el reloj que controla su duración se reinicia.

renew_container_lease

Renueva la concesión. La concesión se puede renovar si el identificador de concesión especificado coincide con el asociado al contenedor. Tenga en cuenta que la concesión se puede renovar incluso si ha expirado, siempre que el contenedor no se haya concedido de nuevo desde la caducidad de la concesión. Cuando se renueva una concesión, el reloj que controla su duración se reinicia.

set_blob_metadata

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

set_blob_properties

Establece las propiedades del sistema en el blob. Si se establece una propiedad para el content_settings, se invalidarán todas las propiedades.

set_blob_service_properties

Establece las propiedades de Blob service de una cuenta de almacenamiento, incluido Azure Storage Analytics. Si un elemento (por ejemplo, Registro) se deja como None, se conservan los valores existentes en el servicio para esa funcionalidad.

set_container_acl

Establece los permisos para el contenedor especificado o las directivas de acceso almacenadas que se pueden usar con firmas de acceso compartido. Los permisos indican si el acceso a los blobs de un contenedor es público.

set_container_metadata

Establece uno o varios pares nombre-valor definidos por el usuario para el contenedor especificado. Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntados al contenedor. Para quitar todos los metadatos del contenedor, llame a esta operación sin dict de metadatos.

set_proxy

Establece el host y el puerto del servidor proxy para la tunelización HTTP CONNECT.

snapshot_blob

Crea una instantánea de solo lectura de un blob.

undelete_blob

La operación undelete Blob restaura el contenido y los metadatos del blob o la instantánea eliminados temporalmente. Si se intenta recuperar un blob o una instantánea que no se elimina temporalmente, se realizará correctamente sin realizar ningún cambio.

abort_copy_blob

Anula una operación de copy_blob pendiente y deja un blob de destino con una longitud cero y metadatos completos.

abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor de destino.

blob_name
str
Requerido

Nombre del blob de destino.

copy_id
str
Requerido

Copie el identificador proporcionado en el copy.id de la operación de copy_blob original.

lease_id
str
valor predeterminado: None

Obligatorio si el blob de destino tiene una concesión infinita activa.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

acquire_blob_lease

Solicita una nueva concesión. Si el blob no tiene una concesión activa, el servicio Blob crea una concesión sobre el blob y devuelve un nuevo identificador de concesión.

acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

lease_duration
int
valor predeterminado: -1

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. No se puede cambiar una duración de concesión mediante renovación o cambio. El valor predeterminado es -1 (concesión infinita).

proposed_lease_id
str
valor predeterminado: None

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
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si la ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y producirá un error en la operación si existe.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

str

acquire_container_lease

Solicita una nueva concesión. Si el contenedor no tiene una concesión activa, Blob service crea una concesión sobre el contenedor y devuelve un nuevo identificador de concesión.

acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

lease_duration
int
valor predeterminado: -1

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. No se puede cambiar una duración de concesión mediante renovación o cambio. El valor predeterminado es -1 (concesión infinita).

proposed_lease_id
str
valor predeterminado: None

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
valor predeterminado: None

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
valor predeterminado: None

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.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

str

batch_delete_blobs

Envía un lote de varias solicitudes de eliminación de blobs.

El método de eliminación de blobs elimina el blob o la instantánea especificados. Tenga en cuenta que la eliminación de un blob también elimina todas sus instantáneas. Para obtener más información, vea https://docs.microsoft.com/rest/api/storageservices/delete-blob.

batch_delete_blobs(batch_delete_sub_requests, timeout=None)

Parámetros

batch_delete_sub_requests
list(BatchDeleteSubRequest)
Requerido

Las solicitudes de eliminación de blobs que se van a enviar como un lote.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Respuesta HTTP de eliminación por lotes analizada

Tipo de valor devuelto

break_blob_lease

Interrumpe la concesión, si el blob tiene una concesión activa. Una vez que se interrumpe una concesión, no es posible renovarla. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Cuando se interrumpe una concesión, el período de interrupción de la concesión puede transcurrir, durante el cual no se puede realizar ninguna operación de concesión, excepto la interrupción y liberación en el blob. Cuando una concesión se interrumpe correctamente, la respuesta indica el intervalo en segundos que debe transcurrir hasta que se pueda obtener una nueva concesión.

Una concesión interrumpida también puede liberarse, en cuyo caso otro cliente puede adquirir inmediatamente la concesión sobre el blob.

break_blob_lease(container_name, blob_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

lease_break_period
int
valor predeterminado: None

Para una operación de interrupción, se trata de la duración propuesta de segundos que la concesión debe continuar antes de que se interrumpa, entre 0 y 60 segundos. Este período de interrupción solo se utiliza si es menor que el tiempo restante de la concesión. Si es más largo, se utiliza el tiempo restante de la concesión. Hasta que no haya expirado el período de interrupción no habrá disponible una nueva concesión, pero la concesión se puede mantener durante un tiempo más largo que el período de interrupción. Si este encabezado no aparece con una operación de interrupción, se interrumpe una concesión de duración fija después de que transcurre el período de concesión restante y se interrumpe inmediatamente una concesión infinita.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si la ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y producirá un error en la operación si existe.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

int

break_container_lease

Interrumpa la concesión, si el contenedor tiene una concesión activa. Una vez que se interrumpe una concesión, no es posible renovarla. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Cuando se interrumpe una concesión, el período de interrupción de la concesión puede transcurrir, durante el cual no se puede realizar ninguna operación de concesión excepto la interrupción y liberación en el contenedor. Cuando una concesión se interrumpe correctamente, la respuesta indica el intervalo en segundos que debe transcurrir hasta que se pueda obtener una nueva concesión.

break_container_lease(container_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

lease_break_period
int
valor predeterminado: None

Esta es la duración propuesta de segundos que la concesión debe continuar antes de que se rompa, entre 0 y 60 segundos. Este período de interrupción solo se utiliza si es menor que el tiempo restante de la concesión. Si es más largo, se utiliza el tiempo restante de la concesión. Hasta que no haya expirado el período de interrupción no habrá disponible una nueva concesión, pero la concesión se puede mantener durante un tiempo más largo que el período de interrupción. Si este encabezado no aparece con una operación de interrupción, se interrumpe una concesión de duración fija después de que transcurre el período de concesión restante y se interrumpe inmediatamente una concesión infinita.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

int

change_blob_lease

Cambia el identificador de concesión de una concesión activa. Un cambio debe incluir el identificador de concesión actual y un nuevo identificador de concesión.

change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

lease_id
str
Requerido

Obligatorio si el blob tiene una concesión activa.

proposed_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
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si la ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y producirá un error en la operación si existe.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

change_container_lease

Cambie el identificador de concesión de una concesión activa. Un cambio debe incluir el identificador de concesión actual y un nuevo identificador de concesión.

change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

lease_id
str
Requerido

Id. de concesión para la concesión activa.

proposed_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
valor predeterminado: None

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
valor predeterminado: None

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.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

copy_blob

Copia un blob de forma asincrónica. Esta operación devuelve un objeto de propiedades de operación de copia, incluido un identificador de copia que puede usar para comprobar o anular la operación de copia. 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.

Para todos los tipos de blobs, puede llamar a get_blob_properties en el blob de destino para comprobar el estado de la operación de copia. El blob final se confirmará cuando se complete la copia.

copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor de destino. El contenedor debe existir.

blob_name
str
Requerido

Nombre del blob de destino. Si el blob de destino existe, se sobrescribirá. De lo contrario, se creará.

copy_source
str
Requerido

Dirección URL de hasta 2 KB de longitud que especifica un archivo o un blob de Azure. 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/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

metadata
dict(str, str)
valor predeterminado: None

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.

source_if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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_if_match
<xref:ETag>
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado condicional para copiar el blob de origen solo si la ETag coincide con el valor especificado. Si los valores de la ETag no coinciden, el servicio Blob devuelve el código de estado 412 (Error de condición previa). Este encabezado no se puede especificar si el origen es un archivo de Azure.

source_if_none_match
<xref:ETag>
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado condicional para copiar el blob de origen solo si la ETag no coincide con el valor especificado. Si los valores son idénticos, Blob service devuelve el código de estado 412 (Error de condición previa). Este encabezado no se puede especificar si el origen es un archivo de Azure.

destination_if_modified_since
datetime
valor predeterminado: None

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).

destination_if_unmodified_since
datetime
valor predeterminado: None

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).

destination_if_match
<xref:ETag>
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique un valor ETag para este encabezado condicional para copiar el blob solo si el valor de ETag especificado coincide con el valor ETag de un blob de destino existente. Si la ETag del blob de destino no coincide con la ETag especificada para If-Match, Blob service devuelve el código de estado 412 (error de condición previa).

destination_if_none_match
<xref:ETag>
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique un valor ETag para este encabezado condicional para copiar el blob solo si el valor de ETag especificado no coincide con el valor ETag del blob de destino. Especifique el carácter comodín () para realizar la operación solo si el blob de destino no existe. Si no se cumple la condición especificada, Blob service devuelve el código de estado 412 (Error de condición previa).

destination_lease_id
str
valor predeterminado: None

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_id
str
valor predeterminado: None

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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Copie las propiedades de la operación, como el estado, el origen y el identificador.

Tipo de valor devuelto

create_container

Crea un nuevo contenedor en la cuenta especificada. Si el contenedor con el mismo nombre ya existe, se produce un error en la operación si fail_on_exist es True.

create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor que se va a crear. El nombre del contenedor solo puede contener letras minúsculas, números y guiones, y debe comenzar con una letra o un número. Antes y después de cada guion debe ir un carácter que no sea otro guión. El nombre debe tener entre 3 y 63 caracteres.

metadata
dict(str, str)
valor predeterminado: None

Un dict con pares de name_value que se van a asociar al contenedor como metadatos. Ejemplo:{'Category':'test'}

public_access
PublicAccess
valor predeterminado: None

Entre los valores posibles se incluyen: contenedor, blob.

fail_on_exist
bool
valor predeterminado: False

Especifique si se va a producir una excepción cuando existe el contenedor.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

True si se crea el contenedor, False si el contenedor ya existe.

Tipo de valor devuelto

delete_blob

Marca el blob o la instantánea especificados 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 Eliminar blob.

Si se habilita una directiva de retención de eliminación para el servicio, esta operación elimina temporalmente el blob o la instantánea y conserva el blob o la instantánea durante el número de días especificado. Después del número especificado de días, los datos del blob se quitan del servicio durante la recolección de elementos no utilizados. Se puede acceder a blobs o instantáneas eliminadas temporalmente a través de list Blobs API que especifica la opción include=Include.Deleted. El blob o la instantánea eliminados temporalmente se pueden restaurar mediante la API Undelete.

delete_blob(container_name, blob_name, snapshot=None, lease_id=None, delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea de blob que se va a eliminar.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

delete_snapshots
DeleteSnapshot
valor predeterminado: None

Obligatorio si el blob tiene instantáneas asociadas.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si la ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y producirá un error en la operación si existe.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

delete_container

Marca el contenedor especificado para su eliminación. El contenedor y los blobs incluidos en él se eliminan posteriormente durante la recolección de elementos no utilizados.

delete_container(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor que se va a eliminar.

fail_not_exist
bool
valor predeterminado: False

Especifique si se va a producir una excepción cuando el contenedor no existe.

lease_id
str
valor predeterminado: None

Si se especifica, delete_container solo se realiza correctamente si la concesión del contenedor está activa y coincide con este identificador. Obligatorio si el contenedor tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

True si se elimina el contenedor, el contenedor False no existe.

Tipo de valor devuelto

exists

Devuelve un valor booleano que indica si el contenedor existe (si blob_name es None) o un valor booleano que indica si el blob existe.

exists(container_name, blob_name=None, snapshot=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre de un contenedor.

blob_name
str
valor predeterminado: None

Nombre de un blob. Si no, se comprobará la existencia del contenedor.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Valor booleano que indica si el recurso existe.

Tipo de valor devuelto

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parámetros

retry_context
Requerido

generate_account_shared_access_signature

Genera una firma de acceso compartido para blob service. Use la firma devuelta con el parámetro sas_token de cualquier BlobService.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Parámetros

resource_types
<xref:ResourceTypes>
Requerido

Especifica los tipos de recursos a los que se puede acceder con la SAS de la cuenta.

permission
<xref:AccountPermissions>
Requerido

Permisos asociados a la firma de acceso compartido. El usuario está restringido a las operaciones permitidas por los permisos. Obligatorio a menos que se especifique un identificador que haga referencia a una directiva de acceso almacenada que contenga este campo. Este campo se debe omitir si se ha especificado en una directiva de acceso almacenada asociada.

expiry
datetime o str
Requerido

Hora en la que la firma de acceso compartido deja de ser válida. Obligatorio a menos que se especifique un identificador que haga referencia a una directiva de acceso almacenada que contenga este campo. Este campo se debe omitir si se ha especificado en una directiva de acceso almacenada asociada. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

start
datetime o str
valor predeterminado: None

Hora en la que la firma de acceso compartido es válida. Si se omite, se supone que la hora de inicio de esta llamada es la hora a la que el servicio de almacenamiento recibe la solicitud. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

ip
str
valor predeterminado: None

Especifica una dirección IP o un intervalo de direcciones IP de las que se van a aceptar solicitudes. Si la dirección IP desde la que se origina la solicitud no coincide con la dirección IP o el intervalo de direcciones especificado en el token de SAS, la solicitud no se autentica. Por ejemplo, especificando sip=168.1.5.65 o sip=168.1.5.60-168.1.5.70 en la SAS restringe la solicitud a esas direcciones IP.

protocol
str
valor predeterminado: None

Especifica el protocolo permitido para una solicitud realizada. El valor predeterminado es https,http. Vea Protocol para conocer los valores posibles.

Devoluciones

Un token de firma de acceso compartido (sas).

Tipo de valor devuelto

str

generate_blob_shared_access_signature

Genera una firma de acceso compartido para el blob o una de sus instantáneas. Use la firma devuelta con el parámetro sas_token de cualquier BlobService.

generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor.

blob_name
str
Requerido

Nombre del blob.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea de blob que se va a conceder permiso.

permission
BlobPermissions
valor predeterminado: None

Permisos asociados a la firma de acceso compartido. El usuario está restringido a las operaciones permitidas por los permisos. Los permisos deben ordenarse de lectura, escritura, eliminación, lista. Obligatorio a menos que se especifique un identificador que haga referencia a una directiva de acceso almacenada que contenga este campo. Este campo se debe omitir si se ha especificado en una directiva de acceso almacenada asociada.

expiry
datetime o str
valor predeterminado: None

Hora en la que la firma de acceso compartido deja de ser válida. Obligatorio a menos que se especifique un identificador que haga referencia a una directiva de acceso almacenada que contenga este campo. Este campo se debe omitir si se ha especificado en una directiva de acceso almacenada asociada. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

start
datetime o str
valor predeterminado: None

Hora en la que la firma de acceso compartido es válida. Si se omite, se supone que la hora de inicio de esta llamada es la hora a la que el servicio de almacenamiento recibe la solicitud. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

id
str
valor predeterminado: None

Valor único de hasta 64 caracteres de longitud que se correlaciona con una directiva de acceso almacenada. Para crear una directiva de acceso almacenada, use set_container_acl.

ip
str
valor predeterminado: None

Especifica una dirección IP o un intervalo de direcciones IP de las que se van a aceptar solicitudes. Si la dirección IP desde la que se origina la solicitud no coincide con la dirección IP o el intervalo de direcciones especificado en el token de SAS, la solicitud no se autentica. Por ejemplo, especificando sip=168.1.5.65 o sip=168.1.5.60-168.1.5.70 en la SAS restringe la solicitud a esas direcciones IP.

protocol
str
valor predeterminado: None

Especifica el protocolo permitido para una solicitud realizada. El valor predeterminado es https,http. Vea Protocol para conocer los valores posibles.

cache_control
str
valor predeterminado: None

Valor del encabezado de respuesta para Cache-Control cuando se accede al recurso mediante esta firma de acceso compartido.

content_disposition
str
valor predeterminado: None

Valor del encabezado de respuesta para Content-Disposition cuando se accede a un recurso mediante esta firma de acceso compartido.

content_encoding
str
valor predeterminado: None

Valor del encabezado de respuesta para Content-Encoding cuando se accede a un recurso mediante esta firma de acceso compartido.

content_language
str
valor predeterminado: None

Valor del encabezado de respuesta para Content-Language cuando se accede al recurso mediante esta firma de acceso compartido.

content_type
str
valor predeterminado: None

Valor del encabezado de respuesta para Content-Type cuando se accede a un recurso mediante esta firma de acceso compartido.

user_delegation_key
UserDelegationKey
valor predeterminado: None

En lugar de una clave de cuenta, el usuario podría pasar una clave de delegación de usuarios. Se puede obtener una clave de delegación de usuarios del servicio mediante la autenticación con una identidad de AAD; Esto se puede lograr llamando a get_user_delegation_key. Cuando está presente, la SAS se firma con la clave de delegación de usuarios en su lugar.

Devoluciones

Un token de firma de acceso compartido (sas).

Tipo de valor devuelto

str

generate_container_shared_access_signature

Genera una firma de acceso compartido para el contenedor. Use la firma devuelta con el parámetro sas_token de cualquier BlobService.

generate_container_shared_access_signature(container_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor.

permission
ContainerPermissions
valor predeterminado: None

Permisos asociados a la firma de acceso compartido. El usuario está restringido a las operaciones permitidas por los permisos. Los permisos deben ordenarse de lectura, escritura, eliminación, lista. Obligatorio a menos que se especifique un identificador que haga referencia a una directiva de acceso almacenada que contenga este campo. Este campo se debe omitir si se ha especificado en una directiva de acceso almacenada asociada.

expiry
datetime o str
valor predeterminado: None

Hora en la que la firma de acceso compartido deja de ser válida. Obligatorio a menos que se especifique un identificador que haga referencia a una directiva de acceso almacenada que contenga este campo. Este campo se debe omitir si se ha especificado en una directiva de acceso almacenada asociada. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

start
datetime o str
valor predeterminado: None

Hora en la que la firma de acceso compartido es válida. Si se omite, se supone que la hora de inicio de esta llamada es la hora a la que el servicio de almacenamiento recibe la solicitud. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

id
str
valor predeterminado: None

Valor único de hasta 64 caracteres de longitud que se correlaciona con una directiva de acceso almacenada. Para crear una directiva de acceso almacenada, use set_blob_service_properties.

ip
str
valor predeterminado: None

Especifica una dirección IP o un intervalo de direcciones IP de las que se van a aceptar solicitudes. Si la dirección IP desde la que se origina la solicitud no coincide con la dirección IP o el intervalo de direcciones especificado en el token de SAS, la solicitud no se autentica. Por ejemplo, especificando sip=168.1.5.65 o sip=168.1.5.60-168.1.5.70 en la SAS restringe la solicitud a esas direcciones IP.

protocol
str
valor predeterminado: None

Especifica el protocolo permitido para una solicitud realizada. El valor predeterminado es https,http. Vea Protocol para conocer los valores posibles.

cache_control
str
valor predeterminado: None

Valor del encabezado de respuesta para Cache-Control cuando se accede al recurso mediante esta firma de acceso compartido.

content_disposition
str
valor predeterminado: None

Valor del encabezado de respuesta para Content-Disposition cuando se accede a un recurso mediante esta firma de acceso compartido.

content_encoding
str
valor predeterminado: None

Valor del encabezado de respuesta para Content-Encoding cuando se accede a un recurso mediante esta firma de acceso compartido.

content_language
str
valor predeterminado: None

Valor del encabezado de respuesta para Content-Language cuando se accede al recurso mediante esta firma de acceso compartido.

content_type
str
valor predeterminado: None

Valor del encabezado de respuesta para Content-Type cuando se accede a un recurso mediante esta firma de acceso compartido.

user_delegation_key
UserDelegationKey
valor predeterminado: None

En lugar de una clave de cuenta, el usuario podría pasar una clave de delegación de usuarios. Se puede obtener una clave de delegación de usuarios del servicio mediante la autenticación con una identidad de AAD; Esto se puede lograr llamando a get_user_delegation_key. Cuando está presente, la SAS se firma con la clave de delegación de usuarios en su lugar.

Devoluciones

Un token de firma de acceso compartido (sas).

Tipo de valor devuelto

str

get_blob_account_information

Obtiene información relacionada con la cuenta de almacenamiento. La información también se puede recuperar si el usuario tiene una SAS en un contenedor o blob.

get_blob_account_information(container_name=None, blob_name=None, timeout=None)

Parámetros

container_name
str
valor predeterminado: None

Nombre del contenedor existente. Opcional, a menos que se use un token de SAS en un contenedor o blob específico, en cuyo caso es necesario.

blob_name
str
valor predeterminado: None

Nombre del blob existente. Opcional, a menos que se use un token de SAS en un blob específico, en cuyo caso es necesario.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

El parámetro de cadena de consulta AccountInformation.

get_blob_metadata

Devuelve todos los metadatos definidos por el usuario para el blob o la instantánea especificados.

get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor opaco que, cuando está presente, especifica la instantánea de blob que se va a recuperar.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si la ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y producirá un error en la operación si existe.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

Descifra 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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Diccionario que representa el nombre de los metadatos del blob, los pares de valores.

Tipo de valor devuelto

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. Devuelve Blob con BlobProperties y un dict de metadatos.

get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea de blob que se va a recuperar.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si la ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y producirá un error en la operación si existe.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

Descifra 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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

un objeto de blob que incluye propiedades y metadatos.

Tipo de valor devuelto

get_blob_service_properties

Obtiene las propiedades de blob service de una cuenta de almacenamiento, incluido Azure Storage Analytics.

get_blob_service_properties(timeout=None)

Parámetros

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Blob ServiceProperties con una propiedad target_version adjunta.

get_blob_service_stats

Recupera las estadísticas relacionadas con la replicación para el servicio Blob. Solo está disponible cuando la replicación con redundancia geográfica con acceso de lectura está habilitada para la cuenta de almacenamiento.

Con la replicación con redundancia geográfica, Azure Storage mantiene los datos duraderos en dos ubicaciones. En las dos ubicaciones, Azure Storage mantiene constantemente réplicas en estado correcto de los datos. La ubicación en la que lee, crea, actualiza o elimina los datos es la ubicación de la cuenta de almacenamiento principal. La ubicación principal existe en la región que elija en el momento de crear una cuenta a través del Portal de Azure clásico de Administración de Azure, por ejemplo, Centro-norte de EE. UU. La ubicación en la que se replican los datos es la ubicación secundaria. La ubicación secundaria se determina automáticamente según la ubicación de la principal; está en un segundo centro de datos que se encuentra en la misma región que la ubicación principal. El acceso de solo lectura está disponible en la ubicación secundaria, si la replicación con redundancia geográfica con acceso de lectura está habilitada para la cuenta de almacenamiento.

get_blob_service_stats(timeout=None)

Parámetros

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Las estadísticas del servicio BLOB.

Tipo de valor devuelto

get_blob_to_bytes

Descarga un blob como una matriz de bytes, con notificaciones automáticas de fragmentación y progreso. Devuelve una instancia de Blob con propiedades, metadatos y contenido.

get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea de blob que se va a recuperar.

start_range
int
valor predeterminado: None

Inicio del intervalo de bytes que se va a usar para descargar una sección del blob. Si no se da ningún end_range, se descargarán todos los bytes después del start_range. Los parámetros start_range y end_range son inclusivos. Por ejemplo: start_range=0, end_range=511 descargará los primeros 512 bytes del blob.

end_range
int
valor predeterminado: None

Final del intervalo de bytes que se va a usar para descargar una sección del blob. Si se proporciona end_range, se debe proporcionar start_range. Los parámetros start_range y end_range son inclusivos. Por ejemplo: start_range=0, end_range=511 descargará los primeros 512 bytes del blob.

validate_content
bool
valor predeterminado: False

Si se establece en true, valida un hash MD5 para cada parte recuperada del blob. Esto es principalmente útil para detectar bitflips en la conexión si el uso de http en lugar de https como https (el valor predeterminado) ya se validará. Tenga en cuenta que el servicio solo devolverá MD5 transaccional para fragmentos de 4 MB o menos, por lo que la primera solicitud get será de tamaño propio. MAX_CHUNK_GET_SIZE en lugar de sí mismo. MAX_SINGLE_GET_SIZE. Si es yo. MAX_CHUNK_GET_SIZE se estableció en mayor que 4 MB, se producirá un error. A medida que la computación md5 tarda tiempo de procesamiento y es necesario realizar más solicitudes debido al tamaño reducido del fragmento, puede haber algún aumento en la latencia.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor predeterminado: None

Devolución de llamada para el progreso con la función de firma (actual, total) donde current es el número de bytes transferidos hasta ahora, y el total es el tamaño del blob si se conoce.

max_connections
int
valor predeterminado: 2

Si se establece en 2 o superior, se realizará una obtención inicial para el primer auto. MAX_SINGLE_GET_SIZE bytes del blob. Si se trata de todo el blob, el método devuelve en este momento. Si no es así, descargará los datos restantes en paralelo con el número de subprocesos iguales a max_connections. Cada fragmento será de tamaño propio. MAX_CHUNK_GET_SIZE. Si se establece en 1, se realizará una única solicitud get grande. Esto no se recomienda generalmente, pero está disponible si se deben usar muy pocos subprocesos, las solicitudes de red son muy costosas o una secuencia no buscable impide la descarga en paralelo. Esto también puede ser útil si se espera que muchos blobs estén vacíos, ya que se requiere una solicitud adicional para blobs vacíos si max_connections es mayor que 1.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

Descifra 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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos. Este método puede realizar varias llamadas al servicio de Azure y el tiempo de espera se aplicará a cada llamada individualmente.

Devoluciones

Un blob con propiedades y metadatos. Si max_connections es mayor que 1, no se devolverá el content_md5 (si se establece en el blob). Si necesita este valor, use get_blob_properties o establezca max_connections en 1.

Tipo de valor devuelto

get_blob_to_path

Descarga un blob en una ruta de acceso de archivo, con notificaciones automáticas de fragmentación y progreso. Devuelve una instancia de Blob con propiedades y metadatos.

get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

file_path
str
Requerido

Ruta de acceso del archivo en la que se va a escribir.

open_mode
str
valor predeterminado: wb

Modo que se va a usar al abrir el archivo. Tenga en cuenta que especificar append only open_mode impide la descarga en paralelo. Por lo tanto, max_connections debe establecerse en 1 si se usa este open_mode.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea del blob que se va a recuperar.

start_range
int
valor predeterminado: None

Inicio del intervalo de bytes que se va a usar para descargar una sección del blob. Si no se da ningún end_range, se descargarán todos los bytes después del start_range. Los parámetros start_range y end_range son inclusivos. Por ejemplo: start_range=0, end_range=511 descargará los primeros 512 bytes del blob.

end_range
int
valor predeterminado: None

Fin del intervalo de bytes que se va a usar para descargar una sección del blob. Si se proporciona end_range, se debe proporcionar start_range. Los parámetros start_range y end_range son inclusivos. Por ejemplo: start_range=0, end_range=511 descargará los primeros 512 bytes del blob.

validate_content
bool
valor predeterminado: False

Si se establece en true, valida un hash MD5 para cada parte recuperada del blob. Esto es principalmente útil para detectar bitflips en la conexión si el uso de http en lugar de https como https (el valor predeterminado) ya se validará. Tenga en cuenta que el servicio solo devolverá MD5 transaccional para fragmentos de 4 MB o menos, por lo que la primera solicitud get será de tamaño propio. MAX_CHUNK_GET_SIZE en lugar de sí mismo. MAX_SINGLE_GET_SIZE. Si es yo. MAX_CHUNK_GET_SIZE se estableció en mayor que 4 MB, se producirá un error. A medida que la computación md5 tarda tiempo de procesamiento y es necesario realizar más solicitudes debido al tamaño reducido del fragmento, puede haber algún aumento en la latencia.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor predeterminado: None

Devolución de llamada para el progreso con la función de firma (actual, total) donde current es el número de bytes transferidos hasta ahora, y el total es el tamaño del blob si se conoce.

max_connections
int
valor predeterminado: 2

Si se establece en 2 o superior, se realizará una obtención inicial para el primer auto. MAX_SINGLE_GET_SIZE bytes del blob. Si se trata de todo el blob, el método devuelve en este momento. Si no es así, descargará los datos restantes en paralelo con el número de subprocesos iguales a max_connections. Cada fragmento será de tamaño propio. MAX_CHUNK_GET_SIZE. Si se establece en 1, se realizará una única solicitud get grande. Esto no se recomienda generalmente, pero está disponible si se deben usar muy pocos subprocesos, las solicitudes de red son muy costosas o una secuencia no buscable impide la descarga en paralelo. Esto también puede ser útil si se espera que muchos blobs estén vacíos, ya que se requiere una solicitud adicional para blobs vacíos si max_connections es mayor que 1.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

Descifra 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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos. Este método puede realizar varias llamadas al servicio de Azure y el tiempo de espera se aplicará a cada llamada individualmente.

Devoluciones

Un blob con propiedades y metadatos. Si max_connections es mayor que 1, no se devolverá el content_md5 (si se establece en el blob). Si necesita este valor, use get_blob_properties o establezca max_connections en 1.

Tipo de valor devuelto

get_blob_to_stream

Descarga un blob en una secuencia, con notificaciones automáticas de fragmentación y progreso. Devuelve una instancia de Blob con propiedades y metadatos.

get_blob_to_stream(container_name, blob_name, stream, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

stream
IOBase
Requerido

Secuencia abierta en la que se va a escribir.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea del blob que se va a recuperar.

start_range
int
valor predeterminado: None

Inicio del intervalo de bytes que se va a usar para descargar una sección del blob. Si no se da ningún end_range, se descargarán todos los bytes después del start_range. Los parámetros start_range y end_range son inclusivos. Por ejemplo: start_range=0, end_range=511 descargará los primeros 512 bytes del blob.

end_range
int
valor predeterminado: None

Fin del intervalo de bytes que se va a usar para descargar una sección del blob. Si se proporciona end_range, se debe proporcionar start_range. Los parámetros start_range y end_range son inclusivos. Por ejemplo: start_range=0, end_range=511 descargará los primeros 512 bytes del blob.

validate_content
bool
valor predeterminado: False

Si se establece en true, valida un hash MD5 para cada parte recuperada del blob. Esto es principalmente útil para detectar bitflips en la conexión si el uso de http en lugar de https como https (el valor predeterminado) ya se validará. Tenga en cuenta que el servicio solo devolverá MD5 transaccional para fragmentos de 4 MB o menos, por lo que la primera solicitud get será de tamaño propio. MAX_CHUNK_GET_SIZE en lugar de sí mismo. MAX_SINGLE_GET_SIZE. Si es yo. MAX_CHUNK_GET_SIZE se estableció en mayor que 4 MB, se producirá un error. A medida que la computación md5 tarda tiempo de procesamiento y es necesario realizar más solicitudes debido al tamaño reducido del fragmento, puede haber algún aumento en la latencia.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor predeterminado: None

Devolución de llamada para el progreso con la función de firma (actual, total) donde current es el número de bytes transferidos hasta ahora, y el total es el tamaño del blob si se conoce.

max_connections
int
valor predeterminado: 2

Si se establece en 2 o superior, se realizará una obtención inicial para el primer auto. MAX_SINGLE_GET_SIZE bytes del blob. Si se trata de todo el blob, el método devuelve en este momento. Si no es así, descargará los datos restantes en paralelo con el número de subprocesos iguales a max_connections. Cada fragmento será de tamaño propio. MAX_CHUNK_GET_SIZE. Si se establece en 1, se realizará una única solicitud get grande. Esto no se recomienda generalmente, pero está disponible si se deben usar muy pocos subprocesos, las solicitudes de red son muy costosas o una secuencia no buscable impide la descarga en paralelo. Esto también puede ser útil si se espera que muchos blobs estén vacíos, ya que se requiere una solicitud adicional para blobs vacíos si max_connections es mayor que 1.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

Descifra 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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos. Este método puede realizar varias llamadas al servicio de Azure y el tiempo de espera se aplicará a cada llamada individualmente.

Devoluciones

Un blob con propiedades y metadatos. Si max_connections es mayor que 1, no se devolverá el content_md5 (si se establece en el blob). Si necesita este valor, use get_blob_properties o establezca max_connections en 1.

Tipo de valor devuelto

get_blob_to_text

Descarga un blob como texto Unicode, con notificaciones automáticas de fragmentación y progreso. Devuelve una instancia de Blob con propiedades, metadatos y contenido.

get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

encoding
str
valor predeterminado: utf-8

Codificación de Python que se va a usar al descodificar los datos del blob.

snapshot
str
valor predeterminado: None

El parámetro snapshot es un valor DateTime opaco que, cuando está presente, especifica la instantánea del blob que se va a recuperar.

start_range
int
valor predeterminado: None

Inicio del intervalo de bytes que se va a usar para descargar una sección del blob. Si no se da ningún end_range, se descargarán todos los bytes después del start_range. Los parámetros start_range y end_range son inclusivos. Por ejemplo: start_range=0, end_range=511 descargará los primeros 512 bytes del blob.

end_range
int
valor predeterminado: None

Fin del intervalo de bytes que se va a usar para descargar una sección del blob. Si se proporciona end_range, se debe proporcionar start_range. Los parámetros start_range y end_range son inclusivos. Por ejemplo: start_range=0, end_range=511 descargará los primeros 512 bytes del blob.

validate_content
bool
valor predeterminado: False

Si se establece en true, valida un hash MD5 para cada parte recuperada del blob. Esto es principalmente útil para detectar bitflips en la conexión si el uso de http en lugar de https como https (el valor predeterminado) ya se validará. Tenga en cuenta que el servicio solo devolverá MD5 transaccional para fragmentos de 4 MB o menos, por lo que la primera solicitud get será de tamaño propio. MAX_CHUNK_GET_SIZE en lugar de sí mismo. MAX_SINGLE_GET_SIZE. Si es yo. MAX_CHUNK_GET_SIZE se estableció en mayor que 4 MB, se producirá un error. A medida que la computación md5 tarda tiempo de procesamiento y es necesario realizar más solicitudes debido al tamaño reducido del fragmento, puede haber algún aumento en la latencia.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor predeterminado: None

Devolución de llamada para el progreso con la función de firma (actual, total) donde current es el número de bytes transferidos hasta ahora, y el total es el tamaño del blob si se conoce.

max_connections
int
valor predeterminado: 2

Si se establece en 2 o superior, se realizará una obtención inicial para el primer auto. MAX_SINGLE_GET_SIZE bytes del blob. Si se trata de todo el blob, el método devuelve en este momento. Si no es así, descargará los datos restantes en paralelo con el número de subprocesos iguales a max_connections. Cada fragmento será de tamaño propio. MAX_CHUNK_GET_SIZE. Si se establece en 1, se realizará una única solicitud get grande. Esto no se recomienda generalmente, pero está disponible si se deben usar muy pocos subprocesos, las solicitudes de red son muy costosas o una secuencia no buscable impide la descarga en paralelo. Esto también puede ser útil si se espera que muchos blobs estén vacíos, ya que se requiere una solicitud adicional para blobs vacíos si max_connections es mayor que 1.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

Descifra 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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos. Este método puede realizar varias llamadas al servicio de Azure y el tiempo de espera se aplicará a cada llamada individualmente.

Devoluciones

Un blob con propiedades y metadatos. Si max_connections es mayor que 1, no se devolverá el content_md5 (si se establece en el blob). Si necesita este valor, use get_blob_properties o establezca max_connections en 1.

Tipo de valor devuelto

get_container_acl

Obtiene los permisos para el contenedor especificado. Los permisos indican si el acceso a los datos de un contenedor es público.

get_container_acl(container_name, lease_id=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

lease_id
valor predeterminado: None

Si se especifica, get_container_acl solo se realiza correctamente si la concesión del contenedor está activa y coincide con este identificador.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Diccionario de directivas de acceso asociadas al contenedor. dict de str a AccessPolicy y una propiedad public_access si el acceso público está activado

get_container_metadata

Devuelve todos los metadatos definidos por el usuario para el contenedor especificado.

get_container_metadata(container_name, lease_id=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

lease_id
str
valor predeterminado: None

Si se especifica, get_container_metadata solo se realiza correctamente si la concesión del contenedor está activa y coincide con este identificador.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Diccionario que representa el nombre de los metadatos del contenedor, los pares de valores.

Tipo de valor devuelto

get_container_properties

Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el contenedor especificado. Los datos devueltos no incluyen la lista de blobs del contenedor.

get_container_properties(container_name, lease_id=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

lease_id
str
valor predeterminado: None

Si se especifica, get_container_properties solo se realiza correctamente si la concesión del contenedor está activa y coincide con este identificador.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

propiedades del contenedor especificado dentro de un objeto contenedor.

Tipo de valor devuelto

get_user_delegation_key

Obtenga una clave de delegación de usuarios con el fin de firmar tokens de SAS. Una credencial de token debe estar presente en el objeto de servicio para que esta solicitud se realice correctamente.

get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)

Parámetros

key_start_time
datetime
Requerido

Un valor DateTime. Indica cuándo la clave es válida.

key_expiry_time
datetime
Requerido

Un valor DateTime. Indica cuándo la clave deja de ser válida.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

Clave de delegación de usuarios.

Tipo de valor devuelto

list_blob_names

Devuelve un generador para enumerar los nombres de blob en el contenedor especificado. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio y se detendrá cuando se hayan devuelto todos los blobs o se alcance num_results.

Si se especifica num_results y la cuenta tiene más de ese número de blobs, el generador tendrá un campo next_marker rellenado una vez que finalice. Este marcador se puede usar para crear un nuevo generador si se desean más resultados.

list_blob_names(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

prefix
str
valor predeterminado: None

Filtra los resultados para devolver solo los blobs cuyos nombres empiezan por el prefijo especificado.

num_results
int
valor predeterminado: None

Especifica el número máximo de blobs que se van a devolver, incluidos todos los elementos <xref:azure.storage.blob.baseblobservice.BlobPrefix>. Si la solicitud no especifica num_results o especifica un valor mayor que 5000, el servidor devolverá hasta 5000 elementos. Establecer num_results en un valor menor o igual que cero da como resultado el código de respuesta de error 400 (solicitud incorrecta).

include
Include
valor predeterminado: None

Especifica uno o varios conjuntos de datos adicionales que se van a incluir en la respuesta.

delimiter
str
valor predeterminado: None

Cuando la solicitud incluye este parámetro, la operación devuelve un BlobPrefix elemento de la lista de resultados que actúa como marcador de posición para todos los blobs cuyos nombres comienzan con la misma subcadena hasta la apariencia del carácter delimitador. El delimitador puede ser un carácter o una cadena.

marker
str
valor predeterminado: None

Un token de continuación opaco. Este valor se puede recuperar del campo next_marker de un objeto generador anterior si se especificó num_results y ese generador ha terminado de enumerar los resultados. Si se especifica, este generador comenzará a devolver resultados desde el punto en el que se detuvo el generador anterior.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

list_blobs

Devuelve un generador para enumerar los blobs en el contenedor especificado. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio y se detendrá cuando se hayan devuelto todos los blobs o se alcance num_results.

Si se especifica num_results y la cuenta tiene más de ese número de blobs, el generador tendrá un campo next_marker rellenado una vez que finalice. Este marcador se puede usar para crear un nuevo generador si se desean más resultados.

list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

prefix
str
valor predeterminado: None

Filtra los resultados para devolver solo los blobs cuyos nombres empiezan por el prefijo especificado.

num_results
int
valor predeterminado: None

Especifica el número máximo de blobs que se van a devolver, incluidos todos los elementos <xref:azure.storage.blob.baseblobservice.BlobPrefix>. Si la solicitud no especifica num_results o especifica un valor mayor que 5000, el servidor devolverá hasta 5000 elementos. Establecer num_results en un valor menor o igual que cero da como resultado el código de respuesta de error 400 (solicitud incorrecta).

include
Include
valor predeterminado: None

Especifica uno o varios conjuntos de datos adicionales que se van a incluir en la respuesta.

delimiter
str
valor predeterminado: None

Cuando la solicitud incluye este parámetro, la operación devuelve un BlobPrefix elemento de la lista de resultados que actúa como marcador de posición para todos los blobs cuyos nombres comienzan con la misma subcadena hasta la apariencia del carácter delimitador. El delimitador puede ser un carácter o una cadena.

marker
str
valor predeterminado: None

Un token de continuación opaco. Este valor se puede recuperar del campo next_marker de un objeto generador anterior si se especificó num_results y ese generador ha terminado de enumerar los resultados. Si se especifica, este generador comenzará a devolver resultados desde el punto en el que se detuvo el generador anterior.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

list_containers

Devuelve un generador para enumerar los contenedores de la cuenta especificada. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio y se detendrá cuando se hayan devuelto todos los contenedores o se alcance num_results.

Si se especifica num_results y la cuenta tiene más de ese número de contenedores, el generador tendrá un campo next_marker rellenado una vez que finalice. Este marcador se puede usar para crear un nuevo generador si se desean más resultados.

list_containers(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)

Parámetros

prefix
str
valor predeterminado: None

Filtra los resultados para devolver solo los contenedores cuyos nombres comienzan por el prefijo especificado.

num_results
int
valor predeterminado: None

Especifica el número máximo de contenedores que se van a devolver. Una única solicitud de lista puede devolver hasta 1000 contianers y potencialmente un token de continuación que se debe seguir para obtener resutls adicionales.

include_metadata
bool
valor predeterminado: False

Especifica que los metadatos del contenedor se devuelven en la respuesta.

marker
str
valor predeterminado: None

Un token de continuación opaco. Este valor se puede recuperar del campo next_marker de un objeto generador anterior si se especificó num_results y ese generador ha terminado de enumerar los resultados. Si se especifica, este generador comenzará a devolver resultados desde el punto en el que se detuvo el generador anterior.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

make_blob_url

Crea la dirección URL para acceder a un blob.

make_blob_url(container_name, blob_name, protocol=None, sas_token=None, snapshot=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor.

blob_name
str
Requerido

Nombre del blob.

protocol
str
valor predeterminado: None

Protocolo que se va a usar: "http" o "https". Si no se especifica, usa el protocolo especificado cuando se inicializó BaseBlobService.

sas_token
str
valor predeterminado: None

Token de firma de acceso compartido creado con generate_shared_access_signature.

snapshot
str
valor predeterminado: None

Valor de cadena que identifica de forma única la instantánea. El valor de este parámetro de consulta indica la versión de instantánea.

Devoluciones

Dirección URL de acceso de blob.

Tipo de valor devuelto

str

make_container_url

Crea la dirección URL para acceder a un contenedor.

make_container_url(container_name, protocol=None, sas_token=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor.

protocol
str
valor predeterminado: None

Protocolo que se va a usar: "http" o "https". Si no se especifica, usa el protocolo especificado cuando se inicializó BaseBlobService.

sas_token
str
valor predeterminado: None

Token de firma de acceso compartido creado con generate_shared_access_signature.

Devoluciones

dirección URL de acceso del contenedor.

Tipo de valor devuelto

str

release_blob_lease

Libera la concesión. La concesión se puede liberar si el identificador de concesión especificado en la solicitud coincide con el que está asociado al blob. Liberar la concesión permite a otro cliente adquirir inmediatamente la concesión sobre el blob en cuanto finaliza la operación de liberación.

release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

lease_id
str
Requerido

Id. de concesión para la concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

release_container_lease

Liberar la concesión. La concesión se puede liberar si el lease_id especificado coincide con el asociado al contenedor. Liberar la concesión permite a otro cliente adquirir inmediatamente la concesión sobre el contenedor en cuanto finaliza la operación de liberación.

release_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

lease_id
str
Requerido

Id. de concesión para la concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

renew_blob_lease

Renueva la concesión. La concesión se puede renovar si el identificador de concesión especificado en la solicitud coincide con el que está asociado al blob. Tenga en cuenta que la concesión se puede renovar incluso si ha expirado, siempre que el blob no se haya modificado o concedido de nuevo desde la caducidad de la concesión. Cuando se renueva una concesión, el reloj que controla su duración se reinicia.

renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

lease_id
str
Requerido

Id. de concesión para la concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

str

renew_container_lease

Renueva la concesión. La concesión se puede renovar si el identificador de concesión especificado coincide con el asociado al contenedor. Tenga en cuenta que la concesión se puede renovar incluso si ha expirado, siempre que el contenedor no se haya concedido de nuevo desde la caducidad de la concesión. Cuando se renueva una concesión, el reloj que controla su duración se reinicia.

renew_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

lease_id
str
Requerido

Id. de concesión para la concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

str

set_blob_metadata

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

set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

metadata
dict(str, str)
valor predeterminado: None

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_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

ETag y las propiedades modificadas por última vez para el blob actualizado

Tipo de valor devuelto

set_blob_properties

Establece las propiedades del sistema en el blob. Si se establece una propiedad para el content_settings, se invalidarán todas las propiedades.

set_blob_properties(container_name, blob_name, content_settings=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

content_settings
ContentSettings
valor predeterminado: None

Objeto ContentSettings usado para establecer propiedades de blob.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

ETag y las propiedades modificadas por última vez para el blob actualizado

Tipo de valor devuelto

set_blob_service_properties

Establece las propiedades de Blob service de una cuenta de almacenamiento, incluido Azure Storage Analytics. Si un elemento (por ejemplo, Registro) se deja como None, se conservan los valores existentes en el servicio para esa funcionalidad.

set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None)

Parámetros

logging
Logging
valor predeterminado: None

Agrupa los valores de Logging de análisis de Azure.

hour_metrics
Metrics
valor predeterminado: None

La configuración de métricas de hora proporciona un resumen de las estadísticas de solicitud agrupadas por API en agregados por hora para blobs.

minute_metrics
Metrics
valor predeterminado: None

La configuración de métricas por minuto proporciona estadísticas de solicitud para cada minuto para los blobs.

cors
list(CorsRule)
valor predeterminado: None

Puede incluir hasta cinco elementos CorsRule en la lista. Si se especifica una lista vacía, se eliminarán todas las reglas de CORS y CORS se deshabilitará para el servicio.

target_version
str
valor predeterminado: None

Indica la versión predeterminada que se va a usar para las solicitudes si no se especifica la versión de una solicitud entrante.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

delete_retention_policy
DeleteRetentionPolicy
valor predeterminado: None

La directiva de retención de eliminación especifica si se deben conservar los blobs eliminados. También especifica el número de días y versiones del blob que se van a conservar.

static_website
StaticWebsite
valor predeterminado: None

Especifica si la característica de sitio web estático está habilitada y, si es así, indica el documento de índice y el documento de error 404 que se va a usar.

set_container_acl

Establece los permisos para el contenedor especificado o las directivas de acceso almacenadas que se pueden usar con firmas de acceso compartido. Los permisos indican si el acceso a los blobs de un contenedor es público.

set_container_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

signed_identifiers
dict(str, AccessPolicy)
valor predeterminado: None

Diccionario de directivas de acceso que se van a asociar al contenedor. El diccionario puede contener hasta 5 elementos. Un diccionario vacío borrará las directivas de acceso establecidas en el servicio.

public_access
PublicAccess
valor predeterminado: None

Entre los valores posibles se incluyen: contenedor, blob.

lease_id
str
valor predeterminado: None

Si se especifica, set_container_acl solo se realiza correctamente si la concesión del contenedor está activa y coincide con este identificador.

if_modified_since
datetime
valor predeterminado: None

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 se ha modificado desde la fecha y hora especificadas.

if_unmodified_since
datetime
valor predeterminado: None

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.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

ETag y propiedades modificadas por última vez para el contenedor actualizado

Tipo de valor devuelto

set_container_metadata

Establece uno o varios pares nombre-valor definidos por el usuario para el contenedor especificado. Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntados al contenedor. Para quitar todos los metadatos del contenedor, llame a esta operación sin dict de metadatos.

set_container_metadata(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

metadata
dict(str, str)
valor predeterminado: None

Un dict que contiene pares nombre-valor que se van a asociar al contenedor como metadatos. Ejemplo: {'category':'test'}

lease_id
str
valor predeterminado: None

Si se especifica, set_container_metadata solo se realiza correctamente si la concesión del contenedor está activa y coincide con este identificador.

if_modified_since
datetime
valor predeterminado: None

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.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

ETag y propiedades modificadas por última vez para el contenedor actualizado

Tipo de valor devuelto

set_proxy

Establece el host y el puerto del servidor proxy para la tunelización HTTP CONNECT.

set_proxy(host, port, user=None, password=None)

Parámetros

host
str
Requerido

Dirección del proxy. Por ejemplo: '192.168.0.100'

port
int
Requerido

Puerto del proxy. Por ejemplo: 6000

user
str
valor predeterminado: None

Usuario para la autorización de proxy.

password
str
valor predeterminado: None

Contraseña para la autorización de proxy.

snapshot_blob

Crea una instantánea de solo lectura de un blob.

snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, cpk=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

metadata
dict(str, str)
valor predeterminado: None

Especifica un par nombre-valor definido por el usuario asociado al blob. Si no se especifica ningún par nombre-valor, la operación copiará los metadatos del blob base en la instantánea. Si se especifican uno o varios pares nombre-valor, la instantánea se crea con los metadatos especificados, y los metadatos no se copian del blob base.

if_modified_since
datetime
valor predeterminado: None

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
valor predeterminado: None

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.

if_match
str
valor predeterminado: None

Valor ETag o el carácter comodín (*). Especifique este encabezado para realizar la operación solo si la ETag del recurso coincide con el valor especificado.

if_none_match
str
valor predeterminado: None

Un valor ETag o el carácter comodín (). Especifique este encabezado para realizar la operación solo si el valor de ETag del recurso no coincide con el valor especificado. Especifique el carácter comodín () para realizar la operación solo si el recurso no existe y produce un error en la operación si existe.

lease_id
str
valor predeterminado: None

Obligatorio si el blob tiene una concesión activa.

cpk
CustomerProvidedEncryptionKey
valor predeterminado: None

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
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Devoluciones

propiedades de instantánea

Tipo de valor devuelto

undelete_blob

La operación undelete Blob restaura el contenido y los metadatos del blob o la instantánea eliminados temporalmente. Si se intenta recuperar un blob o una instantánea que no se elimina temporalmente, se realizará correctamente sin realizar ningún cambio.

undelete_blob(container_name, blob_name, timeout=None)

Parámetros

container_name
str
Requerido

Nombre del contenedor existente.

blob_name
str
Requerido

Nombre del blob existente.

timeout
int
valor predeterminado: None

El parámetro de tiempo de espera se expresa en segundos.

Atributos

protocol

request_session

socket_timeout

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432