azure.storage.blob.BlobClient class

Abortar uma operação de cópia em curso.

Isto irá deixar um blob de destino com comprimento zero e metadados completos. Isto irá 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

Necessário

A operação de cópia a abortar. Pode ser uma cadeia de ID ou uma instância de BlobProperties.

Tipo de retorno

None

Pede uma nova concessão.

Se o blob não tiver uma concessão ativa, o Serviço de Blobs cria uma concessão no blob e devolve uma nova concessão.

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

Parâmetros

lease_duration: int

Necessário

Especifica a duração da concessão, em segundos ou negativa (-1) para uma concessão que nunca expira. Uma concessão não infinita pode ter entre 15 e 60 segundos. Não é possível alterar a duração da concessão com renovação ou alteração. A predefinição é -1 (concessão infinita).

lease_id: str

Necessário

ID de concessão proposto, num formato de cadeia GUID. O Serviço blob devolve 400 (pedido inválido) se o ID de concessão proposto não estiver no formato correto.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Um objeto BlobLeaseClient.

Tipo de retorno

BlobLeaseClient

Consolida 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

Necessário

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

length: int

Necessário

Tamanho do bloco em bytes.

validate_content: bool

Se for verdadeiro, calcula um hash MD5 do conteúdo do bloco. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https, como https (a predefinição), já irá validar. Note que este Hash MD5 não está armazenado com a bolha.

maxsize_condition: int

Cabeçalho condicional opcional. O comprimento máximo em bytes permitido para o blob de acréscimo. Se a operação Bloco de Acréscimo 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, o pedido falhará com o erro MaxBlobSizeConditionNotMet (código de estado HTTP 412 – Falha na Pré-condição).

appendpos_condition: int

Cabeçalho condicional opcional, utilizado apenas para a operação Bloco de Acréscimo. Um número que indica o desvio de bytes a comparar. O Bloco de Acréscimo só será bem-sucedido se a posição de acréscimo for igual a este número. Se não estiver, o pedido falhará com o erro AppendPositionConditionNotMet (código de estado HTTP 412 – Falha na Pré-condição).

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

encoding: str

A predefinição é UTF-8.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag, última modificação, desvio de acréscimo, contagem de blocos consolidada).

Tipo de retorno

dict(str, Any)

Cria um novo bloco a ser consolidado como parte de um blob, onde os conteúdos são lidos a partir de um 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

Necessário

O URL dos dados de origem. Pode apontar para qualquer Blob ou Ficheiro do Azure, que seja público ou tenha uma assinatura de acesso partilhado anexada.

source_offset: int

Necessário

Isto indica o início do intervalo de bytes (inclusive) que tem de ser retirado da origem de cópia.

source_length: int

Necessário

Isto indica o fim do intervalo de bytes que tem de ser retirado da origem de cópia.

source_content_md5: bytearray

Se for indicado, o serviço calculará o hash MD5 do conteúdo do bloco e comparará com este 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 Acrescentar 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, o pedido falhará com o erro MaxBlobSizeConditionNotMet (código de estado HTTP 412 – Falha na Pré-condição).

appendpos_condition: int

Cabeçalho condicional opcional, utilizado apenas para a operação Acrescentar Bloco. Um número que indica o desvio de bytes a comparar. O Bloco de Acréscimo só será bem-sucedido se a posição de acréscimo for igual a este número. Se não estiver, o pedido falhará com o erro AppendPositionConditionNotMet (código de estado HTTP 412 – Falha na Pré-condição).

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

O valor ETag de destino ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

source_if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso de origem não tiver sido modificado desde a data/hora especificada.

source_etag: str

O valor ETag de origem ou o caráter universal (*). Utilizado para verificar 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 utilizar na etag.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

source_authorization: str

Autenticar como principal de serviço com um segredo do cliente para aceder a um blob de origem. Certifique-se de que "portador" é o prefixo da cadeia de source_authorization.

Limpa um intervalo de páginas.

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

Parâmetros

offset: int

Necessário

Início do intervalo de bytes a utilizar para escrever numa secção do blob. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um módulo de 512 e o comprimento tem de ser um módulo de 512.

length: int

Necessário

Número de bytes a utilizar para escrever numa secção do blob. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um módulo de 512 e o comprimento tem de ser um módulo de 512.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_sequence_number_lte: int

Se o número de sequência do blob for menor ou igual ao valor especificado, o pedido prossegue; caso contrário, falha.

if_sequence_number_lt: int

Se o número de sequência do blob for menor do que o valor especificado, o pedido prossegue; caso contrário, falha.

if_sequence_number_eq: int

Se o número de sequência do blob for igual ao valor especificado, o pedido prossegue; caso contrário, falha.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

timeout: int

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

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação).

Tipo de retorno

dict(str, Any)

Este método consiste em fechar os sockets abertos pelo cliente. Não é necessário utilizá-la ao utilizar com um gestor de contexto.

close()

A operação Consolidar Lista de Blocos escreve um blob ao especificar 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

Necessário

Lista de Blockblobs.

content_settings: ContentSettings

Necessário

Objeto ContentSettings utilizado para definir propriedades do blob. Utilizado para definir o tipo de conteúdo, codificação, idioma, disposição, md5 e controlo de cache.

metadata: dict[str, str]

Necessário

Pares nome-valor associados ao blob como metadados.

tags: dict(str, str)

Pares nome-valor associados ao blob como etiqueta. As etiquetas são sensíveis às maiúsculas e minúsculas. O conjunto de etiquetas pode conter, no máximo, 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres e os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave e valor de etiqueta válidos incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), subtração (-), ponto (.), solidus (/), dois pontos (:), igual a (=), caráter de sublinhado (_)

Novidade na versão 12.4.0.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

immutability_policy: ImmutabilityPolicy

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

Novidade na versão 12.10.0: foi introduzida na versão de API "2020-10-02".

legal_hold: bool

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

Novidade na versão 12.10.0: foi introduzida na versão de API "2020-10-02".

validate_content: bool

Se for verdadeiro, calcula um hash MD5 do conteúdo da página. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https, como https (a predefinição), já for validada. Note que este Hash MD5 não está armazenado com a bolha.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob de destino com um valor correspondente.

Novidade na versão 12.4.0.

standard_blob_tier: StandardBlobTier

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

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação).

Tipo de retorno

dict(str, Any)

Cria um novo Blob de Acréscimo. Esta operação cria um novo blob de acréscimo de 0 comprimentos. 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

Necessário

Objeto ContentSettings utilizado para definir propriedades do blob. Utilizado para definir o tipo de conteúdo, codificação, idioma, disposição, md5 e controlo de cache.

metadata: dict(str, str)

Necessário

Pares nome-valor associados ao blob como metadados.

tags: dict(str, str)

Pares nome-valor associados ao blob como etiqueta. As etiquetas são sensíveis às maiúsculas e minúsculas. O conjunto de etiquetas pode conter, no máximo, 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres e os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave e valor de etiqueta válidos incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), subtração (-), ponto (.), solidus (/), dois pontos (:), igual a (=), caráter de sublinhado (_)

Novidade na versão 12.4.0.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

immutability_policy: ImmutabilityPolicy

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

Novidade na versão 12.10.0: foi introduzida na versão de API "2020-10-02".

legal_hold: bool

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

Novidade na versão 12.10.0: foi introduzida na versão de API "2020-10-02".

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação).

Tipo de retorno

dict[str, Any]

Cria um novo Blob de Páginas com o 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

Necessário

Isto especifica o tamanho máximo para o blob de páginas, até 1 TB. O tamanho do blob de páginas tem de estar alinhado com um limite de 512 bytes.

content_settings: ContentSettings

Necessário

Objeto ContentSettings utilizado para definir propriedades do blob. Utilizado para definir o tipo de conteúdo, codificação, idioma, disposição, md5 e controlo de cache.

metadata: dict(str, str)

Necessário

Pares nome-valor associados ao blob como metadados.

premium_page_blob_tier: PremiumPageBlobTier

Necessário

Um valor de camada de blob de páginas para definir o blob como. A camada está correlacionada com o tamanho do blob e o número de IOPS permitidos. Isto só é aplicável a blobs de páginas em contas de armazenamento premium.

tags: dict(str, str)

Pares nome-valor associados ao blob como etiqueta. As etiquetas são sensíveis às maiúsculas e minúsculas. O conjunto de etiquetas pode conter, no máximo, 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres e os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave e valor de etiqueta válidos incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), subtração (-), ponto (.), solidus (/), dois pontos (:), igual a (=), caráter de sublinhado (_)

Novidade na versão 12.4.0.

sequence_number: int

Apenas para Blobs de páginas. O número de sequência é um valor controlado pelo utilizador que pode utilizar para controlar pedidos. O valor do número de sequência tem de estar entre 0 e 2^63 - 1. O valor predefinido é 0.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

immutability_policy: ImmutabilityPolicy

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

Novidade na versão 12.10.0: foi introduzida na versão de API "2020-10-02".

legal_hold: bool

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

Novidade na versão 12.10.0: foi introduzida na versão de API "2020-10-02".

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação).

Tipo de retorno

dict[str, Any]

Cria um instantâneo do blob.

Um instantâneo é uma versão só de leitura de um blob que é tirada num momento. Pode ser lido, copiado ou eliminado, mas não modificado. Os instantâneos fornecem uma forma de criar uma cópia de segurança de um blob, tal como aparece num momento no tempo.

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

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

Parâmetros

metadata: dict(str, str)

Necessário

Pares nome-valor associados ao blob como metadados.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob de destino com um valor correspondente.

Novidade na versão 12.4.0.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidades 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (ID de Instantâneo, Etag e última modificação).

Tipo de retorno

dict[str, Any]

Marca o blob especificado para eliminação.

O blob é posteriormente eliminado durante a recolha de lixo. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação delete_blob().

Se uma política de retenção de eliminação estiver ativada para o serviço, esta operação elimina o blob e mantém o blob durante 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 recolha da memória. O blob eliminado de forma recuperável é acessível através list_blobs da especificação da opção include=['deleted' ]. O blob eliminado de forma recuperável pode ser restaurado através <xref:azure.storage.blob.undelete> da operação.

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

Parâmetros

delete_snapshots: str

Necessário

Necessário se o blob tiver instantâneos associados. Os valores incluem:

"only": elimina apenas os instantâneos de blobs.
"include": elimina o blob juntamente com todos os instantâneos.

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob a eliminar.

Novidades na versão 12.4.0.

Este argumento de palavra-chave foi introduzido na versão da API "2019-12-12".

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. Se especificado, delete_blob só é bem-sucedido se a concessão do blob estiver ativa e corresponder a este ID. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Tipo de retorno

None

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

Novidade na versão 12.10.0: esta operação foi introduzida na versão da 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Pares de valores chave de etiquetas de blob.

Tipo de retorno

Dict[str, str]

Transfere um blob para o StorageStreamDownloader. O método readall() tem de ser utilizado para ler todo o conteúdo ou o método readinto() tem de ser utilizado para transferir o blob para um fluxo. A utilização de segmentos() devolve um iterador que permite ao utilizador iterar sobre o conteúdo em segmentos.

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

Parâmetros

offset: int

Necessário

Início do intervalo de bytes a utilizar para transferir uma secção do blob. Tem de ser definido se for fornecido o comprimento.

length: int

Necessário

Número de bytes a ler a partir do fluxo. Isto é opcional, mas deve ser fornecido para um desempenho ideal.

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob a transferir.

Novidades na versão 12.4.0.

Este argumento de palavra-chave foi introduzido na versão da API "2019-12-12".

validate_content: bool

Se for verdadeiro, calcula um hash MD5 para cada segmento do blob. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https, como https (a predefinição), já irá validar. Note que este Hash MD5 não está armazenado com a bolha. Tenha também em atenção que, se estiver ativado, o algoritmo de carregamento com eficiência de memória não será utilizado porque a computação do hash MD5 necessita de blocos inteiros de memória intermédia e, ao fazê-lo, derrota o objetivo do algoritmo com eficiência de memória.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. Se especificado, download_blob só é bem-sucedido se a concessão do blob estiver ativa e corresponder a este ID. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades na versão 12.4.0.

cpk: CustomerProvidedEncryptionKey

Encripta os dados do lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser efetuada através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

max_concurrency: int

O número de ligações paralelas para transferir.

encoding: str

Codificar para descodificar os bytes transferidos. A predefinição é Nenhuma, ou seja, sem descodificação.

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

Uma chamada de retorno para monitorizar o progresso de uma transferência de execução prolongada. A assinatura é a função (atual: int, total: int) em que atual é o número de bytes transferidos até agora e o total é o tamanho total da transferência.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui. Este 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.

Devoluções

Um objeto de transmissão em fluxo (StorageStreamDownloader)

Tipo de retorno

StorageStreamDownloader

Devolve Verdadeiro se existir um blob com os parâmetros definidos e devolve Falso caso contrário.

exists(**kwargs: Any) -> bool

Parâmetros

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob para verificar se existe.

timeout: int

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

Devoluções

boolean

Tipo de retorno

bool

Crie BlobClient a partir de um URL de blob. Isto não suporta o URL de blob personalizado 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

Necessário

O URL de ponto final completo para o Blob, incluindo o token de SAS e o instantâneo, se utilizado. Este pode ser o ponto final primário ou o ponto final secundário, dependendo da location_mode atual.

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

valor predefinido: None

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

exceto no caso do AzureSasCredential, em que os tokens SAS em conflito gerarão um ValueError. Se utilizar uma instância do AzureNamedKeyCredential, "name" deve ser o nome da conta de armazenamento e "chave" deve ser a chave da conta de armazenamento.

snapshot: str

valor predefinido: None

O instantâneo de blob opcional no qual pretende operar. Pode ser a cadeia de ID do instantâneo ou a resposta devolvida a partir de create_snapshot. Se for especificado, isto substituirá o instantâneo no URL.

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob a operar.

Devoluções

Um cliente Blob.

Tipo de retorno

BlobClient

Crie BlobClient a partir de uma Cadeia de Ligaçã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

Necessário

Uma cadeia de ligação a uma conta de Armazenamento do Azure.

container_name: str

Necessário

O nome do contentor do blob.

blob_name: str

Necessário

O nome do blob com o qual pretende interagir.

snapshot: str

valor predefinido: None

O instantâneo de blob opcional no qual pretende operar. Pode ser a cadeia de ID do instantâneo ou a resposta devolvida a partir de create_snapshot.

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

valor predefinido: None

As credenciais com as quais se autenticar. Isto é opcional se o URL da conta já tiver um token de SAS ou se o cadeia de ligação já tiver valores de chave de acesso partilhados. O valor pode ser uma cadeia de token de SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential a partir de azure.core.credentials, uma chave de acesso partilhada de conta ou uma instância de uma classe TokenCredentials a partir de azure.identity. As credenciais aqui fornecidas terão precedência sobre as credenciais na cadeia de ligação. Se utilizar uma instância do AzureNamedKeyCredential, "name" deve ser o nome da conta de armazenamento e "chave" deve ser a chave da conta de armazenamento.

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob a operar.

Devoluções

Um cliente Blob.

Tipo de retorno

BlobClient

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

As informações também podem ser obtidas se o utilizador tiver uma SAS para um contentor ou blob. As chaves no dicionário devolvido incluem "sku_name" e "account_kind".

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

Devoluções

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

Tipo de retorno

dict(str, str)

Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o blob. Não devolve o conteúdo do blob.

get_blob_properties(**kwargs: Any) -> BlobProperties

Parâmetros

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob para obter propriedades.

Novidade na versão 12.4.0.

Este argumento de palavra-chave foi introduzido na versão de API "2019-12-12".

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

timeout: int

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

Devoluções

BlobProperties

Tipo de retorno

BlobProperties

A operação Obter Etiquetas permite que os utilizadores obtenham etiquetas num blob ou versão de blob específica ou instantâneo.

Novidade na versão 12.4.0: esta operação foi introduzida na versão de API "2019-12-12".

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

Parâmetros

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob à qual adicionar etiquetas.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob de destino com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

timeout: int

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

Devoluções

Pares chave-valor de etiquetas de blob.

Tipo de retorno

Dict[str, str]

A operação Obter Lista de Blocos obtém 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

Necessário

Especifica se pretende devolver a lista de blocos consolidados, a lista de blocos não consolidados ou ambas as listas em conjunto. Os valores possíveis incluem: "consolidado", "não consolidado", "tudo"

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob de destino com um valor correspondente.

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Uma cadeia de identificação de duas listas - blocos consolidados e não consolidados

Tipo de retorno

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

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

Nota

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

Novidade na versão 12.2.0: esta 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

Necessário

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

offset: int

Necessário

Início do intervalo de bytes a utilizar para obter intervalos de página válidos. Se não for dado nenhum comprimento, todos os bytes após o desvio serão pesquisados. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um modulus de 512 e o comprimento tem de ser um modulus de 512.

length: int

Necessário

Número de bytes a utilizar para obter intervalos de página válidos. Se for dado um comprimento, tem de ser fornecido um desvio. Este intervalo irá devolver intervalos de página válidos desde o início do deslocamento até ao comprimento especificado. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um modulus de 512 e o comprimento tem de ser um modulus de 512.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

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

Tipo de retorno

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

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

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

Necessário

Início do intervalo de bytes a utilizar para obter intervalos de página válidos. Se não for dado nenhum comprimento, todos os bytes após o desvio serão pesquisados. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um modulus de 512 e o comprimento tem de ser um modulus de 512.

length: int

Necessário

Número de bytes a utilizar para obter intervalos de página válidos. Se for dado um comprimento, tem de ser fornecido um desvio. Este intervalo irá devolver intervalos de página válidos desde o início do deslocamento até ao comprimento especificado. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um modulus de 512 e o comprimento tem de ser um modulus de 512.

previous_snapshot_diff: str

Necessário

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

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

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

Tipo de retorno

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

Devolve a lista de intervalos de página válidos para um Blob de Página ou instantâneo de um blob de página. 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 utilizar para obter intervalos de página válidos. Se não for dado nenhum comprimento, todos os bytes após o desvio serão pesquisados. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um modulus de 512 e o comprimento tem de ser um modulus de 512.

length: int

Número de bytes a utilizar para obter intervalos de página válidos. Se for dado um comprimento, tem de ser fornecido um desvio. Este intervalo irá devolver intervalos de página válidos desde o início do deslocamento até ao comprimento especificado. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um modulus de 512 e o comprimento tem de ser um modulus de 512.

previous_snapshot: str ou Dict[str, Any]

Um valor de instantâneo que especifica que a resposta conterá apenas páginas que foram alteradas entre o blob de destino e o instantâneo anterior. 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

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades na versão 12.4.0.

results_per_page: int

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

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

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

Tipo de retorno

ItemPaged[PageRange]

Permite que os utilizadores selecionem/projectem dados de instantâneos de blobs/ou blobs ao fornecer expressões de consulta simples. Estas operações devolvem um BlobQueryReader, os utilizadores têm de utilizar readall() ou readinto() para obter dados de consulta.

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

Parâmetros

query_expression: str

Necessário

Obrigatório. uma instrução de consulta. Para obter mais detalhes, veja 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 devolvidos pelo serviço.

blob_format: DelimitedTextDialect ou DelimitedJsonDialect ou QuickQueryDialect ou str

Opcional. Define a serialização dos dados atualmente armazenados no blob. A predefinição é tratar os dados de blobs como dados CSV formatados no dialeto predefinido. Isto pode ser substituído por um DelimitadoTextDialect personalizado ou DelimitedJsonDialect ou "ParquetDialect" (transmitido como uma cadeia ou enum). Estes dialetos podem ser transmitidos pelas respetivas classes, pela enum quickQueryDialect ou como uma cadeia de carateres

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 predefinição, os dados serão devolvidos, uma vez que são representados no blob (os formatos Parquet são predefinidos como DelimitedTextDialect). Ao fornecer um formato de saída, os dados do blob serão reformatados de acordo com esse perfil. Este valor pode ser delimitadoTextDialect ou DelimitedJsonDialect ou ArrowDialect. Estes dialetos podem ser transmitidos pelas respetivas classes, pela enum quickQueryDialect ou como uma cadeia de carateres

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades na versão 12.4.0.

cpk: CustomerProvidedEncryptionKey

Encripta os dados do lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser efetuada através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Um objeto de transmissão em fluxo (BlobQueryReader)

Tipo de retorno

BlobQueryReader

Redimensiona um blob de página para o tamanho especificado.

Se o valor especificado for inferior ao tamanho atual do blob, todas as páginas acima do valor especificado serão desmarcadas.

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

Parâmetros

size: int

Necessário

Tamanho utilizado para redimensionar o blob. O tamanho máximo de um blob de páginas é de até 1 TB. O tamanho do blob de página tem de estar alinhado com um limite de 512 bytes.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades na versão 12.4.0.

premium_page_blob_tier: PremiumPageBlobTier

Um valor de camada de blob de página para definir o blob como. A camada está correlacionada com o tamanho do blob e o número de IOPS permitidos. Isto 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação).

Tipo de retorno

dict(str, Any)

A operação Selar sela o Blob de Acréscimo para torná-lo só de leitura.

Novidades na versão 12.4.0.

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

Parâmetros

appendpos_condition: int

Cabeçalho condicional opcional, utilizado apenas para a operação Bloco de Acréscimo. Um número que indica o desvio de bytes a comparar. O Bloco de Acréscimo só será bem-sucedido se a posição de acréscimo for igual a este número. Se não estiver, o pedido falhará com o erro AppendPositionConditionNotMet (código de estado HTTP 412 – Falha na Pré-condição).

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag, última modificação, desvio de acréscimo, contagem de blocos consolidada).

Tipo de retorno

dict(str, Any)

Define os metadados definidos pelo utilizador 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)

Necessário

Dict contendo pares de nomes e valores. Cada chamada para esta operação substitui todos os metadados existentes anexados ao blob. Para remover todos os metadados do blob, chame esta operação sem cabeçalhos de metadados.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades na versão 12.4.0.

cpk: CustomerProvidedEncryptionKey

Encripta os dados do lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser efetuada através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidades 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação)

A operação Definir Etiquetas permite que os utilizadores definam etiquetas num blob ou numa versão específica do blob, mas não num instantâneo. Cada chamada para esta operação substitui todas as etiquetas existentes anexadas ao blob. Para remover todas as etiquetas do blob, chame esta operação sem etiquetas definidas.

Novidade na versão 12.4.0: esta operação foi introduzida na versão da API "2019-12-12".

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

Parâmetros

tags: dict(str, str)

Necessário

Pares nome-valor associados ao blob como etiqueta. As etiquetas são sensíveis às maiúsculas e minúsculas. O conjunto de etiquetas pode conter, no máximo, 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres e os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave de etiqueta e valor válidos incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), subtração (-), ponto (.), solidus (/), dois pontos (:), igual a (=), caráter de sublinhado (_)

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob a que deve adicionar etiquetas.

validate_content: bool

Se for verdadeiro, calcula um hash MD5 do conteúdo das etiquetas. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https, como https (a predefinição), já irá validar. Note que este Hash MD5 não está armazenado com a bolha.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob de destino com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação)

Tipo de retorno

Dict[str, Any]

Define as propriedades do sistema no blob.

Se uma propriedade estiver 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

Necessário

Objeto ContentSettings utilizado para definir propriedades de blobs. Utilizado para definir o tipo de conteúdo, codificação, idioma, disposição, md5 e controlo de cache.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidades 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação)

Tipo de retorno

Dict[str, Any]

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

Novidade na versão 12.10.0: esta operação foi introduzida na versão da API "2020-10-02".

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

Parâmetros

immutability_policy: ImmutabilityPolicy

Necessário

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

Novidade na versão 12.10.0: foi introduzida na versão da API "2020-10-02".

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Pares de valores chave de etiquetas de blob.

Tipo de retorno

Dict[str, str]

A operação Set Legal Hold define uma retenção legal no blob.

Novidade na versão 12.10.0: esta operação foi introduzida na versão de API "2020-10-02".

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

Parâmetros

legal_hold: bool

Necessário

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

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Pares chave-valor de etiquetas de blob.

Tipo de retorno

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

Define as camadas de blob de páginas no blob. Esta API só é suportada 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

Necessário

Um valor de camada de blob de páginas para definir o blob como. A camada está correlacionada com o tamanho do blob e o número de IOPS permitidos. Isto 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 nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

Tipo de retorno

None

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

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

Necessário

Esta 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

Necessário

Esta propriedade define o número de sequência do blob. O número de sequência é uma propriedade controlada pelo utilizador que pode utilizar para controlar pedidos e gerir problemas de simultaneidade.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação).

Tipo de retorno

dict(str, Any)

Esta operação define a camada num blob de blocos.

A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. Esta 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

Necessário

Indica a camada a definir no blob. As opções incluem "Frequente", "Esporádico", "Arquivo". A camada de acesso frequente está otimizada para armazenar dados que são acedidos com frequência. A camada de armazenamento esporádico está otimizada para armazenar dados que são acedidos e armazenados com pouca frequência durante, pelo menos, um mês. A camada de arquivo está otimizada para armazenar dados que raramente são acedidos e armazenados durante pelo menos seis meses com requisitos de latência flexíveis.

rehydrate_priority: RehydratePriority

Indica a prioridade com a qual reidratar um blob arquivado

version_id: str

O parâmetro ID da versão é um valor dateTime opaco que, quando presente, especifica a versão do blob a transferir.

Novidade na versão 12.4.0.

Este argumento de palavra-chave foi introduzido na versão de API "2019-12-12".

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

Tipo de retorno

None

Cria um novo bloco a ser consolidado 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

Necessário

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

data

Necessário

Os dados do blob.

length: int

Necessário

Tamanho do bloco.

validate_content: bool

Se for verdadeiro, calcula um hash MD5 para cada segmento do blob. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https, como https (a predefinição), já for validada. Note que este Hash MD5 não está armazenado com a bolha. Tenha também em atenção que, se estiver ativado, o algoritmo de carregamento com eficiência de memória não será utilizado porque a computação do hash MD5 requer a colocação em memória intermédia de blocos inteiros e, ao fazê-lo, irá derrotar a finalidade do algoritmo com eficiência de memória.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

encoding: str

A predefinição é UTF-8.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Dict da propriedade blob.

Tipo de retorno

dict[str, Any]

Cria um novo bloco a ser consolidado como parte de um blob onde os conteúdos são lidos a partir de um 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

Necessário

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

source_url: str

Necessário

O URL.

source_offset: int

Necessário

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

source_length: int

Necessário

O tamanho do bloco em bytes.

source_content_md5: bytearray

Necessário

Especifique o md5 calculado para o intervalo de bytes que têm de ser lidos a partir da origem de cópia.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

cpk: CustomerProvidedEncryptionKey

Encripta os dados do lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser efetuada através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidades 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

source_authorization: str

Autenticar como principal de serviço utilizando um segredo de cliente para aceder a um blob de origem. Certifique-se de que "portador" é o prefixo da cadeia de source_authorization.

Devoluções

Dict da propriedade blob.

Tipo de retorno

dict[str, Any]

Copia um blob do URL especificado.

Esta operação devolve um dicionário que contém copy_status e copy_id, que podem ser utilizados para verificar o estado ou abortar a operação de cópia. copy_status será "bem-sucedida" 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 estado pode ser verificado consultando o get_blob_properties método e verificando o estado da cópia. Defina requires_sync como Verdadeiro para forçar a cópia a ser síncrona. O serviço Blob copia os blobs com base no melhor esforço.

O blob de origem para 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, tem de ser do mesmo tipo de blob que o blob de origem. Qualquer blob de destino existente será substituído. Não é possível modificar o blob de destino enquanto estiver em curso uma operação de cópia.

Ao copiar de um blob de páginas, o serviço Blob cria um blob de página de destino do comprimento do blob de origem, inicialmente contendo todos os zeros. Em seguida, os intervalos de páginas de origem são enumerados 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 consolidado de comprimento zero antes de regressar desta operação. Ao copiar de um blob de blocos, todos os blocos consolidados e os respetivos IDs de bloco são copiados. Os blocos não consolidados não são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos consolidada que a origem.

Ao copiar de um blob de acréscimo, todos os blocos consolidados são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos consolidada 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

Necessário

Um URL com até 2 KB de comprimento que especifica um ficheiro ou blob. O valor deve ser codificado por URL, uma vez que apareceria num URI de pedido. Se a origem estiver noutra conta, a origem tem de ser pública ou tem de ser autenticada através de uma assinatura de acesso partilhado. Se a origem for pública, não é necessária autenticação. Exemplos: https://myaccount.blob.core.windows.net/mycontainer/myblob

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

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

metadata: dict(str, str)

Necessário

Pares nome-valor associados ao blob como metadados. Se não forem especificados pares nome-valor, a operação copiará os metadados do blob ou ficheiro de origem para o blob de destino. Se forem especificados um ou mais pares name-value, o blob de destino é criado com os metadados especificados e os metadados não são copiados do blob ou ficheiro de origem.

incremental_copy: bool

Necessário

Copia o instantâneo do blob da página de origem para um blob de página de destino. O instantâneo é copiado de modo a que apenas as alterações diferenciais entre o instantâneo copiado 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 como habitualmente. Predefinições para Falso.

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

Pares nome-valor associados ao blob como etiqueta. As etiquetas são sensíveis às maiúsculas e minúsculas. O conjunto de etiquetas pode conter, no máximo, 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres e os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave de etiqueta e valor válidos incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), subtração (-), ponto (.), solidus (/), dois pontos (:), igual a (=), caráter de sublinhado (_).

Em vez disso, o literal "COPY" (sensível às maiúsculas e minúsculas) pode ser transmitido para copiar etiquetas do blob de origem. Esta opção só está disponível quando incremental_copy=Falso e requires_sync=Verdadeiro.

Novidades na versão 12.4.0.

immutability_policy: ImmutabilityPolicy

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

Novidade na versão 12.10.0: foi introduzida na versão da API "2020-10-02".

legal_hold: bool

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

Novidade na versão 12.10.0: foi introduzida na versão da API "2020-10-02".

source_if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho condicional para copiar o blob apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho condicional para copiar o blob apenas se o blob de origem não tiver sido modificado desde a data/hora especificada.

source_etag: str

O valor ETag de origem ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho condicional para copiar o blob apenas 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 devolve o código de estado 412 (Falha na Pré-condição).

if_unmodified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho condicional para copiar o blob apenas 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 devolve o código de estado 412 (Falha na Pré-condição).

etag: str

O valor ETag de destino ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

destination_lease: BlobLeaseClient ou str

O ID de concessão especificado para este cabeçalho tem de corresponder ao ID de concessão do blob de destino. Se o pedido não incluir o ID de concessão ou não for válido, a operação falhará com o código de estado 412 (Falha na Pré-condição).

source_lease: BlobLeaseClient ou str

Especifique esta opção para efetuar a operação Copiar Blob apenas se o ID de concessão fornecido corresponder ao ID de concessão ativo do blob de origem.

timeout: int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é monitorizado nem validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

premium_page_blob_tier: PremiumPageBlobTier

Um valor de camada de blob de página para definir o blob como. A camada está correlacionada com o tamanho do blob e o número de IOPS permitidos. Isto só é aplicável a blobs de páginas em contas de armazenamento premium.

standard_blob_tier: StandardBlobTier

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

rehydrate_priority: RehydratePriority

Indica a prioridade para reidratar um blob arquivado

seal_destination_blob: bool

Selar o blob de acréscimo de destino. Esta operação destina-se apenas ao blob de acréscimo.

Novidades na versão 12.4.0.

requires_sync: bool

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

source_authorization: str

Autenticar como principal de serviço utilizando um segredo de cliente para aceder a um blob de origem. Certifique-se de que "portador" é o prefixo da cadeia de source_authorization. Esta opção só está disponível quando incremental_copy está definida como Falso e requires_sync está definida como Verdadeiro.

Novidade na versão 12.9.0.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no blob copiado de sincronização. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidades na versão 12.10.0.

Devoluções

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

Tipo de retorno

dict[str, Union[str, datetime]]

Restaura instantâneos ou blobs eliminados de forma recuperável.

A operação só será efetuada com êxito se for utilizada no número especificado de dias definido na política de retenção de eliminação.

Se o controlo de versões de blobs estiver ativado, o blob base não pode ser restaurado com este método. Em vez disso, utilize start_copy_from_url com o URL da versão do blob que pretende 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Tipo de retorno

None

Cria um novo blob a partir de uma origem de dados com segmentação automática.

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

Parâmetros

data

Necessário

Os dados do blob a carregar.

blob_type: BlobType

Necessário

O tipo do blob. Pode ser BlockBlob, PageBlob ou AppendBlob. O valor predefinido é BlockBlob.

length: int

Necessário

Número de bytes a ler a partir da transmissão em fluxo. Isto é opcional, mas deve ser fornecido para um desempenho ideal.

metadata: dict(str, str)

Necessário

Pares nome-valor associados ao blob como metadados.

tags: dict(str, str)

Pares nome-valor associados ao blob como etiqueta. As etiquetas são sensíveis às maiúsculas e minúsculas. O conjunto de etiquetas pode conter, no máximo, 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres e os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave e valor de etiqueta válidos incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), subtração (-), ponto (.), solidus (/), dois pontos (:), igual a (=), caráter de sublinhado (_)

Novidade na versão 12.4.0.

overwrite: bool

Se o blob a carregar deve substituir os dados atuais. Se for Verdadeiro, upload_blob substituirá os dados existentes. Se estiver definida como Falso, a operação falhará com ResourceExistsError. A exceção ao acima é com os tipos de blob Acrescentar: se definido como Falso e os dados já existirem, não será gerado um erro e os dados serão anexados ao blob existente. Se definir overwrite=True, o blob de acréscimo existente será eliminado e será criado um novo. A predefinição é Falso.

content_settings: ContentSettings

Objeto ContentSettings utilizado para definir propriedades do blob. Utilizado para definir o tipo de conteúdo, codificação, idioma, disposição, md5 e controlo de cache.

validate_content: bool

Se for verdadeiro, calcula um hash MD5 para cada segmento do blob. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https, como https (a predefinição), já for validada. Note que este Hash MD5 não está armazenado com a bolha. Tenha também em atenção que, se estiver ativado, o algoritmo de carregamento com eficiência de memória não será utilizado porque a computação do hash MD5 requer a colocação em memória intermédia de blocos inteiros e, ao fazê-lo, irá derrotar a finalidade do algoritmo com eficiência de memória.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. Se especificado, upload_blob só será bem-sucedido se a concessão do blob estiver ativa e corresponder a este ID. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

premium_page_blob_tier: PremiumPageBlobTier

Um valor de camada de blob de páginas para definir o blob como. A camada está correlacionada com o tamanho do blob e o número de IOPS permitidos. Isto 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 definir o blob como. Para esta versão da biblioteca, isto 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, este parâmetro da API upload_blob() destina-se apenas a BlockBlob.

Novidade na versão 12.10.0: foi introduzida na versão de API "2020-10-02".

legal_hold: bool

Especificado se deve ser definida uma retenção legal no blob. Atualmente, este parâmetro da API upload_blob() destina-se apenas a BlockBlob.

Novidade na versão 12.10.0: foi introduzida 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 Acrescentar 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, o pedido falhará com o erro MaxBlobSizeConditionNotMet (código de estado HTTP 412 – Falha na Pré-condição).

max_concurrency: int

Número máximo de ligações paralelas a utilizar quando o tamanho do blob exceder os 64 MB.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade na versão 12.2.0.

encoding: str

A predefinição é UTF-8.

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

Uma chamada de retorno para controlar o progresso de um carregamento de execução prolongada. A assinatura é função(atual: int, total: opcional[int]) em que atual é o número de bytes transferidos até agora e o total é o tamanho do blob ou Nenhum se o tamanho for desconhecido.

timeout: int

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

Devoluções

Dict da propriedade atualizada com blobs (Etag e última modificação)

Tipo de retorno

dict[str, Any]

Cria um novo Blob de Blocos onde o conteúdo do blob é lido a partir de um determinado 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

Necessário

Um URL com até 2 KB de comprimento que especifica um ficheiro ou blob. O valor deve ser codificado com URL, tal como apareceria num URI de pedido. Se a origem estiver noutra conta, a origem tem de ser pública ou ter de ser autenticada através de uma assinatura de acesso partilhado. Se a origem for pública, não é necessária autenticação. Exemplos: https://myaccount.blob.core.windows.net/mycontainer/myblob

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

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

overwrite: bool

Se o blob a carregar deve substituir os dados atuais. Se for Verdadeiro, upload_blob substituirá os dados existentes. Se estiver definida como Falso, a operação falhará com ResourceExistsError.

include_source_blob_properties: bool

Indica se as propriedades do blob de origem devem ser copiadas. A predefinição é Verdadeiro.

tags: dict(str, str)

Pares nome-valor associados ao blob como etiqueta. As etiquetas são sensíveis às maiúsculas e minúsculas. O conjunto de etiquetas pode conter, no máximo, 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres e os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave e valor de etiqueta válidos incluem: letras minúsculas e maiúsculas, dígitos (0-9), espaço ( >><<), mais (+), subtração (-), ponto (.), solidus (/), dois pontos (:), igual a (=), caráter de sublinhado (_)

source_content_md5: bytearray

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

source_if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso de origem não tiver sido modificado desde a data/hora especificada.

source_etag: str

O valor ETag de origem ou o caráter universal (*). Utilizado para verificar 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 utilizar na etag.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

O valor ETag de destino ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

destination_lease: BlobLeaseClient ou str

O ID de concessão especificado para este cabeçalho tem de corresponder ao ID de concessão do blob de destino. Se o pedido não incluir o ID de concessão ou não for válido, a operação falhará com o código de estado 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

content_settings: ContentSettings

Objeto ContentSettings utilizado para definir propriedades do blob. Utilizado para definir o tipo de conteúdo, codificação, idioma, disposição, md5 e controlo de cache.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

standard_blob_tier: StandardBlobTier

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

source_authorization: str

Autenticar como principal de serviço com um segredo do cliente para aceder a um blob de origem. Certifique-se de que "portador" é o prefixo da cadeia de source_authorization.

A operação Carregar Páginas escreve um intervalo de páginas num blob de páginas.

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

Parâmetros

page: bytes

Necessário

Conteúdo da página.

offset: int

Necessário

Início do intervalo de bytes a utilizar para escrever numa secção do blob. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um módulo de 512 e o comprimento tem de ser um módulo de 512.

length: int

Necessário

Número de bytes a utilizar para escrever numa secção do blob. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um módulo de 512 e o comprimento tem de ser um módulo de 512.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

validate_content: bool

Se for verdadeiro, calcula um hash MD5 do conteúdo da página. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https, como https (a predefinição), já for validada. Note que este Hash MD5 não está armazenado com a bolha.

if_sequence_number_lte: int

Se o número de sequência do blob for menor ou igual ao valor especificado, o pedido prossegue; caso contrário, falha.

if_sequence_number_lt: int

Se o número de sequência do blob for menor do que o valor especificado, o pedido prossegue; caso contrário, falha.

if_sequence_number_eq: int

Se o número de sequência do blob for igual ao valor especificado, o pedido prossegue; caso contrário, falha.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

Um valor ETag ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade na versão 12.2.0.

encoding: str

A predefinição é UTF-8.

timeout: int

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

Devoluções

Dict de propriedades atualizadas por blobs (Etag e última modificação).

Tipo de retorno

dict(str, Any)

A operação Carregar Páginas escreve um intervalo de páginas num blob de páginas onde os conteúdos são lidos a partir de um URL.

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

Parâmetros

source_url: str

Necessário

O URL dos dados de origem. Pode apontar para qualquer Blob ou Ficheiro do Azure, que seja público ou tenha uma assinatura de acesso partilhado anexada.

offset: int

Necessário

Início do intervalo de bytes a utilizar para escrever numa secção do blob. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um módulo de 512 e o comprimento tem de ser um módulo de 512.

length: int

Necessário

Número de bytes a utilizar para escrever numa secção do blob. As páginas têm de estar alinhadas com limites de 512 bytes, o desvio inicial tem de ser um módulo de 512 e o comprimento tem de ser um módulo de 512.

source_offset: int

Necessário

Isto indica o início do intervalo de bytes(inclusive) que tem de ser retirado da origem de cópia. O serviço irá ler o mesmo número de bytes que o intervalo de destino (desvio de comprimento).

source_content_md5: bytes

Se for indicado, o serviço calculará o hash MD5 do conteúdo do bloco e comparará com este valor.

source_if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso de origem não tiver sido modificado desde a data/hora especificada.

source_etag: str

O valor ETag de origem ou o caráter universal (*). Utilizado para verificar 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 utilizar na etag.

lease: BlobLeaseClient ou str

Necessário se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_sequence_number_lte: int

Se o número de sequência do blob for menor ou igual ao valor especificado, o pedido prossegue; caso contrário, falha.

if_sequence_number_lt: int

Se o número de sequência do blob for menor do que o valor especificado, o pedido prossegue; caso contrário, falha.

if_sequence_number_eq: int

Se o número de sequência do blob for igual ao valor especificado, o pedido prossegue; caso contrário, falha.

if_modified_since: datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas 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 transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag: str

O valor ETag de destino ou o caráter universal (*). Utilizado para verificar 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 utilizar no etag.

if_tags_match_condition: str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

cpk: CustomerProvidedEncryptionKey

Encripta os dados no lado do serviço com a chave especificada. A utilização de chaves fornecidas pelo cliente tem de ser feita através de HTTPS. Como a própria chave de encriptação é fornecida no pedido, tem de ser estabelecida uma ligação segura para transferir a chave.

encryption_scope: str

Um âmbito de encriptação predefinido utilizado para encriptar os dados no serviço. Um âmbito de encriptação pode ser criado com a API de Gestão e referenciado aqui pelo nome. Se tiver sido definido um âmbito de encriptação predefinido no contentor, este valor irá substitui-lo se o âmbito ao nível do contentor estiver configurado para permitir substituições. Caso contrário, será gerado um erro.

Novidade 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 detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

source_authorization: str

Autenticar como principal de serviço com um segredo do cliente para aceder a um blob de origem. Certifique-se de que "portador" é o prefixo da cadeia de source_authorization.

A versão da API de Armazenamento utilizada para pedidos.

O modo de localização que o cliente está a utilizar atualmente.

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

O URL do ponto final primário completo.

O nome do anfitrião do ponto final primário.

O URL completo do ponto final secundário, se configurado.

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

Exceções

ValueError

O nome do anfitrião do ponto final secundário.

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

O URL de ponto final completo para esta entidade, incluindo o token de SAS, se utilizado.

Este pode ser o ponto final principal ou o ponto final secundário, dependendo do atual location_mode. :returns: o URL de ponto final completo para esta entidade, incluindo o token SAS, se utilizado. :rtype: str

abort_copy	Abortar uma operação de cópia em curso. Isto irá deixar um blob de destino com comprimento zero e metadados completos. Isto irá gerar um erro se a operação de cópia já tiver terminado.
acquire_lease	Pede uma nova concessão. Se o blob não tiver uma concessão ativa, o Serviço de Blobs cria uma concessão no blob e devolve uma nova concessão.
append_block	Consolida um novo bloco de dados no final do blob de acréscimo existente.
append_block_from_url	Cria um novo bloco a ser consolidado como parte de um blob, onde os conteúdos são lidos a partir de um URL de origem.
clear_page	Limpa um intervalo de páginas.
close	Este método consiste em fechar os sockets abertos pelo cliente. Não é necessário utilizá-la ao utilizar com um gestor de contexto.
commit_block_list	A operação Consolidar Lista de Blocos escreve um blob ao especificar a lista de IDs de bloco que compõem o blob.
create_append_blob	Cria um novo Blob de Acréscimo. Esta operação cria um novo blob de acréscimo de 0 comprimentos. 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 com o tamanho especificado.
create_snapshot	Cria um instantâneo do blob. Um instantâneo é uma versão só de leitura de um blob que é tirada num momento. Pode ser lido, copiado ou eliminado, mas não modificado. Os instantâneos fornecem uma forma de criar uma cópia de segurança de um blob, tal como aparece num momento no tempo. Um instantâneo de um blob tem o mesmo nome que o blob base a partir do qual o instantâneo é tirado, com um valor DateTime anexado para indicar a hora em que o instantâneo foi tirado.
delete_blob	Marca o blob especificado para eliminação. O blob é posteriormente eliminado durante a recolha de lixo. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação delete_blob(). Se uma política de retenção de eliminação estiver ativada para o serviço, esta operação elimina o blob e mantém o blob durante 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 recolha da memória. O blob eliminado de forma recuperável é acessível através list_blobs da especificação da opção include=['deleted' ]. O blob eliminado de forma recuperável pode ser restaurado através <xref:azure.storage.blob.undelete> da operação.
delete_immutability_policy	A operação Eliminar Política de Imutabilidade elimina a política de imutabilidade no blob. Novidade na versão 12.10.0: esta operação foi introduzida na versão da API "2020-10-02".
download_blob	Transfere um blob para o StorageStreamDownloader. O método readall() tem de ser utilizado para ler todo o conteúdo ou o método readinto() tem de ser utilizado para transferir o blob para um fluxo. A utilização de segmentos() devolve um iterador que permite ao utilizador iterar sobre o conteúdo em segmentos.
exists	Devolve Verdadeiro se existir um blob com os parâmetros definidos e devolve Falso caso contrário.
from_blob_url	Crie BlobClient a partir de um URL de blob. Isto não suporta o URL de blob personalizado com "/" no nome do blob.
from_connection_string	Crie BlobClient a partir de uma Cadeia de Ligação.
get_account_information	Obtém informações relacionadas com a conta de armazenamento na qual o blob reside. As informações também podem ser obtidas se o utilizador tiver uma SAS para um contentor ou blob. As chaves no dicionário devolvido incluem "sku_name" e "account_kind".
get_blob_properties	Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o blob. Não devolve o conteúdo do blob.
get_blob_tags	A operação Obter Etiquetas permite que os utilizadores obtenham etiquetas num blob ou versão de blob específica ou instantâneo. Novidade na versão 12.4.0: esta operação foi introduzida na versão de API "2019-12-12".
get_block_list	A operação Obter Lista de Blocos obtém a lista de blocos que foram carregados como parte de um blob de blocos.
get_page_range_diff_for_managed_disk	Devolve a lista de intervalos de página válidos para um disco ou instantâneo gerido. Nota Esta operação só está disponível para contas de disco gerido. Novidade na versão 12.2.0: esta operação foi introduzida na versão da API "2019-07-07".
get_page_ranges	PRETERIDO: devolve a lista de intervalos de página válidos para um Blob de Páginas ou instantâneo de um blob de página.
list_page_ranges	Devolve a lista de intervalos de página válidos para um Blob de Página ou instantâneo de um blob de página. 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 utilizadores selecionem/projectem dados de instantâneos de blobs/ou blobs ao fornecer expressões de consulta simples. Estas operações devolvem um BlobQueryReader, os utilizadores têm de utilizar readall() ou readinto() para obter dados de consulta.
resize_blob	Redimensiona um blob de página para o tamanho especificado. Se o valor especificado for inferior ao tamanho atual do blob, todas as páginas acima do valor especificado serão desmarcadas.
seal_append_blob	A operação Selar sela o Blob de Acréscimo para torná-lo só de leitura. Novidades na versão 12.4.0.
set_blob_metadata	Define os metadados definidos pelo utilizador para o blob como um ou mais pares nome-valor.
set_blob_tags	A operação Definir Etiquetas permite que os utilizadores definam etiquetas num blob ou numa versão específica do blob, mas não num instantâneo. Cada chamada para esta operação substitui todas as etiquetas existentes anexadas ao blob. Para remover todas as etiquetas do blob, chame esta operação sem etiquetas definidas. Novidade na versão 12.4.0: esta operação foi introduzida na versão da API "2019-12-12".
set_http_headers	Define as propriedades do sistema no blob. Se uma propriedade estiver 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. Novidade na versão 12.10.0: esta operação foi introduzida na versão da API "2020-10-02".
set_legal_hold	A operação Set Legal Hold define uma retenção legal no blob. Novidade na versão 12.10.0: esta operação foi introduzida na versão de API "2020-10-02".
set_premium_page_blob_tier	Define as camadas de blob de páginas no blob. Esta API só é suportada para blobs de páginas em contas premium.
set_sequence_number	Define o número da sequência de blobs.
set_standard_blob_tier	Esta operação define a camada num blob de blocos. A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. Esta operação não atualiza a ETag do blob.
stage_block	Cria um novo bloco a ser consolidado como parte de um blob.
stage_block_from_url	Cria um novo bloco a ser consolidado como parte de um blob onde os conteúdos são lidos a partir de um URL.
start_copy_from_url	Copia um blob do URL especificado. Esta operação devolve um dicionário que contém copy_status e copy_id, que podem ser utilizados para verificar o estado ou abortar a operação de cópia. copy_status será "bem-sucedida" 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 estado pode ser verificado consultando o get_blob_properties método e verificando o estado da cópia. Defina requires_sync como Verdadeiro para forçar a cópia a ser síncrona. O serviço Blob copia os blobs com base no melhor esforço. O blob de origem para 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, tem de ser do mesmo tipo de blob que o blob de origem. Qualquer blob de destino existente será substituído. Não é possível modificar o blob de destino enquanto estiver em curso uma operação de cópia. Ao copiar de um blob de páginas, o serviço Blob cria um blob de página de destino do comprimento do blob de origem, inicialmente contendo todos os zeros. Em seguida, os intervalos de páginas de origem são enumerados 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 consolidado de comprimento zero antes de regressar desta operação. Ao copiar de um blob de blocos, todos os blocos consolidados e os respetivos IDs de bloco são copiados. Os blocos não consolidados não são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos consolidada que a origem. Ao copiar de um blob de acréscimo, todos os blocos consolidados são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos consolidada que a origem.
undelete_blob	Restaura instantâneos ou blobs eliminados de forma recuperável. A operação só será efetuada com êxito se for utilizada no número especificado de dias definido na política de retenção de eliminação. Se o controlo de versões de blobs estiver ativado, o blob base não pode ser restaurado com este método. Em vez disso, utilize start_copy_from_url com o URL da versão do blob que pretende promover para a versão atual.
upload_blob	Cria um novo blob a partir de uma origem de dados com segmentação automática.
upload_blob_from_url	Cria um novo Blob de Blocos onde o conteúdo do blob é lido a partir de um determinado URL. O conteúdo de um blob existente é substituído pelo novo blob.
upload_page	A operação Carregar Páginas escreve um intervalo de páginas num blob de páginas.
upload_pages_from_url	A operação Carregar Páginas escreve um intervalo de páginas num blob de páginas onde os conteúdos são lidos a partir de um URL.

Share via

BlobClient Classe

Construtor

Parâmetros

Métodos

abort_copy

Parâmetros

Tipo de retorno

acquire_lease

Parâmetros

Devoluções

Tipo de retorno

append_block

Parâmetros

Devoluções

Tipo de retorno

append_block_from_url

Parâmetros

clear_page

Parâmetros

Devoluções

Tipo de retorno

close

commit_block_list

Parâmetros

Devoluções

Tipo de retorno

create_append_blob

Parâmetros

Devoluções

Tipo de retorno

create_page_blob

Parâmetros

Devoluções

Tipo de retorno

create_snapshot

Parâmetros

Devoluções

Tipo de retorno

delete_blob

Parâmetros

Tipo de retorno

delete_immutability_policy

Parâmetros

Devoluções

Tipo de retorno

download_blob

Parâmetros

Devoluções

Tipo de retorno

exists

Parâmetros

Devoluções

Tipo de retorno

from_blob_url

Parâmetros

Devoluções

Tipo de retorno

from_connection_string

Parâmetros

Devoluções

Tipo de retorno

get_account_information

Devoluções

Tipo de retorno

get_blob_properties

Parâmetros

Devoluções

Tipo de retorno

get_blob_tags

Parâmetros

Devoluções

Tipo de retorno

get_block_list

Parâmetros

Devoluções

Tipo de retorno

get_page_range_diff_for_managed_disk

Parâmetros

Devoluções