BlobClient Classe

Um cliente para interagir com um blob específico, embora esse blob ainda não exista.

Para obter mais configurações opcionais, clique aqui.

Herança

azure.storage.blob._shared.base_client.StorageAccountHostsMixin

BlobClient

azure.storage.blob._encryption.StorageEncryptionMixin

BlobClient

Construtor

BlobClient(account_url: str, container_name: str, blob_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Parâmetros

account_url

str

Obrigatório

O URI para a conta de armazenamento. Para criar um cliente com o URI completo para o blob, use o from_blob_url classmethod.

container_name

str

Obrigatório

O nome do contêiner para o blob.

blob_name

str

Obrigatório

O nome do blob com o qual interagir. Se especificado, esse valor substituirá um valor de blob especificado na URL do blob.

snapshot

str

valor padrão: None

O blob opcional instantâneo no qual operar. Esse pode ser o instantâneo cadeia de caracteres de ID ou a resposta retornada de create_snapshot.

credential

valor padrão: None

As credenciais com as quais autenticar. Isso será opcional se a URL da conta já tiver um token SAS. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. Se o URI do recurso já contiver um token SAS, isso será ignorado em favor de uma credencial explícita

• exceto no caso do AzureSasCredential, em que os tokens SAS conflitantes gerarão um ValueError. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.

api_version

str

A versão da API de Armazenamento a ser usada para solicitações. O valor padrão é a versão de serviço mais recente compatível com o SDK atual. A configuração para uma versão mais antiga pode resultar em compatibilidade de recursos reduzida.

Novo na versão 12.2.0.

secondary_hostname

str

O nome do host do ponto de extremidade secundário.

max_block_size

int

O tamanho máximo da parte para carregar um blob de blocos em partes. O padrão é 4*1024*1024 ou 4 MB.

max_single_put_size

int

Se o tamanho do blob for menor ou igual a max_single_put_size, o blob será carregado com apenas uma solicitação http PUT. Se o tamanho do blob for maior que max_single_put_size, o blob será carregado em partes. O padrão é 64*1024*1024 ou 64 MB.

min_large_block_upload_threshold

int

O tamanho mínimo da parte necessária para usar o algoritmo com eficiência de memória ao carregar um blob de blocos. O padrão é 4*1024*1024+1.

use_byte_buffer

bool

Use um buffer de bytes para carregamentos de blob de blocos. Usa False como padrão.

max_page_size

int

O tamanho máximo da parte para carregar um blob de páginas. O padrão é 4*1024*1024 ou 4 MB.

max_single_get_size

int

O tamanho máximo para um blob a ser baixado em uma única chamada, a parte excedida será baixada em partes (pode ser paralelo). O padrão é 32*1024*1024 ou 32 MB.

max_chunk_get_size

int

O tamanho máximo da parte usada para baixar um blob. O padrão é 4*1024*1024 ou 4 MB.

version_id

str

O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob no qual operar.

Métodos

abort_copy	Anular uma operação de cópia em andamento. Isso deixará um blob de destino com comprimento zero e metadados completos. Isso gerará um erro se a operação de cópia já tiver terminado.
acquire_lease	Solicita uma nova concessão. Se o blob não tiver uma concessão ativa, o Serviço blob criará uma concessão no blob e retornará uma nova concessão.
append_block	Confirma um novo bloco de dados no final do blob de acréscimo existente.
append_block_from_url	Cria um novo bloco a ser confirmado como parte de um blob, em que o conteúdo é lido de uma URL de origem.
clear_page	Limpa um intervalo de páginas.
close	Esse método é para fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto.
commit_block_list	A operação Confirmar Lista de Bloqueios grava um blob especificando a lista de IDs de bloco que compõem o blob.
create_append_blob	Cria um novo Blob de Acréscimo. Essa operação cria um novo blob de acréscimo de 0 comprimento. O conteúdo de qualquer blob existente é substituído pelo blob de acréscimo recém-inicializado. Para adicionar conteúdo ao blob de acréscimo, chame o append_block método ou append_block_from_url .
create_page_blob	Cria um novo Blob de Páginas do tamanho especificado.
create_snapshot	Cria um instantâneo do blob. Um instantâneo é uma versão somente leitura de um blob capturada em um momento no tempo. Ele pode ser lido, copiado ou excluído, mas não modificado. Os instantâneos fornecem uma maneira de fazer backup de um blob da maneira como ele aparece em um momento específico. Um instantâneo de um blob tem o mesmo nome que o blob de base do qual o instantâneo é obtido, com um valor DateTime acrescentado para indicar a hora em que o instantâneo foi obtido.
delete_blob	Marca o blob especificado para exclusão. O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação delete_blob(). Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá temporariamente o blob e manterá o blob por um número especificado de dias. Após o número especificado de dias, os dados do blob são removidos do serviço durante a coleta de lixo. O blob com exclusão reversível é acessível por meio list_blobs da especificação da opção include=['deleted'] . O blob excluído temporariamente pode ser restaurado usando <xref:azure.storage.blob.undelete> a operação .
delete_immutability_policy	A operação Excluir Política de Imutabilidade exclui a política de imutabilidade no blob. Novidades na versão 12.10.0: essa operação foi introduzida na versão de API '2020-10-02'.
download_blob	Baixa um blob no StorageStreamDownloader. O método readall() deve ser usado para ler todo o conteúdo ou readinto() deve ser usado para baixar o blob em um fluxo. O uso de chunks() retorna um iterador que permite que o usuário itere sobre o conteúdo em partes.
exists	Retornará True se houver um blob com os parâmetros definidos e retornará False caso contrário.
from_blob_url	Crie BlobClient a partir de uma URL de blob. Isso não dá suporte à URL de blob personalizada com '/' no nome do blob.
from_connection_string	Crie BlobClient a partir de uma cadeia de conexão.
get_account_information	Obtém informações relacionadas à conta de armazenamento na qual o blob reside. As informações também poderão ser recuperadas se o usuário tiver uma SAS para um contêiner ou blob. As chaves no dicionário retornado incluem 'sku_name' e 'account_kind'.
get_blob_properties	Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o blob. Ela não retorna o conteúdo do blob.
get_blob_tags	A operação Obter Marcas permite que os usuários obtenham marcas em uma versão de blob ou blob específica ou instantâneo. Novo na versão 12.4.0: essa operação foi introduzida na versão da API '2019-12-12'.
get_block_list	A operação Obter Lista de Blocos recupera a lista de blocos que foram carregados como parte de um blob de blocos.
get_page_range_diff_for_managed_disk	Retorna a lista de intervalos de página válidos para um disco gerenciado ou instantâneo. Observação Essa operação só está disponível para contas de disco gerenciado. Novo na versão 12.2.0: essa operação foi introduzida na versão da API '2019-07-07'.
get_page_ranges	PRETERIDO: retorna a lista de intervalos de página válidos para um Blob de Páginas ou instantâneo de um blob de páginas.
list_page_ranges	Retorna a lista de intervalos de página válidos para um Blob de Páginas ou instantâneo de um blob de páginas. Se previous_snapshot for especificado, o resultado será uma diferença de alterações entre o blob de destino e o instantâneo anterior.
query_blob	Permite que os usuários selecionem/projetem dados de blob/ou blob instantâneo fornecendo expressões de consulta simples. Essas operações retornam um BlobQueryReader, os usuários precisam usar readall() ou readinto() para obter dados de consulta.
resize_blob	Redimensiona um blob da página ao tamanho especificado. Se o valor especificado for menor do que o tamanho atual do blob, todas as páginas acima do valor especificado serão limpas.
seal_append_blob	A operação Seal sela o Blob de Acréscimo para torná-lo somente leitura. Novo na versão 12.4.0.
set_blob_metadata	Define metadados definidos pelo usuário para o blob como um ou mais pares nome-valor.
set_blob_tags	A operação Definir Marcas permite que os usuários definam marcas em um blob ou em uma versão de blob específica, mas não instantâneo. Cada chamada para essa operação substitui todas as marcas existentes anexadas ao blob. Para remover todas as marcas do blob, chame essa operação sem marcas definidas. Novidades na versão 12.4.0: essa operação foi introduzida na versão de API '2019-12-12'.
set_http_headers	Define as propriedades do sistema no blob. Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas.
set_immutability_policy	A operação Definir Política de Imutabilidade define a política de imutabilidade no blob. Novidades na versão 12.10.0: essa operação foi introduzida na versão de API '2020-10-02'.
set_legal_hold	A operação Definir Retenção Legal define uma retenção legal no blob. Novo na versão 12.10.0: essa operação foi introduzida na versão da API '2020-10-02'.
set_premium_page_blob_tier	Define as camadas de blob de página no blob. Essa API só tem suporte para blobs de páginas em contas premium.
set_sequence_number	Define o número da sequência de blob.
set_standard_blob_tier	Essa operação define a camada em um blob de blocos. A camada de um blob de blocos determina o tipo de armazenamento Hot/Cool/Archive. Essa operação não atualiza a ETag do blob.
stage_block	Cria um novo bloco a ser confirmado como parte de um blob.
stage_block_from_url	Cria um novo bloco a ser confirmado como parte de um blob em que o conteúdo é lido de uma URL.
start_copy_from_url	Copia um blob da URL fornecida. Essa operação retorna um dicionário que contém copy_status e copy_id, que podem ser usados para marcar o status da operação de cópia ou anulação. copy_status será "bem-sucedido" se a cópia for concluída de forma síncrona ou "pendente" se a cópia tiver sido iniciada de forma assíncrona. Para cópias assíncronas, o status pode ser verificado sondando o get_blob_properties método e verificando a cópia status. Defina requires_sync como True para forçar a cópia a ser síncrona. O serviço Blob copia blobs em uma base do melhor esforço. O blob de origem de uma operação de cópia pode ser um blob de blocos, um blob de acréscimo ou um blob de páginas. Se o blob de destino já existir, ele deverá ser do mesmo tipo do blob de origem. Qualquer blob de destino existente será substituído. O blob de destino não pode ser modificado quando uma operação de cópia está em andamento. Ao copiar de um blob de páginas, o serviço Blob cria um blob de páginas de destino do comprimento do blob de origem, inicialmente contendo todos os zeros. Os intervalos de páginas de origem são enumerados em seguida e os intervalos não vazios são copiados. Para um blob de blocos ou um blob de acréscimo, o serviço Blob cria um blob confirmado de comprimento zero antes de retornar dessa operação. Ao copiar de um blob de blocos, todos os blocos confirmados e suas IDs de bloco são copiados. Os blocos não confirmados não são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos confirmada que a origem. Ao copiar de um blob de acréscimo, todos os blocos confirmados são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos confirmada que a origem.
undelete_blob	Restaura blobs ou instantâneos excluídos temporariamente. A operação só será bem-sucedida se for usada dentro do número especificado de dias definido na política de retenção de exclusão. Se o controle de versão de blob estiver habilitado, o blob de base não poderá ser restaurado usando esse método. Em vez disso, use start_copy_from_url com a URL da versão do blob que você deseja promover para a versão atual.
upload_blob	Cria um novo blob de uma fonte de dados com agrupamento automático.
upload_blob_from_url	Cria um novo Blob de Blocos em que o conteúdo do blob é lido de uma determinada URL. O conteúdo de um blob existente é substituído pelo novo blob.
upload_page	A operação Carregar Páginas grava um intervalo de páginas em um blob de páginas.
upload_pages_from_url	A operação Carregar Páginas grava um intervalo de páginas em um blob de páginas em que o conteúdo é lido de uma URL.

abort_copy

Anular uma operação de cópia em andamento.

Isso deixará um blob de destino com comprimento zero e metadados completos. Isso gerará um erro se a operação de cópia já tiver terminado.

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

Parâmetros

copy_id

str ou BlobProperties

Obrigatório

A operação de cópia a ser anulada. Isso pode ser uma cadeia de caracteres de ID ou uma instância de BlobProperties.

Tipo de retorno

None

acquire_lease

Solicita uma nova concessão.

Se o blob não tiver uma concessão ativa, o Serviço blob criará uma concessão no blob e retornará uma nova concessão.

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

Parâmetros

lease_duration

int

Obrigatório

Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).

lease_id

str

Obrigatório

ID proposta da concessão, em um formato de cadeia de caracteres GUID. O Serviço blob retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Um objeto BlobLeaseClient.

Tipo de retorno

BlobLeaseClient

append_block

Confirma um novo bloco de dados no final do blob de acréscimo existente.

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

Parâmetros

data

bytes ou str ou Iterable

Obrigatório

Conteúdo do bloco. Isso pode ser bytes, texto, um objeto iterável ou semelhante a um arquivo.

length

int

Obrigatório

Tamanho do bloco em bytes.

validate_content

bool

Se for true, calculará um hash MD5 do conteúdo do bloco. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips no fio se o uso de http em vez de https, como https (o padrão), já validará. Observe que esse hash MD5 não é armazenado com o blob.

maxsize_condition

int

Cabeçalho condicional opcional. O comprimento máximo em bytes permitido para o blob de acréscimo. Se a operação Anexar Bloco fizer com que o blob exceda esse limite ou se o tamanho do blob já for maior do que o valor especificado neste cabeçalho, a solicitação falhará com o erro MaxBlobSizeConditionNotMet (HTTP status código 412 – Falha na pré-condição).

appendpos_condition

int

Cabeçalho condicional opcional, usado apenas para a operação De bloco de acréscimo. Um número que indica o deslocamento de bytes a ser comparado. O Bloco de Acréscimo terá êxito somente se a posição de acréscimo for igual a esse número. Se não estiver, a solicitação falhará com o erro AppendPositionConditionNotMet (HTTP status código 412 – Falha na pré-condição).

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

encoding

str

O padrão é UTF-8.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag, última modificação, deslocamento de acréscimo, contagem de blocos confirmados).

Tipo de retorno

dict(str, Any)

append_block_from_url

Cria um novo bloco a ser confirmado como parte de um blob, em que o conteúdo é lido de uma URL de origem.

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

Parâmetros

copy_source_url

str

Obrigatório

A URL dos dados de origem. Ele pode apontar para qualquer Blob ou Arquivo do Azure, que seja público ou tenha uma assinatura de acesso compartilhado anexada.

source_offset

int

Obrigatório

Isso indica o início do intervalo de bytes (inclusivo) que deve ser obtido da origem da cópia.

source_length

int

Obrigatório

Isso indica o fim do intervalo de bytes que deve ser obtido da origem da cópia.

source_content_md5

bytearray

Se fornecido, o serviço calculará o hash MD5 do conteúdo do bloco e será comparado com esse valor.

maxsize_condition

int

Cabeçalho condicional opcional. O comprimento máximo em bytes permitido para o blob de acréscimo. Se a operação Anexar Bloco fizer com que o blob exceda esse limite ou se o tamanho do blob já for maior que o valor especificado nesse cabeçalho, a solicitação falhará com o erro MaxBlobSizeConditionNotMet (HTTP status código 412 – Falha na pré-condição).

appendpos_condition

int

Cabeçalho condicional opcional, usado somente para a operação Anexar Bloco. Um número que indica o deslocamento de bytes a ser comparado. O Bloco de Acréscimo terá êxito somente se a posição de acréscimo for igual a esse número. Se não estiver, a solicitação falhará com o erro AppendPositionConditionNotMet (HTTP status código 412 – Falha na pré-condição).

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

O valor de ETag de destino ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência de destino a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

source_if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso de origem tiver sido modificado desde a hora especificada.

source_if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso de origem não tiver sido modificado desde a data/hora especificada.

source_etag

str

O valor de ETag de origem ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

source_match_condition

MatchConditions

A condição de correspondência de origem a ser usada na etag.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

source_authorization

str

Autentique-se como uma entidade de serviço usando um segredo do cliente para acessar um blob de origem. Verifique se "portador" é o prefixo da cadeia de caracteres source_authorization.

clear_page

Limpa um intervalo de páginas.

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

Parâmetros

offset

int

Obrigatório

Início do intervalo de bytes a ser usado para gravar em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

length

int

Obrigatório

Número de bytes a serem usados para gravação em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_sequence_number_lte

int

Se o número de sequência do blob for menor ou igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_sequence_number_lt

int

Se o número de sequência do blob for menor que o valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_sequence_number_eq

int

Se o número de sequência do blob for igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação).

Tipo de retorno

dict(str, Any)

close

Esse método é para fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto.

close()

commit_block_list

A operação Confirmar Lista de Bloqueios grava um blob especificando a lista de IDs de bloco que compõem o blob.

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

Parâmetros

block_list

list

Obrigatório

Lista de Blockblobs.

content_settings

ContentSettings

Obrigatório

Objeto ContentSettings usado para definir propriedades de blob. Usado para definir o tipo de conteúdo, a codificação, o idioma, a disposição, o md5 e o controle de cache.

metadata

dict[str, str]

Obrigatório

Pares de nome-valor associados ao blob como metadados.

tags

dict(str, str)

Pares nome-valor associados ao blob como marca. As marcas diferenciam maiúsculas de minúsculas. O conjunto de marcas pode conter no máximo 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres e os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres válidos de chave e valor de marca incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), menos (-), ponto (.), solidus (/), dois-pontos (:), igual a (=), sublinhado (_)

Novo na versão 12.4.0.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

immutability_policy

ImmutabilityPolicy

Especifica a política de imutabilidade de um blob, instantâneo de blob ou versão de blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

legal_hold

bool

Especificado se uma retenção legal deve ser definida no blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

validate_content

bool

Se for true, calculará um hash MD5 do conteúdo da página. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips na transmissão se usar http em vez de https, como https (o padrão), já será validado. Observe que esse hash MD5 não é armazenado com o blob.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob de destino com um valor correspondente.

Novo na versão 12.4.0.

standard_blob_tier

StandardBlobTier

Um valor de camada de blob padrão para o qual definir o blob. Para esta versão da biblioteca, isso só é aplicável a blobs de blocos em contas de armazenamento padrão.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação).

Tipo de retorno

dict(str, Any)

create_append_blob

Cria um novo Blob de Acréscimo. Essa operação cria um novo blob de acréscimo de 0 comprimento. O conteúdo de qualquer blob existente é substituído pelo blob de acréscimo recém-inicializado. Para adicionar conteúdo ao blob de acréscimo, chame o append_block método ou append_block_from_url .

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

Parâmetros

content_settings

ContentSettings

Obrigatório

Objeto ContentSettings usado para definir propriedades de blob. Usado para definir o tipo de conteúdo, a codificação, o idioma, a disposição, o md5 e o controle de cache.

metadata

dict(str, str)

Obrigatório

Pares de nome-valor associados ao blob como metadados.

tags

dict(str, str)

Pares nome-valor associados ao blob como marca. As marcas diferenciam maiúsculas de minúsculas. O conjunto de marcas pode conter no máximo 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres e os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres válidos de chave e valor de marca incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), menos (-), ponto (.), solidus (/), dois-pontos (:), igual a (=), sublinhado (_)

Novo na versão 12.4.0.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

immutability_policy

ImmutabilityPolicy

Especifica a política de imutabilidade de um blob, instantâneo de blob ou versão de blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

legal_hold

bool

Especificado se uma retenção legal deve ser definida no blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação).

Tipo de retorno

dict[str, Any]

create_page_blob

Cria um novo Blob de Páginas do tamanho especificado.

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

Parâmetros

size

int

Obrigatório

Isso especifica o tamanho máximo para o blob de páginas, até 1 TB. O tamanho do blob de páginas deve ser alinhado a um limite de 512 bytes.

content_settings

ContentSettings

Obrigatório

Objeto ContentSettings usado para definir propriedades de blob. Usado para definir o tipo de conteúdo, a codificação, o idioma, a disposição, o md5 e o controle de cache.

metadata

dict(str, str)

Obrigatório

Pares de nome-valor associados ao blob como metadados.

premium_page_blob_tier

PremiumPageBlobTier

Obrigatório

Um valor da camada de blob de páginas para o qual definir o blob. A camada correlaciona-se ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento Premium.

tags

dict(str, str)

Pares nome-valor associados ao blob como marca. As marcas diferenciam maiúsculas de minúsculas. O conjunto de marcas pode conter no máximo 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres e os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres válidos de chave e valor de marca incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), menos (-), ponto (.), solidus (/), dois-pontos (:), igual a (=), sublinhado (_)

Novo na versão 12.4.0.

sequence_number

int

Somente para blobs de páginas. O número de sequência é um valor controlado pelo usuário que você pode usar para rastrear solicitações. O valor do número de sequência deve ficar entre 0 e 2^63 - 1. O valor padrão é 0.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

immutability_policy

ImmutabilityPolicy

Especifica a política de imutabilidade de um blob, instantâneo de blob ou versão de blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

legal_hold

bool

Especificado se uma retenção legal deve ser definida no blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação).

Tipo de retorno

dict[str, Any]

create_snapshot

Cria um instantâneo do blob.

Um instantâneo é uma versão somente leitura de um blob capturada em um momento no tempo. Ele pode ser lido, copiado ou excluído, mas não modificado. Os instantâneos fornecem uma maneira de fazer backup de um blob da maneira como ele aparece em um momento específico.

Um instantâneo de um blob tem o mesmo nome que o blob de base do qual o instantâneo é obtido, com um valor DateTime acrescentado para indicar a hora em que o instantâneo foi obtido.

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

Parâmetros

metadata

dict(str, str)

Obrigatório

Pares de nome-valor associados ao blob como metadados.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob de destino com um valor correspondente.

Novo na versão 12.4.0.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (ID do instantâneo, Etag e última modificação).

Tipo de retorno

dict[str, Any]

delete_blob

Marca o blob especificado para exclusão.

O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação delete_blob().

Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá temporariamente o blob e manterá o blob por um número especificado de dias. Após o número especificado de dias, os dados do blob são removidos do serviço durante a coleta de lixo. O blob com exclusão reversível é acessível por meio list_blobs da especificação da opção include=['deleted'] . O blob excluído temporariamente pode ser restaurado usando <xref:azure.storage.blob.undelete> a operação .

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

Parâmetros

delete_snapshots

str

Obrigatório

Obrigatório se o blob tiver instantâneos associados. Os valores são:

• "only": exclui apenas os instantâneos de blobs.

• "include": exclui o blob junto com todos os instantâneos.

version_id

str

O parâmetro version id é um valor opaco DateTime que, quando presente, especifica a versão do blob a ser excluída.

Novo na versão 12.4.0.

Esse argumento palavra-chave foi introduzido na versão da API '2019-12-12'.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. Se especificado, delete_blob só terá êxito se a concessão do blob estiver ativa e corresponder a essa ID. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Tipo de retorno

None

delete_immutability_policy

A operação Excluir Política de Imutabilidade exclui a política de imutabilidade no blob.

Novidades na versão 12.10.0: essa operação foi introduzida na versão de API '2020-10-02'.

delete_immutability_policy(**kwargs: Any) -> None

Parâmetros

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Pares chave-valor de marcas de blob.

Tipo de retorno

Dict[str, str]

download_blob

Baixa um blob no StorageStreamDownloader. O método readall() deve ser usado para ler todo o conteúdo ou readinto() deve ser usado para baixar o blob em um fluxo. O uso de chunks() retorna um iterador que permite que o usuário itere sobre o conteúdo em partes.

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

Parâmetros

offset

int

Obrigatório

Início do intervalo de bytes a ser usado para baixar uma seção do blob. Deve ser definido se o comprimento for fornecido.

length

int

Obrigatório

Número de bytes a serem lidos do fluxo. Isso é opcional, mas deve ser fornecido para um desempenho ideal.

version_id

str

O parâmetro version id é um valor opaco DateTime que, quando presente, especifica a versão do blob a ser baixada.

Novo na versão 12.4.0.

Esse argumento palavra-chave foi introduzido na versão da API '2019-12-12'.

validate_content

bool

Se for true, calculará um hash MD5 para cada parte do blob. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips na transmissão se usar http em vez de https, como https (o padrão), já será validado. Observe que esse hash MD5 não é armazenado com o blob. Observe também que, se habilitado, o algoritmo de upload com eficiência de memória não será usado porque a computação do hash MD5 requer buffer de blocos inteiros e isso derrota a finalidade do algoritmo com eficiência de memória.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. Se especificado, download_blob só terá êxito se a concessão do blob estiver ativa e corresponder a essa ID. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

max_concurrency

int

O número de conexões paralelas com as quais baixar.

encoding

str

Codificação para decodificar os bytes baixados. O padrão é Nenhum, ou seja, nenhuma decodificação.

progress_hook

Callable[[int, int], None]

Um retorno de chamada para acompanhar o progresso de um download de execução prolongada. A assinatura é function(current: int, total: int), em que current é o número de bytes transferidos até agora, e total é o tamanho total do download.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui. Esse método pode fazer várias chamadas para o serviço e o tempo limite será aplicado a cada chamada individualmente. várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

Retornos

Um objeto de streaming (StorageStreamDownloader)

Tipo de retorno

StorageStreamDownloader

exists

Retornará True se houver um blob com os parâmetros definidos e retornará False caso contrário.

exists(**kwargs: Any) -> bool

Parâmetros

version_id

str

O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob para marcar se ele existir.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

booleano

Tipo de retorno

bool

from_blob_url

Crie BlobClient a partir de uma URL de blob. Isso não dá suporte à URL de blob personalizada com '/' no nome do blob.

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

Parâmetros

blob_url

str

Obrigatório

A URL completa do ponto de extremidade para o Blob, incluindo o token SAS e instantâneo se usado. Isso pode ser o ponto de extremidade primário ou o ponto de extremidade secundário, dependendo do location_mode atual.

credential

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

valor padrão: None

As credenciais com as quais autenticar. Isso é opcional se a URL da conta já tiver um token SAS ou se o cadeia de conexão já tiver valores de chave de acesso compartilhado. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. Se o URI do recurso já contiver um token SAS, isso será ignorado em favor de uma credencial explícita

• exceto no caso do AzureSasCredential, em que os tokens SAS conflitantes gerarão um ValueError. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.

snapshot

str

valor padrão: None

O blob opcional instantâneo no qual operar. Esse pode ser o instantâneo cadeia de caracteres de ID ou a resposta retornada de create_snapshot. Se especificado, isso substituirá o instantâneo na URL.

version_id

str

O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob no qual operar.

Retornos

Um cliente Blob.

Tipo de retorno

BlobClient

from_connection_string

Crie BlobClient a partir de uma cadeia de conexão.

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

Parâmetros

conn_str

str

Obrigatório

Um cadeia de conexão para uma conta de Armazenamento do Azure.

container_name

str

Obrigatório

O nome do contêiner para o blob.

blob_name

str

Obrigatório

O nome do blob com o qual interagir.

snapshot

str

valor padrão: None

O blob opcional instantâneo no qual operar. Esse pode ser o instantâneo cadeia de caracteres de ID ou a resposta retornada de create_snapshot.

credential

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

valor padrão: None

As credenciais com as quais autenticar. Isso é opcional se a URL da conta já tiver um token SAS ou se o cadeia de conexão já tiver valores de chave de acesso compartilhado. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. As credenciais fornecidas aqui terão precedência sobre as do cadeia de conexão. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.

version_id

str

O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob no qual operar.

Retornos

Um cliente Blob.

Tipo de retorno

BlobClient

get_account_information

Obtém informações relacionadas à conta de armazenamento na qual o blob reside.

As informações também poderão ser recuperadas se o usuário tiver uma SAS para um contêiner ou blob. As chaves no dicionário retornado incluem 'sku_name' e 'account_kind'.

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

Retornos

Um ditado de informações de conta (SKU e tipo de conta).

Tipo de retorno

dict(str, str)

get_blob_properties

Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o blob. Ela não retorna o conteúdo do blob.

get_blob_properties(**kwargs: Any) -> BlobProperties

Parâmetros

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

version_id

str

O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob para obter propriedades.

Novo na versão 12.4.0.

Esse argumento palavra-chave foi introduzido na versão da API '2019-12-12'.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

BlobProperties

Tipo de retorno

BlobProperties

get_blob_tags

A operação Obter Marcas permite que os usuários obtenham marcas em uma versão de blob ou blob específica ou instantâneo.

Novo na versão 12.4.0: essa operação foi introduzida na versão da API '2019-12-12'.

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

Parâmetros

version_id

str

O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob à qual adicionar marcas.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob de destino com um valor correspondente. ex. "\"tagname\"='my tag'"

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Pares de valores de chave de marcas de blob.

Tipo de retorno

Dict[str, str]

get_block_list

A operação Obter Lista de Blocos recupera a lista de blocos que foram carregados como parte de um blob de blocos.

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

Parâmetros

block_list_type

str

Obrigatório

Especifica se é necessário retornar a lista de blocos confirmados, a lista de blocos não confirmados ou as duas listas. Os valores possíveis incluem: 'committed', 'uncommitted', 'all'

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob de destino com um valor correspondente.

Novo na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Uma tupla de duas listas - blocos confirmados e não confirmados

Tipo de retorno

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

get_page_range_diff_for_managed_disk

Retorna a lista de intervalos de página válidos para um disco gerenciado ou instantâneo.

Observação

Essa operação só está disponível para contas de disco gerenciado.

Novo na versão 12.2.0: essa operação foi introduzida na versão da API '2019-07-07'.

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

Parâmetros

previous_snapshot_url

Obrigatório

Especifica a URL de um instantâneo anterior do disco gerenciado. A resposta conterá apenas páginas que foram alteradas entre o blob de destino e seus instantâneo anteriores.

offset

int

Obrigatório

Início do intervalo de bytes a ser usado para obter intervalos de página válidos. Se nenhum comprimento for fornecido, todos os bytes após o deslocamento serão pesquisados. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

length

int

Obrigatório

Número de bytes a serem usados para obter intervalos de página válidos. Se o comprimento for fornecido, o deslocamento deverá ser fornecido. Esse intervalo retornará intervalos de página válidos desde a inicialização do deslocamento até o comprimento especificado. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Uma tupla de duas listas de intervalos de páginas como dicionários com chaves 'start' e 'end'. O primeiro elemento são intervalos de página preenchidos, o segundo elemento é intervalos de páginas limpos.

Tipo de retorno

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

get_page_ranges

PRETERIDO: retorna a lista de intervalos de página válidos para um Blob de Páginas ou instantâneo de um blob de páginas.

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

Parâmetros

offset

int

Obrigatório

Início do intervalo de bytes a ser usado para obter intervalos de página válidos. Se nenhum comprimento for fornecido, todos os bytes após o deslocamento serão pesquisados. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

length

int

Obrigatório

Número de bytes a serem usados para obter intervalos de página válidos. Se o comprimento for fornecido, o deslocamento deverá ser fornecido. Esse intervalo retornará intervalos de página válidos desde a inicialização do deslocamento até o comprimento especificado. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

previous_snapshot_diff

str

Obrigatório

O parâmetro diff instantâneo que contém um valor datetime opaco que especifica um blob anterior instantâneo a ser comparado com um instantâneo mais recente ou o blob atual.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Uma tupla de duas listas de intervalos de páginas como dicionários com chaves 'start' e 'end'. O primeiro elemento são intervalos de página preenchidos, o segundo elemento é intervalos de páginas limpos.

Tipo de retorno

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

list_page_ranges

Retorna a lista de intervalos de página válidos para um Blob de Páginas ou instantâneo de um blob de páginas. Se previous_snapshot for especificado, o resultado será uma diferença de alterações entre o blob de destino e o instantâneo anterior.

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

Parâmetros

offset

int

Início do intervalo de bytes a ser usado para obter intervalos de página válidos. Se nenhum comprimento for fornecido, todos os bytes após o deslocamento serão pesquisados. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

length

int

Número de bytes a serem usados para obter intervalos de página válidos. Se o comprimento for fornecido, o deslocamento deverá ser fornecido. Esse intervalo retornará intervalos de página válidos desde a inicialização do deslocamento até o comprimento especificado. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

previous_snapshot

str ou Dict[str, Any]

Um valor instantâneo que especifica que a resposta conterá apenas páginas que foram alteradas entre o blob de destino e os instantâneo anteriores. As páginas alteradas incluem páginas atualizadas e desmarcadas. O blob de destino pode ser um instantâneo, desde que o instantâneo especificado por previous_snapshot seja o mais antigo dos dois.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

results_per_page

int

O número máximo de intervalos de páginas a serem recuperados por chamada à API.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Um iterável (paginação automática) de PageRange.

Tipo de retorno

ItemPaged[PageRange]

query_blob

Permite que os usuários selecionem/projetem dados de blob/ou blob instantâneo fornecendo expressões de consulta simples. Essas operações retornam um BlobQueryReader, os usuários precisam usar readall() ou readinto() para obter dados de consulta.

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

Parâmetros

query_expression

str

Obrigatório

Obrigatórios. uma instrução de consulta. Para obter mais informações, confira https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

on_error

Callable[BlobQueryError]

Uma função a ser chamada em quaisquer erros de processamento retornados pelo serviço.

blob_format

DelimitedTextDialect ou DelimitedJsonDialect ou QuickQueryDialect ou str

Opcional. Define a serialização dos dados armazenados atualmente no blob. O padrão é tratar os dados de blob como dados CSV formatados no dialeto padrão. Isso pode ser substituído por um DelimitedTextDialect personalizado ou DelimitedJsonDialect ou "ParquetDialect" (passado como uma cadeia de caracteres ou enumeração). Esses dialetos podem ser passados por suas respectivas classes, a enumeração QuickQueryDialect ou como uma cadeia de caracteres

output_format

DelimitedTextDialect ou DelimitedJsonDialect ou list[ArrowDialect] ou QuickQueryDialect ou str

Opcional. Define a serialização de saída para o fluxo de dados. Por padrão, os dados serão retornados, pois são representados no blob (formatos Parquet padrão para DelimitedTextDialect). Ao fornecer um formato de saída, os dados de blob serão reformatados de acordo com esse perfil. Esse valor pode ser um DelimitedTextDialect ou um DelimitedJsonDialect ou ArrowDialect. Esses dialetos podem ser passados por suas respectivas classes, a enumeração QuickQueryDialect ou como uma cadeia de caracteres

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Um objeto de streaming (BlobQueryReader)

Tipo de retorno

BlobQueryReader

resize_blob

Redimensiona um blob da página ao tamanho especificado.

Se o valor especificado for menor do que o tamanho atual do blob, todas as páginas acima do valor especificado serão limpas.

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

Parâmetros

size

int

Obrigatório

Tamanho usado para redimensionar blob. O tamanho máximo de um blob de páginas é de até 1 TB. O tamanho do blob de páginas deve ser alinhado a um limite de 512 bytes.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

premium_page_blob_tier

PremiumPageBlobTier

Um valor de camada de blob de página para definir o blob. A camada se correlaciona ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento premium.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação).

Tipo de retorno

dict(str, Any)

seal_append_blob

A operação Seal sela o Blob de Acréscimo para torná-lo somente leitura.

Novo na versão 12.4.0.

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

Parâmetros

appendpos_condition

int

Cabeçalho condicional opcional, usado apenas para a operação De bloco de acréscimo. Um número que indica o deslocamento de bytes a ser comparado. O Bloco de Acréscimo só terá êxito se a posição de acréscimo for igual a esse número. Se não estiver, a solicitação falhará com o erro AppendPositionConditionNotMet (HTTP status código 412 – Falha na pré-condição).

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Dict de propriedade atualizado por blob (Etag, última modificação, deslocamento de acréscimo, contagem de blocos confirmados).

Tipo de retorno

dict(str, Any)

set_blob_metadata

Define metadados definidos pelo usuário para o blob como um ou mais pares nome-valor.

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

Parâmetros

metadata

dict(str, str)

Obrigatório

Ditado que contém pares de nome e valor. Cada chamada para essa operação substitui todos os metadados existentes anexados ao blob. Para remover todos os metadados do blob, chame essa operação sem cabeçalhos de metadados.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação)

set_blob_tags

A operação Definir Marcas permite que os usuários definam marcas em um blob ou em uma versão de blob específica, mas não instantâneo. Cada chamada para essa operação substitui todas as marcas existentes anexadas ao blob. Para remover todas as marcas do blob, chame essa operação sem marcas definidas.

Novidades na versão 12.4.0: essa operação foi introduzida na versão de API '2019-12-12'.

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

Parâmetros

tags

dict(str, str)

Obrigatório

Pares nome-valor associados ao blob como marca. As marcas diferenciam maiúsculas de minúsculas. O conjunto de marcas pode conter no máximo 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres e os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres válidos de chave e valor de marca incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), menos (-), ponto (.), solidus (/), dois-pontos (:), igual a (=), sublinhado (_)

version_id

str

O parâmetro version id é um valor opaco DateTime que, quando presente, especifica a versão do blob à qual adicionar marcas.

validate_content

bool

Se for true, calculará um hash MD5 do conteúdo das marcas. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips na transmissão se usar http em vez de https, como https (o padrão), já será validado. Observe que esse hash MD5 não é armazenado com o blob.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob de destino com um valor correspondente. ex. "\"tagname\"='my tag'"

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação)

Tipo de retorno

Dict[str, Any]

set_http_headers

Define as propriedades do sistema no blob.

Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas.

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

Parâmetros

content_settings

ContentSettings

Obrigatório

Objeto ContentSettings usado para definir propriedades de blob. Usado para definir o tipo de conteúdo, a codificação, o idioma, a disposição, o md5 e o controle de cache.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação)

Tipo de retorno

Dict[str, Any]

set_immutability_policy

A operação Definir Política de Imutabilidade define a política de imutabilidade no blob.

Novidades na versão 12.10.0: essa operação foi introduzida na versão de API '2020-10-02'.

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

Parâmetros

immutability_policy

ImmutabilityPolicy

Obrigatório

Especifica a política de imutabilidade de um blob, instantâneo de blob ou versão de blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Pares chave-valor de marcas de blob.

Tipo de retorno

Dict[str, str]

set_legal_hold

A operação Definir Retenção Legal define uma retenção legal no blob.

Novo na versão 12.10.0: essa operação foi introduzida na versão da API '2020-10-02'.

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

Parâmetros

legal_hold

bool

Obrigatório

Especificado se uma retenção legal deve ser definida no blob.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Pares de valores de chave de marcas de blob.

Tipo de retorno

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

set_premium_page_blob_tier

Define as camadas de blob de página no blob. Essa API só tem suporte para blobs de páginas em contas premium.

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

Parâmetros

premium_page_blob_tier

PremiumPageBlobTier

Obrigatório

Um valor de camada de blob de página para definir o blob. A camada se correlaciona ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento premium.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

Tipo de retorno

None

set_sequence_number

Define o número da sequência de blob.

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

Parâmetros

sequence_number_action

str

Obrigatório

Essa propriedade indica como o serviço deve modificar o número de sequência do blob. Consulte SequenceNumberAction para obter mais informações.

sequence_number

str

Obrigatório

Essa propriedade define o número de sequência do blob. O número de sequência é uma propriedade controlada pelo usuário que você pode usar para monitorar solicitações e gerenciar problemas de simultaneidade.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação).

Tipo de retorno

dict(str, Any)

set_standard_blob_tier

Essa operação define a camada em um blob de blocos.

A camada de um blob de blocos determina o tipo de armazenamento Hot/Cool/Archive. Essa operação não atualiza a ETag do blob.

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

Parâmetros

standard_blob_tier

str ou StandardBlobTier

Obrigatório

Indica a camada a ser definida no blob. As opções incluem 'Hot', 'Cool', 'Archive'. A camada quente é otimizada para armazenar dados acessados com frequência. A camada de armazenamento esporádico é otimizada para armazenar dados que são acessados e armazenados com pouca frequência por pelo menos um mês. A camada de arquivos é otimizada para armazenar dados que raramente são acessados e armazenados por pelo menos seis meses com requisitos flexíveis de latência.

rehydrate_priority

RehydratePriority

Indica a prioridade com a qual reidratar um blob arquivado

version_id

str

O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob a ser baixada.

Novo na versão 12.4.0.

Esse argumento palavra-chave foi introduzido na versão da API '2019-12-12'.

if_tags_match_condition

str

Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

Tipo de retorno

None

stage_block

Cria um novo bloco a ser confirmado como parte de um blob.

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

Parâmetros

block_id

str

Obrigatório

Um valor de cadeia de caracteres que identifica o bloco. A cadeia de caracteres deve ser menor ou igual a 64 bytes de tamanho. Para um determinado blob, o block_id deve ter o mesmo tamanho para cada bloco.

data

Obrigatório

Os dados do blob.

length

int

Obrigatório

Tamanho do bloco.

validate_content

bool

Se for true, calculará um hash MD5 para cada parte do blob. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips no fio se o uso de http em vez de https, como https (o padrão), já validará. Observe que esse hash MD5 não é armazenado com o blob. Observe também que, se habilitado, o algoritmo de carregamento com eficiência de memória não será usado porque a computação do hash MD5 requer buffer de blocos inteiros e isso derrota a finalidade do algoritmo com eficiência de memória.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

encoding

str

O padrão é UTF-8.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.

Retornos

Dict da propriedade blob.

Tipo de retorno

dict[str, Any]

stage_block_from_url

Cria um novo bloco a ser confirmado como parte de um blob em que o conteúdo é lido de uma URL.

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

Parâmetros

block_id

str

Obrigatório

Um valor de cadeia de caracteres que identifica o bloco. A cadeia de caracteres deve ser menor ou igual a 64 bytes de tamanho. Para um determinado blob, o block_id deve ter o mesmo tamanho para cada bloco.

source_url

str

Obrigatório

A URL.

source_offset

int

Obrigatório

Início do intervalo de bytes a ser usado para o bloco. Deve ser definido se o comprimento da origem for fornecido.

source_length

int

Obrigatório

O tamanho do bloco em bytes.

source_content_md5

bytearray

Obrigatório

Especifique o md5 calculado para o intervalo de bytes que deve ser lido da origem da cópia.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

source_authorization

str

Autentique-se como uma entidade de serviço usando um segredo do cliente para acessar um blob de origem. Verifique se "portador" é o prefixo da cadeia de caracteres source_authorization.

Retornos

Dict de propriedade de blob.

Tipo de retorno

dict[str, Any]

start_copy_from_url

Copia um blob da URL fornecida.

Essa operação retorna um dicionário que contém copy_status e copy_id, que podem ser usados para marcar o status da operação de cópia ou anulação. copy_status será "bem-sucedido" se a cópia for concluída de forma síncrona ou "pendente" se a cópia tiver sido iniciada de forma assíncrona. Para cópias assíncronas, o status pode ser verificado sondando o get_blob_properties método e verificando a cópia status. Defina requires_sync como True para forçar a cópia a ser síncrona. O serviço Blob copia blobs em uma base do melhor esforço.

O blob de origem de uma operação de cópia pode ser um blob de blocos, um blob de acréscimo ou um blob de páginas. Se o blob de destino já existir, ele deverá ser do mesmo tipo do blob de origem. Qualquer blob de destino existente será substituído. O blob de destino não pode ser modificado quando uma operação de cópia está em andamento.

Ao copiar de um blob de páginas, o serviço Blob cria um blob de páginas de destino do comprimento do blob de origem, inicialmente contendo todos os zeros. Os intervalos de páginas de origem são enumerados em seguida e os intervalos não vazios são copiados.

Para um blob de blocos ou um blob de acréscimo, o serviço Blob cria um blob confirmado de comprimento zero antes de retornar dessa operação. Ao copiar de um blob de blocos, todos os blocos confirmados e suas IDs de bloco são copiados. Os blocos não confirmados não são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos confirmada que a origem.

Ao copiar de um blob de acréscimo, todos os blocos confirmados são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos confirmada que a origem.

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

Parâmetros

source_url

str

Obrigatório

Uma URL de até 2 KB de comprimento que especifica um arquivo ou blob. O valor deve ser codificado em URL tal como apareceria em um pedido URI. Se a origem estiver em outra conta, a origem deverá ser pública ou deve ser autenticada por meio de uma assinatura de acesso compartilhado. Se a origem for pública, nenhuma autenticação será necessária. Exemplos: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob? instantâneo=

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

metadata

dict(str, str)

Obrigatório

Pares de nome-valor associados ao blob como metadados. Se nenhum par nome-valor for especificado, a operação copiará os metadados do blob ou arquivo de origem para o blob de destino. Se um ou mais pares nome-valor forem especificados, o blob de destino será criado com os metadados especificados e os metadados não serão copiados do blob ou arquivo de origem.

incremental_copy

bool

Obrigatório

Copia o instantâneo do blob de páginas de origem para um blob de páginas de destino. O instantâneo é copiado de modo que apenas as alterações diferenciais entre as instantâneo copiadas anteriormente sejam transferidas para o destino. Os instantâneos copiados são cópias completas do instantâneo original e podem ser lidos ou copiados de como de costume. Usa False como padrão.

tags

dict(str, str) ou Literal["COPY"]

Pares nome-valor associados ao blob como marca. As marcas diferenciam maiúsculas de minúsculas. O conjunto de marcas pode conter no máximo 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres e os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres válidos de chave e valor de marca incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), menos (-), ponto (.), solidus (/), dois-pontos (:), igual a (=), sublinhado (_).

Em vez disso, o literal (que diferencia maiúsculas de minúsculas) "COPY" pode ser passado para copiar marcas do blob de origem. Essa opção só estará disponível quando incremental_copy=False e requires_sync=True.

Novo na versão 12.4.0.

immutability_policy

ImmutabilityPolicy

Especifica a política de imutabilidade de um blob, instantâneo de blob ou versão de blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

legal_hold

bool

Especificado se uma retenção legal deve ser definida no blob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

source_if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de origem tiver sido modificado desde a data/hora especificada.

source_if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de origem não tiver sido modificado desde a data/hora especificada.

source_etag

str

O valor de ETag de origem ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

source_match_condition

MatchConditions

A condição de correspondência de origem a ser usada na etag.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de destino tiver sido modificado desde a data/hora especificada. Se o blob de destino não tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição).

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de destino não tiver sido modificado desde a data/hora especificada. Se o blob de destino tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição).

etag

str

O valor de ETag de destino ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência de destino a ser usada na etag.

destination_lease

BlobLeaseClient ou str

A ID da concessão especificada para esse cabeçalho deve corresponder à ID de concessão do blob de destino. Se a solicitação não incluir a ID de concessão ou não for válida, a operação falhará com o código de status 412 (Falha na Pré-condição).

source_lease

BlobLeaseClient ou str

Especifique isso para executar a operação Copiar Blob somente se a ID de concessão fornecida corresponder à ID de concessão ativa do blob de origem.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

premium_page_blob_tier

PremiumPageBlobTier

Um valor da camada de blob de páginas para o qual definir o blob. A camada correlaciona-se ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento Premium.

standard_blob_tier

StandardBlobTier

Um valor de camada de blob padrão para o qual definir o blob. Para esta versão da biblioteca, isso só é aplicável a blobs de blocos em contas de armazenamento padrão.

rehydrate_priority

RehydratePriority

Indica a prioridade com a qual reidratar um blob arquivado

seal_destination_blob

bool

Selo do blob de acréscimo de destino. Essa operação destina-se apenas ao blob de acréscimo.

Novo na versão 12.4.0.

requires_sync

bool

Impõe que o serviço não retornará uma resposta até que a cópia seja concluída.

source_authorization

str

Autentique-se como uma entidade de serviço usando um segredo do cliente para acessar um blob de origem. Verifique se "portador" é o prefixo da cadeia de caracteres source_authorization. Essa opção só estará disponível quando incremental_copy estiver definido como False e requires_sync estiver definido como True.

Novo na versão 12.9.0.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no blob copiado de sincronização. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.10.0.

Retornos

Um dicionário de propriedades de cópia (etag, last_modified, copy_id copy_status).

Tipo de retorno

dict[str, Union[str, datetime]]

undelete_blob

Restaura blobs ou instantâneos excluídos temporariamente.

A operação só será bem-sucedida se for usada dentro do número especificado de dias definido na política de retenção de exclusão.

Se o controle de versão de blob estiver habilitado, o blob de base não poderá ser restaurado usando esse método. Em vez disso, use start_copy_from_url com a URL da versão do blob que você deseja promover para a versão atual.

undelete_blob(**kwargs: Any) -> None

Parâmetros

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Tipo de retorno

None

upload_blob

Cria um novo blob de uma fonte de dados com agrupamento automático.

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

Parâmetros

data

Obrigatório

Os dados de blob a serem carregados.

blob_type

BlobType

Obrigatório

O tipo do blob. Isso pode ser BlockBlob, PageBlob ou AppendBlob. O valor padrão é BlockBlob.

length

int

Obrigatório

Número de bytes a serem lidos do fluxo. Isso é opcional, mas deve ser fornecido para um desempenho ideal.

metadata

dict(str, str)

Obrigatório

Pares de nome-valor associados ao blob como metadados.

tags

dict(str, str)

Pares nome-valor associados ao blob como marca. As marcas diferenciam maiúsculas de minúsculas. O conjunto de marcas pode conter no máximo 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres e os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres válidos de chave e valor de marca incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), menos (-), ponto (.), solidus (/), dois-pontos (:), igual a (=), sublinhado (_)

Novo na versão 12.4.0.

overwrite

bool

Se o blob a ser carregado deve substituir os dados atuais. Se True, upload_blob substituirá os dados existentes. Se definido como False, a operação falhará com ResourceExistsError. A exceção acima é com Os tipos de blob de acréscimo: se definido como False e os dados já existirem, um erro não será gerado e os dados serão acrescentados ao blob existente. Se definido overwrite=True, o blob de acréscimo existente será excluído e um novo será criado. Usa False como padrão.

content_settings

ContentSettings

Objeto ContentSettings usado para definir propriedades de blob. Usado para definir o tipo de conteúdo, a codificação, o idioma, a disposição, o md5 e o controle de cache.

validate_content

bool

Se for true, calculará um hash MD5 para cada parte do blob. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips na transmissão se usar http em vez de https, como https (o padrão), já será validado. Observe que esse hash MD5 não é armazenado com o blob. Observe também que, se habilitado, o algoritmo de upload com eficiência de memória não será usado porque a computação do hash MD5 requer buffer de blocos inteiros e isso derrota a finalidade do algoritmo com eficiência de memória.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. Se especificado, upload_blob só terá êxito se a concessão do blob estiver ativa e corresponder a essa ID. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

premium_page_blob_tier

PremiumPageBlobTier

Um valor da camada de blob de páginas para o qual definir o blob. A camada correlaciona-se ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento Premium.

standard_blob_tier

StandardBlobTier

Um valor de camada de blob padrão para o qual definir o blob. Para esta versão da biblioteca, isso só é aplicável a blobs de blocos em contas de armazenamento padrão.

immutability_policy

ImmutabilityPolicy

Especifica a política de imutabilidade de um blob, instantâneo de blob ou versão de blob. Atualmente, esse parâmetro da API upload_blob() é apenas para BlockBlob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

legal_hold

bool

Especificado se uma retenção legal deve ser definida no blob. Atualmente, esse parâmetro da API upload_blob() é apenas para BlockBlob.

Novo na versão 12.10.0: isso foi introduzido na versão de API '2020-10-02'.

maxsize_condition

int

Cabeçalho condicional opcional. O comprimento máximo em bytes permitido para o blob de acréscimo. Se a operação Anexar Bloco fizer com que o blob exceda esse limite ou se o tamanho do blob já for maior que o valor especificado nesse cabeçalho, a solicitação falhará com o erro MaxBlobSizeConditionNotMet (HTTP status código 412 – Falha na pré-condição).

max_concurrency

int

Número máximo de conexões paralelas a serem usadas quando o tamanho do blob exceder 64 MB.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

encoding

str

O padrão é UTF-8.

progress_hook

Callable[[int, Optional[int]], None]

Um retorno de chamada para acompanhar o progresso de um upload de execução prolongada. A assinatura é function(current: int, total: Optional[int]), em que current é o número de bytes transferidos até agora, e total é o tamanho do blob ou None se o tamanho for desconhecido.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui. Esse método pode fazer várias chamadas para o serviço e o tempo limite será aplicado a cada chamada individualmente.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação)

Tipo de retorno

dict[str, Any]

upload_blob_from_url

Cria um novo Blob de Blocos em que o conteúdo do blob é lido de uma determinada URL. O conteúdo de um blob existente é substituído pelo novo blob.

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

Parâmetros

source_url

str

Obrigatório

Uma URL de até 2 KB de comprimento que especifica um arquivo ou blob. O valor deve ser codificado em URL tal como apareceria em um pedido URI. Se a origem estiver em outra conta, a origem deverá ser pública ou deve ser autenticada por meio de uma assinatura de acesso compartilhado. Se a origem for pública, nenhuma autenticação será necessária. Exemplos: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob? instantâneo=

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

overwrite

bool

Se o blob a ser carregado deve substituir os dados atuais. Se True, upload_blob substituirá os dados existentes. Se definido como False, a operação falhará com ResourceExistsError.

include_source_blob_properties

bool

Indica se as propriedades do blob de origem devem ser copiadas. O padrão é True.

tags

dict(str, str)

Pares nome-valor associados ao blob como marca. As marcas diferenciam maiúsculas de minúsculas. O conjunto de marcas pode conter no máximo 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres e os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres válidos de chave e valor de marca incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), menos (-), ponto (.), solidus (/), dois-pontos (:), igual a (=), sublinhado (_)

source_content_md5

bytearray

Especifique o md5 usado para verificar a integridade dos bytes de origem.

source_if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso de origem tiver sido modificado desde a hora especificada.

source_if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso de origem não tiver sido modificado desde a data/hora especificada.

source_etag

str

O valor de ETag de origem ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

source_match_condition

MatchConditions

A condição de correspondência de origem a ser usada na etag.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

O valor de ETag de destino ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência de destino a ser usada na etag.

destination_lease

BlobLeaseClient ou str

A ID da concessão especificada para esse cabeçalho deve corresponder à ID de concessão do blob de destino. Se a solicitação não incluir a ID de concessão ou não for válida, a operação falhará com o código de status 412 (Falha na Pré-condição).

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

content_settings

ContentSettings

Objeto ContentSettings usado para definir propriedades de blob. Usado para definir o tipo de conteúdo, a codificação, o idioma, a disposição, o md5 e o controle de cache.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

standard_blob_tier

StandardBlobTier

Um valor de camada de blob padrão para o qual definir o blob. Para esta versão da biblioteca, isso só é aplicável a blobs de blocos em contas de armazenamento padrão.

source_authorization

str

Autentique-se como uma entidade de serviço usando um segredo do cliente para acessar um blob de origem. Verifique se "portador" é o prefixo da cadeia de caracteres source_authorization.

upload_page

A operação Carregar Páginas grava um intervalo de páginas em um blob de páginas.

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

Parâmetros

page

bytes

Obrigatório

Conteúdo da página.

offset

int

Obrigatório

Início do intervalo de bytes a ser usado para gravar em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

length

int

Obrigatório

Número de bytes a serem usados para gravação em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

validate_content

bool

Se for true, calculará um hash MD5 do conteúdo da página. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips na transmissão se usar http em vez de https, como https (o padrão), já será validado. Observe que esse hash MD5 não é armazenado com o blob.

if_sequence_number_lte

int

Se o número de sequência do blob for menor ou igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_sequence_number_lt

int

Se o número de sequência do blob for menor que o valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_sequence_number_eq

int

Se o número de sequência do blob for igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

encoding

str

O padrão é UTF-8.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

Retornos

Dict de propriedade atualizado por blob (Etag e última modificação).

Tipo de retorno

dict(str, Any)

upload_pages_from_url

A operação Carregar Páginas grava um intervalo de páginas em um blob de páginas em que o conteúdo é lido de uma URL.

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

Parâmetros

source_url

str

Obrigatório

A URL dos dados de origem. Ele pode apontar para qualquer Blob ou Arquivo do Azure, que seja público ou tenha uma assinatura de acesso compartilhado anexada.

offset

int

Obrigatório

Início do intervalo de bytes a ser usado para gravar em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

length

int

Obrigatório

Número de bytes a serem usados para gravação em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o comprimento deve ser um módulo de 512.

source_offset

int

Obrigatório

Isso indica o início do intervalo de bytes (inclusivo) que deve ser retirado da origem da cópia. O serviço lerá o mesmo número de bytes que o intervalo de destino (deslocamento de comprimento).

source_content_md5

bytes

Se fornecido, o serviço calculará o hash MD5 do conteúdo do bloco e será comparado com esse valor.

source_if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso de origem tiver sido modificado desde a hora especificada.

source_if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso de origem não tiver sido modificado desde a data/hora especificada.

source_etag

str

O valor de ETag de origem ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

source_match_condition

MatchConditions

A condição de correspondência de origem a ser usada na etag.

lease

BlobLeaseClient ou str

Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.

if_sequence_number_lte

int

Se o número de sequência do blob for menor ou igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_sequence_number_lt

int

Se o número de sequência do blob for menor que o valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_sequence_number_eq

int

Se o número de sequência do blob for igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.

if_modified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

O valor de ETag de destino ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.

match_condition

MatchConditions

A condição de correspondência de destino a ser usada na etag.

if_tags_match_condition

str

Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente. ex. "\"tagname\"='my tag'"

Novo na versão 12.4.0.

cpk

CustomerProvidedEncryptionKey

Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.

encryption_scope

str

Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.

Novo na versão 12.2.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.

source_authorization

str

Autentique-se como uma entidade de serviço usando um segredo do cliente para acessar um blob de origem. Verifique se "portador" é o prefixo da cadeia de caracteres source_authorization.

Atributos

api_version

A versão da API de Armazenamento usada para solicitações.

location_mode

O modo de localização que o cliente está usando no momento.

Por padrão, isso será "primário". As opções incluem "primário" e "secundário".

primary_endpoint

A URL completa do ponto de extremidade primário.

primary_hostname

O nome do host do ponto de extremidade primário.

secondary_endpoint

A URL completa do ponto de extremidade secundário, se configurada.

Se não estiver disponível, um ValueError será gerado. Para especificar explicitamente um nome de host secundário, use o argumento opcional secondary_hostname palavra-chave na instanciação.

Exceções

ValueError

secondary_hostname

O nome do host do ponto de extremidade secundário.

Se não estiver disponível, este será Nenhum. Para especificar explicitamente um nome de host secundário, use o argumento opcional secondary_hostname palavra-chave na instanciação.

url

A URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado.

Pode ser o ponto de extremidade primário ou o ponto de extremidade secundário, dependendo do atual location_mode. :returns: a URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado. :rtype: str