ContainerClient Classe

Referência

Um cliente para interagir com um contentor específico, embora esse contentor possa ainda não existir.

Para operações relacionadas com um blob específico neste contentor, um cliente de blobs pode ser obtido com a get_blob_client função .

Para obter mais configuração opcional, clique aqui.

Herança: azure.storage.blob._shared.base_client.StorageAccountHostsMixin

ContainerClient

azure.storage.blob._encryption.StorageEncryptionMixin

ContainerClient

Construtor

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

Parâmetros

account_url: str

Necessário

O URI para a conta de armazenamento. Para criar um cliente com o URI completo no contentor, utilize o from_container_url classmethod.

container_name: str

Necessário

O nome do contentor do blob.

credential

valor predefinido: None

As credenciais com as quais se autenticar. Isto é opcional se o URL da conta já tiver um token de SAS. O valor pode ser uma cadeia de token de SAS, uma instância de uma 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.

api_version: str

A versão da API de Armazenamento a utilizar para pedidos. O valor predefinido é a versão de serviço mais recente compatível com o SDK atual. Definir para uma versão mais antiga pode resultar numa compatibilidade de funcionalidades reduzida.

Novidades na versão 12.2.0.

secondary_hostname: str

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

max_block_size: int

O tamanho máximo do segmento para carregar um blob de blocos em segmentos. A predefinição é 4*1024*1024 ou 4 MB.

max_single_put_size: int

Se o tamanho do blob for menor ou igual a max_single_put_size, o blob será carregado apenas com um pedido HTTP PUT. Se o tamanho do blob for superior a max_single_put_size, o blob será carregado em segmentos. A predefinição é 64*1024*1024 ou 64 MB.

min_large_block_upload_threshold: int

O tamanho mínimo de segmento necessário para utilizar o algoritmo eficiente em termos de memória ao carregar um blob de blocos. A predefinição é 4*1024*1024+1.

use_byte_buffer: bool

Utilize uma memória intermédia de bytes para carregamentos de blobs de blocos. Predefinições para Falso.

max_page_size: int

O tamanho máximo do segmento para carregar um blob de página. A predefinição é 4*1024*1024 ou 4 MB.

max_single_get_size: int

O tamanho máximo para que um blob seja transferido numa única chamada, a parte excedida será transferida em segmentos (pode ser paralela). A predefinição é 32*1024*1024 ou 32 MB.

max_chunk_get_size: int

O tamanho máximo de segmento utilizado para transferir um blob. A predefinição é 4*1024*1024 ou 4 MB.

Métodos

acquire_lease	Pede uma nova concessão. Se o contentor não tiver uma concessão ativa, o serviço Blob cria uma concessão no contentor e devolve um novo ID de concessão.
close	Este método consiste em fechar os sockets abertos pelo cliente. Não é necessário utilizá-lo ao utilizar com um gestor de contexto.
create_container	Cria um novo contentor na conta especificada. Se o contentor com o mesmo nome já existir, a operação falhará.
delete_blob	Marca o blob ou instantâneo 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 de delete_blob. Se uma política de retenção de eliminação estiver ativada para o serviço, esta operação elimina de forma recuperável o blob ou instantâneo e mantém o blob ou instantâneo 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 ou instantâneo eliminado de forma recuperável é acessível através list_blobs da especificação da opção include=["deleted" ]. O blob ou instantâneo eliminado de forma recuperável pode ser restaurado com <xref:azure.storage.blob.BlobClient.undelete>
delete_blobs	Marca os blobs ou instantâneos especificados para eliminação. Os blobs são posteriormente eliminados durante a recolha de lixo. Tenha em atenção que, para eliminar blobs, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação de delete_blobs. Se uma política de retenção de eliminação estiver ativada para o serviço, esta operação elimina suavemente os blobs ou instantâneos e mantém os blobs ou instantâneos para o número especificado de dias. Após o número especificado de dias, os dados dos blobs são removidos do serviço durante a recolha de lixo. Os blobs ou instantâneos eliminados de forma recuperável são acessíveis através list_blobs da especificação de include=["eliminado"] Os blobs ou instantâneos eliminados por forma recuperável podem ser restaurados com <xref:azure.storage.blob.BlobClient.undelete> O número máximo de blobs que podem ser eliminados num único pedido é 256.
delete_container	Marca o contentor especificado para eliminação. O contentor e quaisquer blobs contidos no mesmo são posteriormente eliminados durante a recolha de lixo.
download_blob	Transfere um blob para o StorageStreamDownloader. O método readall() tem de ser utilizado para ler todo o conteúdo ou 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 contentor e devolve Falso de outra forma.
find_blobs_by_tags	Devolve um gerador para listar os blobs no contentor especificado cujas etiquetas correspondem à expressão de pesquisa especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço.
from_connection_string	Crie ContainerClient a partir de uma Cadeia de Ligação.
from_container_url	Crie ContainerClient a partir de um URL de contentor.
get_account_information	Obtém informações relacionadas com a conta de armazenamento. 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_client	Faça com que um cliente interaja com o blob especificado. O blob ainda não precisa de existir.
get_container_access_policy	Obtém as permissões para o contentor especificado. As permissões indicam se os dados de contentor podem ser acedidos publicamente.
get_container_properties	Devolve todas as propriedades de sistema e metadados definidos pelo utilizador para o contentor especificado. Os dados devolvidos não incluem a lista de blobs do contentor.
list_blob_names	Devolve um gerador para listar os nomes dos blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço. Tenha em atenção que não serão devolvidas propriedades ou metadados adicionais ao utilizar esta API. Além disso, esta API não tem a opção de incluir blobs adicionais, como instantâneos, versões, blobs eliminados de forma recuperável, etc. Para obter qualquer um destes dados, utilize list_blobs.
list_blobs	Devolve um gerador para listar os blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço.
set_container_access_policy	Define as permissões para o contentor especificado ou políticas de acesso armazenado que podem ser utilizadas com Assinaturas de Acesso Partilhado. As permissões indicam se os blobs num contentor podem ser acedidos publicamente.
set_container_metadata	Define um ou mais pares nome-valor definidos pelo utilizador para o contentor especificado. Cada chamada para esta operação substitui todos os metadados existentes anexados ao contentor. Para remover todos os metadados do contentor, chame esta operação sem dict de metadados.
set_premium_page_blob_tier_blobs	Define as camadas de blobs de páginas em todos os blobs. Esta API só é suportada para blobs de páginas em contas premium. O número máximo de blobs que podem ser atualizados num único pedido é 256.
set_standard_blob_tier_blobs	Esta operação define a camada em blobs 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. O número máximo de blobs que podem ser atualizados num único pedido é 256.
upload_blob	Cria um novo blob a partir de uma origem de dados com segmentação automática.
walk_blobs	Devolve um gerador para listar os blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço. Esta operação listará os blobs de acordo com uma hierarquia, conforme delimitado pelo caráter delimitador especificado.

acquire_lease

Pede uma nova concessão. Se o contentor não tiver uma concessão ativa, o serviço Blob cria uma concessão no contentor e devolve um novo ID de concessão.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs) -> 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

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

Devoluções

Um objeto BlobLeaseClient, que pode ser executado num gestor de contexto.

Tipo de retorno

BlobLeaseClient

close

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

close()

create_container

Cria um novo contentor na conta especificada. Se o contentor com o mesmo nome já existir, a operação falhará.

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

Parâmetros

metadata: dict[str, str]

Necessário

Um ditado com name_value pares para associar ao contentor como metadados. Exemplo:{'Categoria':'teste'}

public_access: PublicAccess

Necessário

Os valores possíveis incluem: "contentor", "blob".

container_encryption_scope: dict ou ContainerEncryptionScope

Especifica o âmbito de encriptação predefinido a definir no contentor e a utilização para todas as escritas futuras.

Novidades na versão 12.2.0.

timeout: int

Devoluções

Um dicionário de cabeçalhos de resposta.

Tipo de retorno

Dict[str, Union[str, datetime]]

delete_blob

Marca o blob ou instantâneo 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 de delete_blob.

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

delete_blob(blob: str | BlobProperties, delete_snapshots: str | None = None, **kwargs) -> None

Parâmetros

blob: str ou BlobProperties

Necessário

O blob com o qual interagir. Se especificado, este valor substituirá um valor de blob especificado no URL do blob.

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. O valor pode ser um objeto BlobLeaseClient ou o ID de concessão como uma cadeia.

if_modified_since: datetime

if_unmodified_since: datetime

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

Tipo de retorno

None

delete_blobs

Marca os blobs ou instantâneos especificados para eliminação.

Os blobs são posteriormente eliminados durante a recolha de lixo. Tenha em atenção que, para eliminar blobs, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação de delete_blobs.

Se uma política de retenção de eliminação estiver ativada para o serviço, esta operação elimina suavemente os blobs ou instantâneos e mantém os blobs ou instantâneos para o número especificado de dias. Após o número especificado de dias, os dados dos blobs são removidos do serviço durante a recolha de lixo. Os blobs ou instantâneos eliminados de forma recuperável são acessíveis através list_blobs da especificação de include=["eliminado"] Os blobs ou instantâneos eliminados por forma recuperável podem ser restaurados com <xref:azure.storage.blob.BlobClient.undelete>

O número máximo de blobs que podem ser eliminados num único pedido é 256.

delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parâmetros

blobs: str ou dict(str, Any) ou BlobProperties

Necessário

Os blobs a eliminar. Pode ser um único blob ou podem ser fornecidos múltiplos valores, em que cada valor é o nome do blob (str) ou BlobProperties.

Nota

Quando o tipo de blob é dict, eis uma lista de chaves, regras de valor.

nome do blob:

chave: "nome", tipo de valor: str

instantâneo que pretende eliminar:

chave: "instantâneo", tipo de valor: str

ID da versão:

chave: "version_id", tipo de valor: str

se pretende eliminar instantâneos ao eliminar o blob:

chave: "delete_snapshots", valor: "include" ou "only"

se o blob tiver sido modificado ou não:

chave: "if_modified_since", "if_unmodified_since", tipo de valor: datetime

etag:

chave: "etag", tipo de valor: str

corresponder ou não ao etag:

chave: "match_condition", tipo de valor: MatchConditions

as etiquetas correspondem à condição:

chave: "if_tags_match_condition", tipo de valor: str

concessão:

chave: "lease_id", tipo de valor: União[str, LeaseClient]

tempo limite para subrequesto:

chave: "tempo limite", tipo de valor: int

delete_snapshots: str

Necessário se um 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.

if_modified_since: datetime

if_unmodified_since: datetime

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.

raise_on_any_failure: bool

Este é um parâmetro booleano que é predefinido como Verdadeiro. Quando esta opção é definida, é gerada uma exceção mesmo que exista uma única falha de operação.

timeout: int

Devoluções

Um iterador de respostas, um para cada blob por ordem

Tipo de retorno

Iterator[HttpResponse]

delete_container

Marca o contentor especificado para eliminação. O contentor e quaisquer blobs contidos no mesmo são posteriormente eliminados durante a recolha de lixo.

delete_container(**kwargs: Any) -> None

Parâmetros

lease: BlobLeaseClient ou str

Se especificado, delete_container só é bem-sucedido se a concessão do contentor estiver ativa e corresponder a este ID. Necessário se o contentor tiver uma concessão ativa.

if_modified_since: datetime

if_unmodified_since: datetime

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

Tipo de retorno

None

download_blob

Transfere um blob para o StorageStreamDownloader. O método readall() tem de ser utilizado para ler todo o conteúdo ou 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(blob: str | BlobProperties, offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]

Parâmetros

blob: str ou BlobProperties

Necessário

O blob com o qual interagir. Se especificado, este valor substituirá um valor de blob especificado no URL do blob.

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

if_unmodified_since: datetime

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

exists

Devolve Verdadeiro se existir um contentor e devolve Falso de outra forma.

exists(**kwargs: Any) -> bool

Parâmetros

timeout: int

Devoluções

boolean

Tipo de retorno

bool

find_blobs_by_tags

Devolve um gerador para listar os blobs no contentor especificado cujas etiquetas correspondem à expressão de pesquisa especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço.

find_blobs_by_tags(filter_expression: str, **kwargs: Any | None) -> ItemPaged[FilteredBlob]

Parâmetros

filter_expression: str

Necessário

A expressão para localizar blobs cujas etiquetas correspondem à condição especificada. Por exemplo, ""yourtagname"='firsttag' e "yourtagname2"='secondtag'"

results_per_page: int

O resultado máximo por página ao paginar.

timeout: int

Devoluções

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

Tipo de retorno

ItemPaged[BlobProperties]

from_connection_string

Crie ContainerClient a partir de uma Cadeia de Ligação.

from_connection_string(conn_str: str, container_name: str, 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.

credential

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 a 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 uma 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 da 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.

Devoluções

Um cliente de contentor.

Tipo de retorno

ContainerClient

from_container_url

Crie ContainerClient a partir de um URL de contentor.

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

Parâmetros

container_url: str

Necessário

O URL de ponto final completo para o Contentor, incluindo o token de SAS, se utilizado. Este pode ser o ponto final principal ou o ponto final secundário, dependendo do location_mode atual.

credential

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 a 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 uma 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.

Devoluções

Um cliente de contentor.

Tipo de retorno

ContainerClient

get_account_information

Obtém informações relacionadas com a conta de armazenamento.

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)

get_blob_client

Faça com que um cliente interaja com o blob especificado.

O blob ainda não precisa de existir.

get_blob_client(blob: str | BlobProperties, snapshot: str = None, *, version_id: str | None = None) -> BlobClient

Parâmetros

blob: str ou BlobProperties

Necessário

O blob com o qual interagir.

snapshot: str

valor predefinido: None

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

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

Tipo de retorno

BlobClient

get_container_access_policy

Obtém as permissões para o contentor especificado. As permissões indicam se os dados de contentor podem ser acedidos publicamente.

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

Parâmetros

lease: BlobLeaseClient ou str

Se especificado, get_container_access_policy só é bem-sucedido se a concessão do contentor estiver ativa e corresponder a este ID.

timeout: int

Devoluções

Aceder às informações da política num ditado.

Tipo de retorno

dict[str, Any]

get_container_properties

Devolve todas as propriedades de sistema e metadados definidos pelo utilizador para o contentor especificado. Os dados devolvidos não incluem a lista de blobs do contentor.

get_container_properties(**kwargs: Any) -> ContainerProperties

Parâmetros

lease: BlobLeaseClient ou str

Se especificado, get_container_properties só é bem-sucedido se a concessão do contentor estiver ativa e corresponder a este ID.

timeout: int

Devoluções

Propriedades do contentor especificado num objeto de contentor.

Tipo de retorno

ContainerProperties

list_blob_names

Devolve um gerador para listar os nomes dos blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço.

Tenha em atenção que não serão devolvidas propriedades ou metadados adicionais ao utilizar esta API. Além disso, esta API não tem a opção de incluir blobs adicionais, como instantâneos, versões, blobs eliminados de forma recuperável, etc. Para obter qualquer um destes dados, utilize list_blobs.

list_blob_names(**kwargs: Any) -> ItemPaged[str]

Parâmetros

name_starts_with: str

Filtra os resultados para devolver apenas blobs cujos nomes começam com o prefixo especificado.

timeout: int

Devoluções

Uma resposta iterável (paginação automática) de nomes de blobs como cadeias.

Tipo de retorno

ItemPaged[str]

list_blobs

Devolve um gerador para listar os blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço.

list_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, **kwargs: Any) -> ItemPaged[BlobProperties]

Parâmetros

name_starts_with: str

Necessário

Filtra os resultados para devolver apenas blobs cujos nomes começam com o prefixo especificado.

include: list[str] ou str

Necessário

Especifica um ou mais conjuntos de dados adicionais a incluir na resposta. As opções incluem: "instantâneos", "metadados", "uncommitmittedblobs", "copy", "deleted", "deletedwithversions", "tags", "versions", "immutabilitypolicy", "legalhold".

timeout: int

Devoluções

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

Tipo de retorno

ItemPaged[BlobProperties]

set_container_access_policy

Define as permissões para o contentor especificado ou políticas de acesso armazenado que podem ser utilizadas com Assinaturas de Acesso Partilhado. As permissões indicam se os blobs num contentor podem ser acedidos publicamente.

set_container_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Parâmetros

signed_identifiers: dict[str, AccessPolicy]

Necessário

Um dicionário de políticas de acesso a associar ao contentor. O dicionário pode conter até 5 elementos. Um dicionário vazio limpará as políticas de acesso definidas no serviço.

public_access: PublicAccess

Necessário

Os valores possíveis incluem: "contentor", "blob".

lease: BlobLeaseClient ou str

Necessário se o contentor 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 data/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.

timeout: int

Devoluções

Dict da propriedade atualizada pelo contentor (Etag e última modificação).

Tipo de retorno

dict[str, str,

datetime]

set_container_metadata

Define um ou mais pares nome-valor definidos pelo utilizador para o contentor especificado. Cada chamada para esta operação substitui todos os metadados existentes anexados ao contentor. Para remover todos os metadados do contentor, chame esta operação sem dict de metadados.

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

Parâmetros

metadata: dict[str, str]

Necessário

Um ditado que contém pares nome-valor para associar ao contentor como metadados. Exemplo: {'category':'test'}

lease: BlobLeaseClient ou str

Se especificado, set_container_metadata só é bem-sucedido se a concessão do contentor estiver ativa e corresponder a este ID.

if_modified_since: datetime

if_unmodified_since: datetime

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 .

timeout: int

Devoluções

Dict da propriedade atualizada pelo contentor (Etag e última modificação).

Tipo de retorno

dict[str, str,

datetime]

set_premium_page_blob_tier_blobs

Define as camadas de blobs de páginas em todos os blobs. Esta API só é suportada para blobs de páginas em contas premium.

O número máximo de blobs que podem ser atualizados num único pedido é 256.

set_premium_page_blob_tier_blobs(premium_page_blob_tier: str | PremiumPageBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parâmetros

premium_page_blob_tier: PremiumPageBlobTier

Necessário

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.

Nota

Se quiser definir diferentes camadas em blobs diferentes, defina este parâmetro posicional como Nenhum.

Em seguida, a camada de blobs em cada BlobProperties será tomada.

blobs: str ou dict(str, Any) ou BlobProperties

Necessário

Os blobs com os quais interagir. Pode ser um único blob ou podem ser fornecidos múltiplos valores, em que cada valor é o nome do blob (str) ou BlobProperties.

Nota

Quando o tipo de blob é dict, eis uma lista de chaves, regras de valor.

nome do blob:

chave: "nome", tipo de valor: str

escalão de blob premium:

chave: "blob_tier", tipo de valor: PremiumPageBlobTier

concessão:

chave: 'lease_id', tipo de valor: Union[str, LeaseClient]

tempo limite para subrequesto:

chave: "tempo limite", tipo de valor: int

timeout: int

raise_on_any_failure: bool

Este é um parâmetro booleano predefinido como Verdadeiro. Quando esta opção é definida, é gerada uma exceção mesmo que exista uma única falha de operação.

Devoluções

Um iterador de respostas, um para cada blob por ordem

Tipo de retorno

<xref:iterator>[HttpResponse]

set_standard_blob_tier_blobs

Esta operação define a camada em blobs 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.

O número máximo de blobs que podem ser atualizados num único pedido é 256.

set_standard_blob_tier_blobs(standard_blob_tier: str | StandardBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parâmetros

standard_blob_tier: str ou StandardBlobTier

Necessário

Indica a camada a definir em todos os blobs. 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.

Nota

Se quiser definir uma camada diferente em blobs diferentes, defina este parâmetro posicional como Nenhum.

Em seguida, a camada de blobs em cada BlobProperties será tomada.

blobs: str ou dict(str, Any) ou BlobProperties

Necessário

Os blobs com os quais interagir. Pode ser um único blob ou podem ser fornecidos vários valores, em que cada valor é o nome do blob (str) ou blobProperties.

Nota

Quando o tipo de blob é dict, eis uma lista de chaves, regras de valor.

nome do blob:

chave: "name", tipo de valor: str

escalão de blob padrão:

chave: "blob_tier", tipo de valor: StandardBlobTier

prioridade de reidratar:

chave: 'rehydrate_priority', tipo de valor: RehydratePriority

concessão:

chave: 'lease_id', tipo de valor: Union[str, LeaseClient]

instantâneo:

chave: "snapshot", tipo de valor: str

ID da versão:

chave: "version_id", tipo de valor: str

as etiquetas correspondem à condição:

chave: 'if_tags_match_condition', tipo de valor: str

tempo limite para subrequesto:

chave: "tempo limite", tipo de valor: int

rehydrate_priority: RehydratePriority

Indica a prioridade com a qual reidratar um blob arquivado

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

raise_on_any_failure: bool

Este é um parâmetro booleano predefinido como Verdadeiro. Quando esta opção é definida, é gerada uma exceção mesmo que exista uma única falha de operação.

Devoluções

Um iterador de respostas, um para cada blob por ordem

Tipo de retorno

Iterator[HttpResponse]

upload_blob

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

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

Parâmetros

name: str ou BlobProperties

Necessário

O blob com o qual interagir. Se for especificado, este valor substituirá um valor de blob especificado no URL do blob.

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.

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, uma vez que 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 contentor 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

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. Este método pode fazer várias chamadas ao serviço e o tempo limite será aplicado a cada chamada individualmente.

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.

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.

Devoluções

Um BlobClient para interagir com o blob carregado recentemente.

Tipo de retorno

BlobClient

walk_blobs

Devolve um gerador para listar os blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço. Esta operação listará os blobs de acordo com uma hierarquia, conforme delimitado pelo caráter delimitador especificado.

walk_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, delimiter: str = '/', **kwargs: Any | None) -> ItemPaged[BlobProperties]

Parâmetros

name_starts_with: str

Necessário

Filtra os resultados para devolver apenas blobs cujos nomes começam com o prefixo especificado.

include: list[str] ou str

Necessário

Especifica um ou mais conjuntos de dados adicionais a incluir na resposta. As opções incluem: "snapshots", "metadata", "uncommittedblobs", "copy", "deleted", "deletedwithversions", "tags", "versions", "immutabilitypolicy", "legalhold".

delimiter: str

Necessário

Quando o pedido inclui este parâmetro, a operação devolve um elemento BlobPrefix no corpo da resposta que atua como um marcador de posição para todos os blobs cujos nomes começam com a mesma subcadeia até ao aspeto do caráter delimitador. O delimitador pode ser um único caráter ou uma cadeia.

timeout: int

Devoluções

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

Tipo de retorno

ItemPaged[BlobProperties]

Atributos

api_version

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

location_mode

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

primary_endpoint

O URL do ponto final primário completo.

primary_hostname

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

secondary_endpoint

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

secondary_hostname

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.

url

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