ContainerClient Classe
Um cliente para interagir com um contêiner específico, embora esse contêiner ainda não exista.
Para operações relacionadas a um blob específico dentro desse contêiner, um cliente de blob pode ser recuperado usando a get_blob_client função .
Para obter mais configurações opcionais, clique aqui.
- Herança
-
azure.storage.blob._shared.base_client.StorageAccountHostsMixinContainerClientazure.storage.blob._encryption.StorageEncryptionMixinContainerClient
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
O URI para a conta de armazenamento. Para criar um cliente com o URI completo para o contêiner, use o from_container_url classmethod.
- credential
As credenciais com as quais autenticar. Isso será opcional se a URL da conta já tiver um token SAS. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. Se o URI do recurso já contiver um token SAS, isso será ignorado em favor de uma credencial explícita
- exceto no caso do AzureSasCredential, em que os tokens SAS conflitantes gerarão um ValueError. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.
- api_version
- str
A versão da API de Armazenamento a ser usada para solicitações. O valor padrão é a versão de serviço mais recente compatível com o SDK atual. A configuração para uma versão mais antiga pode resultar em compatibilidade de recursos reduzida.
Novo na versão 12.2.0.
- secondary_hostname
- str
O nome do host do ponto de extremidade secundário.
- max_block_size
- int
O tamanho máximo da parte para carregar um blob de blocos em partes.
O padrão é 4*1024*1024
ou 4 MB.
- max_single_put_size
- int
Se o tamanho do blob for menor ou igual a max_single_put_size, o blob será carregado com apenas uma solicitação http PUT. Se o tamanho do blob for maior que max_single_put_size, o blob será carregado em partes. O padrão é 64*1024*1024
ou 64 MB.
- min_large_block_upload_threshold
- int
O tamanho mínimo da parte necessária para usar o algoritmo com eficiência de memória ao carregar um blob de blocos. O padrão é 4*1024*1024
+1.
- use_byte_buffer
- bool
Use um buffer de bytes para carregamentos de blob de blocos. Usa False como padrão.
- max_page_size
- int
O tamanho máximo da parte para carregar um blob de páginas. O padrão é 4*1024*1024
ou 4 MB.
- max_single_get_size
- int
O tamanho máximo para um blob a ser baixado em uma única chamada, a parte excedida será baixada em partes (pode ser paralelo). O padrão é 32*1024*1024
ou 32 MB.
- max_chunk_get_size
- int
O tamanho máximo da parte usada para baixar um blob. O padrão é 4*1024*1024
ou 4 MB.
Métodos
acquire_lease |
Solicita uma nova concessão. Se o contêiner não tiver uma concessão ativa, o serviço Blob criará uma no contêiner e retornará uma nova ID de concessão. |
close |
Esse método é fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto. |
create_container |
Cria um novo contêiner na conta especificada. Se o contêiner com o mesmo nome já existir, a operação falhará. |
delete_blob |
Marca o blob ou instantâneo especificado para exclusão. O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação delete_blob. Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá o blob ou instantâneo e manterá o blob ou instantâneo para o número especificado de dias. Após o número especificado de dias, os dados do blob são removidos do serviço durante a coleta de lixo. O blob ou instantâneo excluídos é acessível por meio list_blobs da especificação da opção include=["deleted"]. Blob ou instantâneo excluídos de forma reversível podem ser restaurados usando<xref:azure.storage.blob.BlobClient.undelete> |
delete_blobs |
Marca os blobs ou instantâneos especificados para exclusão. Os blobs são posteriormente excluídos durante a coleta de lixo. Observe que, para excluir blobs, você deve excluir todos os instantâneos deles. Você pode excluir ambos ao mesmo tempo com a operação delete_blobs. Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá temporariamente os blobs ou instantâneos e reterá 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 coleta de lixo. Blobs ou instantâneos excluídos de forma reversível podem ser restaurados usando list_blobs a especificação de include=["deleted"] Blobs ou instantâneos com exclusão reversível <xref:azure.storage.blob.BlobClient.undelete> O número máximo de blobs que podem ser excluídos em uma única solicitação é 256. |
delete_container |
Marca o contêiner especificado para exclusão. O contêiner e todos os blobs contidos são excluídos posteriormente, durante a coleta de lixo. |
download_blob |
Baixa um blob no StorageStreamDownloader. O método readall() deve ser usado para ler todo o conteúdo ou readinto() deve ser usado para baixar o blob em um fluxo. O uso de chunks() retorna um iterador que permite que o usuário itere sobre o conteúdo em partes. |
exists |
Retornará True se houver um contêiner e retornar False caso contrário. |
find_blobs_by_tags |
Retorna um gerador para listar os blobs no contêiner especificado cujas marcas correspondem à expressão de pesquisa fornecida. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço. |
from_connection_string |
Criar ContainerClient a partir de uma cadeia de conexão. |
from_container_url |
Crie ContainerClient a partir de uma URL de contêiner. |
get_account_information |
Obtém informações relacionadas à conta de armazenamento. As informações também poderão ser recuperadas se o usuário tiver uma SAS para um contêiner ou blob. As chaves no dicionário retornado incluem 'sku_name' e 'account_kind'. |
get_blob_client |
Faça com que um cliente interaja com o blob especificado. O blob ainda não precisa existir. |
get_container_access_policy |
Obtém as permissões para o contêiner especificado. As permissões indicam se os dados de um contêiner podem ser acessados publicamente. |
get_container_properties |
Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o contêiner especificado. Os dados retornados não incluem a lista do contêiner de blobs. |
list_blob_names |
Retorna um gerador para listar os nomes de blobs no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço. Observe que nenhuma propriedade ou metadados adicionais será retornado ao usar essa API. Além disso, essa API não tem uma opção para incluir blobs adicionais, como instantâneos, versões, blobs excluídos de forma reversível, etc. Para obter qualquer um desses dados, use list_blobs. |
list_blobs |
Retorna um gerador para listar os blobs no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço. |
set_container_access_policy |
Define as permissões para o contêiner especificado ou políticas de acesso armazenadas que podem ser usadas com assinaturas de acesso compartilhado. As permissões indicam se os blobs de um contêiner podem ser acessados publicamente. |
set_container_metadata |
Define um ou mais pares nome-valor definidos pelo usuário para o contêiner especificado. Cada chamada para essa operação substitui todos os metadados existentes anexados ao contêiner. Para remover todos os metadados do contêiner, chame essa operação sem um ditado de metadados. |
set_premium_page_blob_tier_blobs |
Define as camadas de blob de páginas em todos os blobs. Essa API só tem suporte para blobs de páginas em contas premium. O número máximo de blobs que podem ser atualizados em uma única solicitação é 256. |
set_standard_blob_tier_blobs |
Essa 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 Morto. Essa operação não atualiza a ETag do blob. O número máximo de blobs que podem ser atualizados em uma única solicitação é 256. |
upload_blob |
Cria um novo blob de uma fonte de dados com agrupamento automático. |
walk_blobs |
Retorna um gerador para listar os blobs no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço. Essa operação listará blobs de acordo com uma hierarquia, conforme delimitado pelo caractere delimitador especificado. |
acquire_lease
Solicita uma nova concessão. Se o contêiner não tiver uma concessão ativa, o serviço Blob criará uma no contêiner e retornará uma nova ID de concessão.
acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs) -> BlobLeaseClient
Parâmetros
- lease_duration
- int
Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).
- lease_id
- str
ID proposta da concessão, em um formato de cadeia de caracteres GUID. O serviço Blob retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.
- match_condition
- MatchConditions
A condição de correspondência a ser usada na etag.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Um objeto BlobLeaseClient que pode ser executado em um gerenciador de contexto.
Tipo de retorno
close
Esse método é fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto.
close()
create_container
Cria um novo contêiner na conta especificada. Se o contêiner 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
Um ditado com pares name_value para associar ao contêiner como metadados. Exemplo:{'Category':'test'}
- container_encryption_scope
- dict ou ContainerEncryptionScope
Especifica o escopo de criptografia padrão a ser definido no contêiner e usado para todas as gravações futuras.
Novo na versão 12.2.0.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Um dicionário de cabeçalhos de resposta.
Tipo de retorno
delete_blob
Marca o blob ou instantâneo especificado para exclusão.
O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação delete_blob.
Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá o blob ou instantâneo e manterá o blob ou instantâneo para o número especificado de dias. Após o número especificado de dias, os dados do blob são removidos do serviço durante a coleta de lixo. O blob ou instantâneo excluídos é acessível por meio list_blobs da especificação da opção include=["deleted"]. Blob ou instantâneo excluídos de forma reversível podem ser restaurados usando<xref:azure.storage.blob.BlobClient.undelete>
delete_blob(blob: str | BlobProperties, delete_snapshots: str | None = None, **kwargs) -> None
Parâmetros
- blob
- str ou BlobProperties
O blob com o qual interagir. Se especificado, esse valor substituirá um valor de blob especificado na URL do blob.
- delete_snapshots
- str
Obrigatório se o blob tiver instantâneos associados. Os valores são:
"only": exclui apenas os instantâneos de blobs.
"include": exclui o blob junto com todos os instantâneos.
- version_id
- str
O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob a ser excluída.
Novo na versão 12.4.0.
Esse argumento palavra-chave foi introduzido na versão da API '2019-12-12'.
- lease
- BlobLeaseClient ou str
Obrigatório se o blob tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.
- match_condition
- MatchConditions
A condição de correspondência a ser usada na etag.
- if_tags_match_condition
- str
Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo na versão 12.4.0.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Tipo de retorno
delete_blobs
Marca os blobs ou instantâneos especificados para exclusão.
Os blobs são posteriormente excluídos durante a coleta de lixo. Observe que, para excluir blobs, você deve excluir todos os instantâneos deles. Você pode excluir ambos ao mesmo tempo com a operação delete_blobs.
Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá temporariamente os blobs ou instantâneos e reterá 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 coleta de lixo. Blobs ou instantâneos excluídos de forma reversível podem ser restaurados usando list_blobs a especificação de include=["deleted"] Blobs ou instantâneos com exclusão reversível <xref:azure.storage.blob.BlobClient.undelete>
O número máximo de blobs que podem ser excluídos em uma única solicitação é 256.
delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]
Parâmetros
- blobs
- str ou dict(str, Any) ou BlobProperties
Os blobs a serem excluídos. Isso pode ser um único blob ou vários valores podem ser fornecidos, em que cada valor é o nome do blob (str) ou blobProperties.
Observação
Quando o tipo de blob é dict, aqui está uma lista de chaves, regras de valor.
nome do blob:
key: 'name', value type: str
instantâneo deseja excluir:
key: 'instantâneo', tipo de valor: str
ID da versão:
key: 'version_id', tipo de valor: str
se deseja excluir instantâneos ao excluir o blob:
key: 'delete_snapshots', value: 'include' ou 'only'
se o blob tiver sido modificado ou não:
key: 'if_modified_since', 'if_unmodified_since', tipo de valor: datetime
Etag:
key: 'etag', tipo de valor: str
correspondem à etag ou não:
key: 'match_condition', tipo de valor: MatchConditions
As marcas correspondem à condição:
key: 'if_tags_match_condition', tipo de valor: str
Locação:
key: 'lease_id', tipo de valor: Union[str, LeaseClient]
tempo limite para sub-solicitação:
key: 'timeout', tipo de valor: int
- delete_snapshots
- str
Obrigatório se um blob tiver instantâneos associados. Os valores são:
"only": exclui apenas os instantâneos de blobs.
"include": exclui o blob junto com todos os instantâneos.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_tags_match_condition
- str
Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo na versão 12.4.0.
- raise_on_any_failure
- bool
Esse é um parâmetro booliano que usa como padrão True. Quando isso é definido, uma exceção é gerada mesmo se houver uma única falha de operação.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Um iterador de respostas, um para cada blob na ordem
Tipo de retorno
delete_container
Marca o contêiner especificado para exclusão. O contêiner e todos os blobs contidos são excluídos posteriormente, durante a coleta de lixo.
delete_container(**kwargs: Any) -> None
Parâmetros
- lease
- BlobLeaseClient ou str
Se especificado, delete_container só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID. Obrigatório se o contêiner tiver uma concessão ativa.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.
- match_condition
- MatchConditions
A condição de correspondência a ser usada na etag.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Tipo de retorno
download_blob
Baixa um blob no StorageStreamDownloader. O método readall() deve ser usado para ler todo o conteúdo ou readinto() deve ser usado para baixar o blob em um fluxo. O uso de chunks() retorna um iterador que permite que o usuário itere sobre o conteúdo em partes.
download_blob(blob: str | BlobProperties, offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]
Parâmetros
- blob
- str ou BlobProperties
O blob com o qual interagir. Se especificado, esse valor substituirá um valor de blob especificado na URL do blob.
- offset
- int
Início do intervalo de bytes a ser usado para baixar uma seção do blob. Deve ser definido se o comprimento for fornecido.
- length
- int
Número de bytes a serem lidos do fluxo. Isso é opcional, mas deve ser fornecido para o desempenho ideal.
- version_id
- str
O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob a ser baixada.
Novo na versão 12.4.0.
Esse argumento palavra-chave foi introduzido na versão da API '2019-12-12'.
- validate_content
- bool
Se for true, calculará um hash MD5 para cada parte do blob. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips no fio se o uso de http em vez de https, como https (o padrão), já validará. Observe que esse hash MD5 não é armazenado com o blob. Observe também que, se habilitado, o algoritmo de carregamento com eficiência de memória não será usado porque a computação do hash MD5 requer buffer de blocos inteiros e isso derrota a finalidade do algoritmo com eficiência de memória.
- lease
- BlobLeaseClient ou str
Obrigatório se o blob tiver uma concessão ativa. Se especificado, download_blob só terá êxito se a concessão do blob estiver ativa e corresponder a essa ID. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.
- match_condition
- MatchConditions
A condição de correspondência a ser usada na etag.
- if_tags_match_condition
- str
Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo na versão 12.4.0.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
- max_concurrency
- int
O número de conexões paralelas com as quais baixar.
- encoding
- str
Codificação para decodificar os bytes baixados. O padrão é None, ou seja, nenhuma decodificação.
Um retorno de chamada para acompanhar o progresso de um download de longa execução. A assinatura é function(current: int, total: int) em que current é o número de bytes transferidos até agora, e total é o tamanho total do download.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui. Esse método pode fazer várias chamadas para o serviço e o tempo limite será aplicado a cada chamada individualmente. várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
Retornos
Um objeto de streaming (StorageStreamDownloader)
Tipo de retorno
exists
Retornará True se houver um contêiner e retornar False caso contrário.
exists(**kwargs: Any) -> bool
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
booleano
Tipo de retorno
find_blobs_by_tags
Retorna um gerador para listar os blobs no contêiner especificado cujas marcas correspondem à expressão de pesquisa fornecida. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço.
find_blobs_by_tags(filter_expression: str, **kwargs: Any | None) -> ItemPaged[FilteredBlob]
Parâmetros
- filter_expression
- str
A expressão para localizar blobs cujas marcas correspondem à condição especificada. ex. ""yourtagname"='firsttag' e "yourtagname2"='secondtag'"
- results_per_page
- int
O resultado máximo por página ao paginar.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Uma resposta iterável (paginação automática) de FilteredBlob.
Tipo de retorno
from_connection_string
Criar ContainerClient a partir de uma cadeia de conexã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
- credential
As credenciais com as quais autenticar. Isso é opcional se a URL da conta já tiver um token SAS ou a cadeia de conexão já tiver valores de chave de acesso compartilhado. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. As credenciais fornecidas aqui terão precedência sobre aquelas na cadeia de conexão. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.
Retornos
Um cliente de contêiner.
Tipo de retorno
from_container_url
Crie ContainerClient a partir de uma URL de contêiner.
from_container_url(container_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parâmetros
- container_url
- str
A URL completa do ponto de extremidade para o Contêiner, incluindo o token SAS, se usado. Isso pode ser o ponto de extremidade primário ou o ponto de extremidade secundário, dependendo do location_mode atual.
- credential
As credenciais com as quais autenticar. Isso é opcional se a URL da conta já tiver um token SAS ou a cadeia de conexão já tiver valores de chave de acesso compartilhado. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. Se o URI do recurso já contiver um token SAS, isso será ignorado em favor de uma credencial explícita
- exceto no caso do AzureSasCredential, em que os tokens SAS conflitantes gerarão um ValueError. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.
Retornos
Um cliente de contêiner.
Tipo de retorno
get_account_information
Obtém informações relacionadas à conta de armazenamento.
As informações também poderão ser recuperadas se o usuário tiver uma SAS para um contêiner ou blob. As chaves no dicionário retornado incluem 'sku_name' e 'account_kind'.
get_account_information(**kwargs: Any) -> Dict[str, str]
Retornos
Um ditado de informações de conta (SKU e tipo de conta).
Tipo de retorno
get_blob_client
Faça com que um cliente interaja com o blob especificado.
O blob ainda não precisa existir.
get_blob_client(blob: str | BlobProperties, snapshot: str = None, *, version_id: str | None = None) -> BlobClient
Parâmetros
- snapshot
- str
O blob opcional instantâneo no qual operar. Esse pode ser o instantâneo cadeia de caracteres de ID ou a resposta retornada de create_snapshot.
- version_id
- str
O parâmetro id de versão é um valor datetime opaco que, quando presente, especifica a versão do blob no qual operar.
Retornos
Um BlobClient.
Tipo de retorno
get_container_access_policy
Obtém as permissões para o contêiner especificado. As permissões indicam se os dados de um contêiner podem ser acessados publicamente.
get_container_access_policy(**kwargs: Any) -> Dict[str, Any]
Parâmetros
- lease
- BlobLeaseClient ou str
Se especificado, get_container_access_policy só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Acessar informações de política em um ditado.
Tipo de retorno
get_container_properties
Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o contêiner especificado. Os dados retornados não incluem a lista do contêiner de blobs.
get_container_properties(**kwargs: Any) -> ContainerProperties
Parâmetros
- lease
- BlobLeaseClient ou str
Se especificado, get_container_properties só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Propriedades do contêiner especificado em um objeto de contêiner.
Tipo de retorno
list_blob_names
Retorna um gerador para listar os nomes de blobs no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço.
Observe que nenhuma propriedade ou metadados adicionais será retornado ao usar essa API. Além disso, essa API não tem uma opção para incluir blobs adicionais, como instantâneos, versões, blobs excluídos de forma reversível, etc. Para obter qualquer um desses dados, use list_blobs.
list_blob_names(**kwargs: Any) -> ItemPaged[str]
Parâmetros
- name_starts_with
- str
Filtra os resultados para retornar apenas os blobs cujos nomes começam com o prefixo especificado.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Uma resposta iterável (paginação automática) de nomes de blob como cadeias de caracteres.
Tipo de retorno
list_blobs
Retorna um gerador para listar os blobs no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados 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
Filtra os resultados para retornar apenas os blobs cujos nomes começam com o prefixo especificado.
Especifica um ou mais conjuntos de dados adicionais a serem incluídos na resposta. As opções incluem: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions', 'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Uma resposta iterável (paginação automática) de BlobProperties.
Tipo de retorno
set_container_access_policy
Define as permissões para o contêiner especificado ou políticas de acesso armazenadas que podem ser usadas com assinaturas de acesso compartilhado. As permissões indicam se os blobs de um contêiner podem ser acessados 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]
Um dicionário de políticas de acesso a serem associadas ao contêiner. O dicionário pode conter até 5 elementos. Um dicionário vazio limpará as políticas de acesso definidas no serviço.
- lease
- BlobLeaseClient ou str
Obrigatório se o contêiner tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.
- if_modified_since
- datetime
Um valor datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a data/hora especificada.
- if_unmodified_since
- datetime
Um valor datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Ditado de propriedade atualizado pelo contêiner (Etag e última modificação).
Tipo de retorno
set_container_metadata
Define um ou mais pares nome-valor definidos pelo usuário para o contêiner especificado. Cada chamada para essa operação substitui todos os metadados existentes anexados ao contêiner. Para remover todos os metadados do contêiner, chame essa operação sem um ditado de metadados.
set_container_metadata(metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]
Parâmetros
Um ditado que contém pares nome-valor a serem associados ao contêiner como metadados. Exemplo: {'category':'test'}
- lease
- BlobLeaseClient ou str
Se especificado, set_container_metadata só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Ditado de propriedade atualizado pelo contêiner (Etag e última modificação).
Tipo de retorno
set_premium_page_blob_tier_blobs
Define as camadas de blob de páginas em todos os blobs. Essa API só tem suporte para blobs de páginas em contas premium.
O número máximo de blobs que podem ser atualizados em uma única solicitação é 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
Um valor de camada de blob de página para definir o blob. A camada se correlaciona ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento premium.
Observação
Se você quiser definir uma camada diferente em blobs diferentes, defina esse parâmetro posicional como Nenhum.
Em seguida, a camada de blob em cada BlobProperties será tomada.
- blobs
- str ou dict(str, Any) ou BlobProperties
Os blobs com os quais interagir. Isso pode ser um único blob ou vários valores podem ser fornecidos, em que cada valor é o nome do blob (str) ou blobProperties.
Observação
Quando o tipo de blob é dict, aqui está uma lista de chaves, regras de valor.
nome do blob:
key: 'name', value type: str
camada de blob premium:
key: 'blob_tier', tipo de valor: PremiumPageBlobTier
Locação:
key: 'lease_id', tipo de valor: Union[str, LeaseClient]
tempo limite para sub-solicitação:
key: 'timeout', tipo de valor: int
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.
- raise_on_any_failure
- bool
Esse é um parâmetro booliano que usa como padrão True. Quando isso é definido, uma exceção é gerada mesmo se houver uma única falha de operação.
Retornos
Um iterador de respostas, um para cada blob na ordem
Tipo de retorno
set_standard_blob_tier_blobs
Essa 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 Morto. Essa operação não atualiza a ETag do blob.
O número máximo de blobs que podem ser atualizados em uma única solicitação é 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
Indica a camada a ser definida em todos os blobs. As opções incluem 'Hot', 'Cool', 'Archive'. A camada quente é otimizada para armazenar dados acessados com frequência. A camada de armazenamento esporádico é otimizada para armazenar dados acessados com pouca frequência e armazenados por pelo menos um mês. A camada de arquivos é otimizada para armazenar dados que raramente são acessados e armazenados por pelo menos seis meses com requisitos de latência flexíveis.
Observação
Se você quiser definir uma camada diferente em blobs diferentes, defina esse parâmetro posicional como Nenhum.
Em seguida, a camada de blob em cada BlobProperties será usada.
- blobs
- str ou dict(str, Any) ou BlobProperties
Os blobs com os quais interagir. Pode ser um único blob ou vários valores podem ser fornecidos, em que cada valor é o nome do blob (str) ou BlobProperties.
Observação
Quando o tipo de blob é dict, aqui está uma lista de chaves, regras de valor.
nome do blob:
key: 'name', value type: str
camada de blob padrão:
key: 'blob_tier', tipo de valor: StandardBlobTier
reidratar prioridade:
key: 'rehydrate_priority', tipo de valor: RehydratePriority
Locação:
key: 'lease_id', tipo de valor: Union[str, LeaseClient]
instantâneo:
key: "instantâneo", tipo de valor: str
ID da versão:
key: "version_id", tipo de valor: str
As marcas correspondem à condição:
key: 'if_tags_match_condition', tipo de valor: str
tempo limite para sub-solicitação:
key: 'timeout', tipo de valor: int
- rehydrate_priority
- RehydratePriority
Indica a prioridade com a qual reidratar um blob arquivado
- if_tags_match_condition
- str
Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo na versão 12.4.0.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.
- raise_on_any_failure
- bool
Esse é um parâmetro booliano que usa como padrão True. Quando isso é definido, uma exceção é gerada mesmo se houver uma única falha de operação.
Retornos
Um iterador de respostas, um para cada blob na ordem
Tipo de retorno
upload_blob
Cria um novo blob de uma fonte de dados com agrupamento automático.
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
O blob com o qual interagir. Se especificado, esse valor substituirá um valor de blob especificado na URL do blob.
- data
Os dados de blob a serem carregados.
- blob_type
- BlobType
O tipo do blob. Isso pode ser BlockBlob, PageBlob ou AppendBlob. O valor padrão é BlockBlob.
- length
- int
Número de bytes a serem lidos do fluxo. Isso é opcional, mas deve ser fornecido para um desempenho ideal.
- overwrite
- bool
Se o blob a ser carregado deve substituir os dados atuais. Se True, upload_blob substituirá os dados existentes. Se definido como False, a operação falhará com ResourceExistsError. A exceção acima é com Os tipos de blob de acréscimo: se definido como False e os dados já existirem, um erro não será gerado e os dados serão acrescentados ao blob existente. Se definido overwrite=True, o blob de acréscimo existente será excluído e um novo será criado. Usa False como padrão.
- content_settings
- ContentSettings
Objeto ContentSettings usado para definir propriedades de blob. Usado para definir o tipo de conteúdo, a codificação, o idioma, a disposição, o md5 e o controle de cache.
- validate_content
- bool
Se for true, calculará um hash MD5 para cada parte do blob. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é valioso principalmente para detectar bitflips na transmissão se usar http em vez de https, como https (o padrão), já será validado. Observe que esse hash MD5 não é armazenado com o blob. Observe também que, se habilitado, o algoritmo de upload com eficiência de memória não será usado, pois a computação do hash MD5 requer buffer de blocos inteiros e isso derrota a finalidade do algoritmo com eficiência de memória.
- lease
- BlobLeaseClient ou str
Obrigatório se o contêiner tiver uma concessão ativa. O valor pode ser um objeto BlobLeaseClient ou a ID de concessão como uma cadeia de caracteres.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado para marcar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition.
- match_condition
- MatchConditions
A condição de correspondência a ser usada na etag.
- if_tags_match_condition
- str
Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo na versão 12.4.0.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui. Esse método pode fazer várias chamadas para o 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ágina para definir o blob. A camada se correlaciona ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento premium.
- standard_blob_tier
- StandardBlobTier
Um valor de camada de blob padrão para definir o blob. Para esta versão da biblioteca, isso 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 Anexar Bloco fizer com que o blob exceda esse limite ou se o tamanho do blob já for maior do que o valor especificado neste cabeçalho, a solicitação falhará com o erro MaxBlobSizeConditionNotMet (HTTP status código 412 – Falha na pré-condição).
- max_concurrency
- int
Número máximo de conexões paralelas a serem usadas quando o tamanho do blob exceder 64 MB.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
- encryption_scope
- str
Um escopo de criptografia predefinido usado para criptografar os dados no serviço. Um escopo de criptografia pode ser criado usando a API de Gerenciamento e referenciado aqui por nome. Se um escopo de criptografia padrão tiver sido definido no contêiner, esse valor o substituirá se o escopo no nível do contêiner estiver configurado para permitir substituições. Caso contrário, um erro será gerado.
Novo na versão 12.2.0.
- encoding
- str
O padrão é UTF-8.
Um retorno de chamada para acompanhar o progresso de um upload de execução prolongada. A assinatura é function(current: int, total: Optional[int]) em que current é o número de bytes transferidos até agora, e total é o tamanho do blob ou Nenhum se o tamanho for desconhecido.
Retornos
Um BlobClient para interagir com o blob recém-carregado.
Tipo de retorno
walk_blobs
Retorna um gerador para listar os blobs no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço. Essa operação listará blobs de acordo com uma hierarquia, conforme delimitado pelo caractere 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
Filtra os resultados para retornar apenas os blobs cujos nomes começam com o prefixo especificado.
Especifica um ou mais conjuntos de dados adicionais a serem incluídos na resposta. As opções incluem: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions', 'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
- delimiter
- str
Quando a solicitação inclui esse parâmetro, a operação retorna um elemento BlobPrefix no corpo da resposta que atua como um espaço reservado para todos os blobs cujos nomes começam com a mesma subcadeia de caracteres até a aparência do caractere delimitador. O delimitador pode ser um único caractere ou uma cadeia de caracteres.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Uma resposta iterável (paginação automática) de BlobProperties.
Tipo de retorno
Atributos
api_version
A versão da API de Armazenamento usada para solicitações.
location_mode
O modo de localização que o cliente está usando no momento.
Por padrão, isso será "primário". As opções incluem "primário" e "secundário".
primary_endpoint
A URL completa do ponto de extremidade primário.
primary_hostname
O nome do host do ponto de extremidade primário.
secondary_endpoint
A URL completa do ponto de extremidade secundário, se configurada.
Se não estiver disponível, um ValueError será gerado. Para especificar explicitamente um nome de host secundário, use o argumento opcional secondary_hostname palavra-chave na instanciação.
Exceções
secondary_hostname
O nome do host do ponto de extremidade secundário.
Se não estiver disponível, este será Nenhum. Para especificar explicitamente um nome de host secundário, use o argumento opcional secondary_hostname palavra-chave na instanciação.
url
A URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado.
Pode ser o ponto de extremidade primário ou o ponto de extremidade secundário, dependendo do atual location_mode. :returns: a URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado. :rtype: str
Azure SDK for Python