Compartilhar via


BlockBlobService Classe

Os blobs de bloco permitem atualizar blobs grandes eficientemente. Os blobs de bloco são compostos de blocos, e cada um deles é identificado por uma ID de bloco. Crie ou modifique um blob de bloco gravando um conjunto de blocos e confirmando-os pelas suas IDs de bloco. Cada bloco pode ter um tamanho diferente, até um máximo de 100 MB, e um blob de blocos pode incluir até 50.000 blocos. O tamanho máximo de um blob de blocos é, portanto, aproximadamente 4,75 TB (100 MB X 50.000 blocos). Se você estiver escrevendo um blob de blocos com no máximo 64 MB de tamanho, poderá carregá-lo em sua totalidade com uma única operação de gravação; consulte create_blob_from_bytes.

:type ~azure.storage.common.TokenCredential

Herança
BlockBlobService

Construtor

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

Parâmetros

account_name
str
valor padrão: None

O nome da conta de armazenamento. Isso é usado para autenticar solicitações assinadas com uma chave de conta e para construir o ponto de extremidade de armazenamento. Ele é necessário, a menos que um cadeia de conexão seja fornecido ou se um domínio personalizado for usado com autenticação anônima.

account_key
str
valor padrão: None

A chave da conta de armazenamento. Isso é usado para autenticação de chave compartilhada. Se nenhuma chave de conta ou token sas for especificado, o acesso anônimo será usado.

sas_token
str
valor padrão: None

Um token de assinatura de acesso compartilhado a ser usado para autenticar solicitações em vez da chave de conta. Se a chave da conta e o token sas forem especificados, a chave da conta será usada para assinar. Se nenhum dos dois for especificado, o acesso anônimo será usado.

is_emulated
bool
valor padrão: False

Se o emulador deve ser usado. Usa False como padrão. Se especificado, substituirá todos os outros parâmetros além de cadeia de conexão e sessão de solicitação.

protocol
str
valor padrão: https

O protocolo a ser usado para solicitações. O padrão é https.

endpoint_suffix
str
valor padrão: core.windows.net

O componente base do host da URL, menos o nome da conta. O padrão é o Azure (core.windows.net). Substitua isso para usar a nuvem da China (core.chinacloudapi.cn).

custom_domain
str
valor padrão: None

O domínio personalizado a ser usado. Isso pode ser definido no Portal do Azure. Por exemplo, 'www.mydomain.com'.

request_session
<xref:requests.Session>
valor padrão: None

O objeto de sessão a ser usado para solicitações HTTP.

connection_string
str
valor padrão: None

Se especificado, isso substituirá todos os outros parâmetros além da sessão de solicitação. Confira http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ o formato cadeia de conexão.

socket_timeout
int
valor padrão: None

Se especificado, isso substituirá o tempo limite do soquete padrão. O tempo limite especificado é em segundos. Consulte DEFAULT_SOCKET_TIMEOUT em _constants.py para obter o valor padrão.

token_credential
valor padrão: None

Uma credencial de token usada para autenticar solicitações HTTPS. O valor do token deve ser atualizado antes de sua expiração.

Variáveis

MAX_SINGLE_PUT_SIZE
int

O upload de maior tamanho com suporte em uma única chamada put. Isso será usado pelos métodos create_blob_from_* se o comprimento do conteúdo for conhecido e for menor que esse valor.

MAX_BLOCK_SIZE
int

O tamanho dos blocos colocados pelos métodos create_blob_from_* se o comprimento do conteúdo for desconhecido ou maior que MAX_SINGLE_PUT_SIZE. Blocos menores podem ser colocados. O tamanho máximo do bloco compatível com o serviço é de 100 MB.

MIN_LARGE_BLOCK_UPLOAD_THRESHOLD
int

O tamanho mínimo do bloco no qual o algoritmo de upload de bloco com otimização de memória é considerado. Esse algoritmo só é aplicável aos métodos create_blob_from_file e create_blob_from_stream e impedirá o buffer completo de blocos. Além do tamanho do bloco, a validação de ContentMD5 e a Criptografia devem ser desabilitadas, pois essas opções exigem que os blocos sejam armazenados em buffer.

Métodos

abort_copy_blob

Anula uma operação de copy_blob pendente e deixa um blob de destino com comprimento zero e metadados completos.

acquire_blob_lease

Solicita uma nova concessão. Se o blob não tiver uma concessão ativa, o serviço Blob criará uma no blob e retornará uma nova ID de concessão.

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

batch_delete_blobs

Envia um lote de várias solicitações de exclusão de blob.

O método de exclusão de blob exclui o blob ou o instantâneo especificado. Observe que excluir um blob também exclui todos os seus instantâneos. Para obter mais informações, consulte https://docs.microsoft.com/rest/api/storageservices/delete-blob.

batch_set_standard_blob_tier

Envia um lote de várias solicitações de camadas de blob de blocos definidas. Essa API só tem suporte para blobs de blocos em contas de armazenamento padrão.

break_blob_lease

Interrompe a concessão, se o blob tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrer, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no blob. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.

Também é possível liberar uma concessão interrompida. Nesse caso, outro cliente pode adquirir imediatamente a concessão no blob.

break_container_lease

Interrompa a concessão, se o contêiner tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrer, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no contêiner. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.

change_blob_lease

Altera a ID de uma concessão ativa. Uma alteração deve incluir a ID de concessão atual e uma nova ID de concessão.

change_container_lease

Altere a ID de concessão de uma concessão ativa. Uma alteração deve incluir a ID de concessão atual e uma nova ID de concessão.

copy_blob

Copia um blob. Esta operação retorna um objeto de propriedades de operação de cópia. A operação de cópia pode ser configurada para ser uma operação assíncrona e de melhor esforço ou uma operação síncrona.

A origem deverá ser um blob de blocos se requires_sync for verdadeiro. Qualquer blob de destino existente será substituído. O blob de destino não pode ser modificado quando uma operação de cópia está em andamento.

Ao copiar de um blob de blocos, todos os blocos confirmados e suas IDs de bloco são copiados. Os blocos não confirmados não são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos confirmada que a origem.

Você pode chamar get_blob_properties no blob de destino para marcar o status da operação de cópia. O blob final será confirmado quando a cópia for concluída.

Nome do contêiner de destino. O contêiner deve existir. :p aram str blob_name: nome do blob de destino. Se o blob de destino existir, ele será substituído. Caso contrário, ele será criado. :p aram str copy_source: uma URL de até 2 KB de comprimento que especifica um arquivo ou blob do Azure. O valor deve ser codificado em URL tal como apareceria em um pedido URI. Se a origem estiver em outra conta, a origem deverá ser pública ou deve ser autenticada por meio de uma assinatura de acesso compartilhado. Se a origem for pública, nenhuma autenticação será necessária. Exemplos: https://myaccount.blob.core.windows.net/mycontainer/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?instantâneo= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken metadados :p aram: pares nome-valor associados ao blob como metadados. Se nenhum par nome-valor for especificado, a operação copiará os metadados do blob ou arquivo de origem para o blob de destino. Se um ou mais pares nome-valor forem especificados, o blob de destino será criado com os metadados especificados e os metadados não serão copiados do blob ou arquivo de origem. :type metadata: dict(str, str) :p aram datetime source_if_modified_since: 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 condicional para copiar o blob somente se o blob de origem tiver sido modificado desde a data/hora especificada. :p am datetime source_if_unmodified_since: 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 condicional para copiar o blob somente se o blob de origem não tiver sido modificado desde a data/hora especificada. :p aram source_if_match ETag: um valor ETag ou o caractere curinga (). Especifique esse cabeçalho condicional para copiar o blob de origem somente se sua ETag corresponder ao valor especificado. Se os valores ETag não corresponderem, o serviço Blob retornará status código 412 (Falha na pré-condição). Esse cabeçalho não poderá ser especificado se a origem for um Arquivo do Azure. :p aram source_if_none_match ETag: um valor ETag ou o caractere curinga (). Especifique esse cabeçalho condicional para copiar o blob de origem somente se a ETag não corresponder ao valor especificado. Se os valores forem idênticos, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). Esse cabeçalho não poderá ser especificado se a origem for um Arquivo do Azure. :p aram datetime destination_if_modified_since: 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 condicional para copiar o blob somente se o blob de destino tiver sido modificado desde a data/hora especificada. Se o blob de destino não tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). :p am datetime destination_if_unmodified_since: 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 condicional para copiar o blob somente se o blob de destino não tiver sido modificado desde a data/hora especificada. Se o blob de destino tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). :p aram destination_if_match ETag: um valor ETag ou o caractere curinga (). Especifique um valor ETag para esse cabeçalho condicional para copiar o blob somente se o valor ETag especificado corresponder ao valor ETag de um blob de destino existente. Se a ETag do blob de destino não corresponder à ETag especificada para If-Match, o serviço Blob retornará status código 412 (Falha de Pré-condição). :p aram ETag destination_if_none_match: um valor ETag ou o caractere curinga (). Especifique um valor ETag para esse cabeçalho condicional copiar o blob somente se o valor ETag especificado não corresponder ao valor ETag do blob de destino. Especifique o caractere curinga (*) para executar a operação somente se o blob de destino não existir. Se a condição especificada não for atendida, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). :p aram str destination_lease_id: a ID de concessão especificada para esse cabeçalho deve corresponder à ID de concessão do blob de destino. Se a solicitação não incluir a ID de concessão ou não for válida, a operação falhará com o código de status 412 (Falha na Pré-condição). :p aram str source_lease_id: especifique isso para executar a operação Copiar Blob somente se a ID de concessão fornecida corresponder à ID de concessão ativa do blob de origem. :p am int timeout: o parâmetro de tempo limite é expresso em segundos. :p aram bool requires_sync: impõe que o serviço não retornará uma resposta até que a cópia seja concluída. :p aram StandardBlobTier standard_blob_tier: 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. :p aram RehydratePriority rehydrate_priority: indica a prioridade com a qual reidratar um blob arquivado :return: copiar propriedades da operação, como status, origem e ID. :rtype: CopyProperties

create_blob_from_bytes

Cria um novo blob de uma matriz de bytes ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso.

create_blob_from_path

Cria um novo blob de um caminho de arquivo ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso.

create_blob_from_stream

Cria um novo blob de um arquivo/fluxo ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso.

create_blob_from_text

Cria um novo blob de str/unicode ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso.

create_container

Cria um novo contêiner na conta especificada. Se o contêiner com o mesmo nome já existir, a operação falhará se fail_on_exist for True.

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 Excluir Blob.

Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá temporariamente o blob ou instantâneo e manterá o blob ou instantâneo pelo 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 temporariamente é acessível por meio da API de Blobs de Lista especificando a opção include=Include.Deleted. Blob ou instantâneo excluídos temporariamente podem ser restaurados usando a API Undelete.

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.

exists

Retorna um booliano que indica se o contêiner existe (se blob_name for Nenhum) ou, caso contrário, um booliano que indica se o blob existe.

extract_date_and_request_id
generate_account_shared_access_signature

Gera uma assinatura de acesso compartilhado para o serviço blob. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.

generate_blob_shared_access_signature

Gera uma assinatura de acesso compartilhado para o blob ou um de seus instantâneos. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.

generate_container_shared_access_signature

Gera uma assinatura de acesso compartilhado para o contêiner. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.

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

get_blob_metadata

Retorna todos os metadados definidos pelo usuário para o blob ou instantâneo especificados.

get_blob_properties

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

get_blob_service_properties

Obtém as propriedades do serviço Blob de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure.

get_blob_service_stats

Recupera as estatísticas relacionadas à replicação do serviço Blob. Ela só estará disponível quando a replicação com redundância geográfica de acesso de leitura estiver habilitada para a conta de armazenamento.

Com a replicação georredundante, o Armazenamento do Azure mantém seus dados duráveis em dois locais. Em ambos os locais, o Armazenamento do Azure mantém constantemente várias réplicas íntegras de seus dados. O local onde você lê, cria, atualiza ou exclui dados é o local da conta de armazenamento principal. O local primário existe na região escolhida no momento em que você cria uma conta por meio do portal clássico do Azure Management Azure, por exemplo, Centro-Norte dos EUA. O local no qual seus dados são replicados é o local secundário. O local secundário é determinado automaticamente com base no local principal; ele está em um segundo data center que reside na mesma região que o local principal. O acesso somente leitura está disponível no local secundário se a replicação georredundante de acesso de leitura está habilitada para sua conta de armazenamento.

get_blob_to_bytes

Baixa um blob como uma matriz de bytes, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades, metadados e conteúdo.

get_blob_to_path

Baixa um blob em um caminho de arquivo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades e metadados.

get_blob_to_stream

Baixa um blob em um fluxo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades e metadados.

get_blob_to_text

Baixa um blob como texto unicode, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades, metadados e conteúdo.

get_block_list

Recupera a lista de blocos que foram carregados como parte de um blob de blocos. Há duas listas de blocos mantidas para um blob:

Lista de Blocos Confirmados: a lista de blocos que foram confirmados com êxito em um determinado blob com Put Block List.

Lista de Blocos Não Confirmada: a lista de blocos que foram carregados para um blob usando Put Block, mas que ainda não foram confirmados. Esses blocos são armazenados no Azure em associação com um blob, mas ainda não fazem parte do blob.

get_container_acl

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_metadata

Retorna todos os metadados definidos pelo usuário para o contêiner especificado.

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_user_delegation_key

Obtenha uma chave de delegação de usuário com a finalidade de assinar tokens SAS. Uma credencial de token deve estar presente no objeto de serviço para que essa solicitação seja bem-sucedida.

list_blob_names

Retorna um gerador para listar os nomes de blob no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os blobs forem retornados ou num_results for atingido.

Se num_results for especificado e a conta tiver mais do que esse número de blobs, o gerador terá um campo de next_marker preenchido quando for concluído. Esse marcador poderá ser usado para criar um novo gerador se mais resultados forem desejados.

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 e interromperá quando todos os blobs forem retornados ou num_results for atingido.

Se num_results for especificado e a conta tiver mais do que esse número de blobs, o gerador terá um campo de next_marker preenchido quando for concluído. Esse marcador poderá ser usado para criar um novo gerador se mais resultados forem desejados.

list_containers

Retorna um gerador para listar os contêineres na conta especificada. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os contêineres forem retornados ou num_results for atingido.

Se num_results for especificado e a conta tiver mais do que esse número de contêineres, o gerador terá um campo de next_marker preenchido assim que for concluído. Esse marcador poderá ser usado para criar um novo gerador se mais resultados forem desejados.

make_blob_url

Cria a URL para acessar um blob.

make_container_url

Cria a URL para acessar um contêiner.

put_block

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

put_block_from_url

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

put_block_list

Grava um blob especificando a lista de IDs de bloco que constituem o blob. Para ser gravado como parte de um blob, um bloco deve ter sido gravado com êxito no servidor em uma operação anterior put block.

Você pode chamar Put Block List para atualizar um blob carregando apenas os blocos que foram alterados e, em seguida, confirmando os blocos novos e existentes juntos. Para fazer isso, especifique se um bloco deve ser confirmado da lista de blocos confirmados ou da lista de blocos não confirmados, ou confirme a versão mais recente carregada do bloco, independentemente da lista à qual ele pertença.

release_blob_lease

Libera a concessão. A concessão poderá ser liberada se a ID especificada na solicitação corresponder à associada ao blob. A liberação da concessão permite que outro cliente adquira imediatamente a concessão do blob assim que a liberação é concluída.

release_container_lease

Libera a concessão. A concessão poderá ser liberada se o lease_id especificado corresponder ao associado ao contêiner. A liberação da concessão permite que outro cliente adquira imediatamente a concessão do contêiner assim que a liberação é concluída.

renew_blob_lease

Renova a concessão. A concessão poderá ser renovada se a ID especificada na solicitação corresponder à associada ao blob. Observe que a concessão poderá ser renovada mesmo se tiver expirado, desde que o blob não tenha sido alterado nem concedido novamente desde a expiração da concessão. Quando você renova uma concessão, o relógio de duração é redefinido.

renew_container_lease

Renova a concessão. A concessão poderá ser renovada se a ID de concessão especificada corresponder à associada ao contêiner. Observe que a concessão poderá ser renovada mesmo se tiver expirado, desde que o contêiner não tenha sido concedido novamente desde a expiração da concessão. Quando você renova uma concessão, o relógio de duração é redefinido.

set_blob_metadata

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

set_blob_properties

Define as propriedades do sistema no blob. Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas.

set_blob_service_properties

Define as propriedades do serviço Blob de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure. Se um elemento (ex Logging) for deixado como Nenhum, as configurações existentes no serviço para essa funcionalidade serão preservadas.

set_container_acl

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_proxy

Define o host e a porta do servidor proxy para o Túnel HTTP CONNECT.

set_standard_blob_tier

Define as camadas de blob de blocos no blob. Essa API só tem suporte para blobs de blocos em contas de armazenamento padrão.

:p aram RehydratePriority rehydrate_priority: indica a prioridade com a qual reidratar um blob arquivado

snapshot_blob

Cria um instantâneo somente leitura de um blob.

undelete_blob

A operação Desexcluir Blob restaura o conteúdo e os metadados de blob ou instantâneo excluídos temporariamente. A tentativa de remover um blob ou instantâneo que não é excluído temporariamente terá êxito sem nenhuma alteração.

abort_copy_blob

Anula uma operação de copy_blob pendente e deixa um blob de destino com comprimento zero e metadados completos.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner de destino.

blob_name
str
Obrigatório

Nome do blob de destino.

copy_id
str
Obrigatório

Identificador de cópia fornecido no copy.id da operação de copy_blob original.

lease_id
str
valor padrão: None

Obrigatório se o blob de destino tiver uma concessão infinita ativa.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

acquire_blob_lease

Solicita uma nova concessão. Se o blob não tiver uma concessão ativa, o serviço Blob criará uma no blob e retornará uma nova ID de concessão.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

lease_duration
int
valor padrão: -1

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

proposed_lease_id
str
valor padrão: None

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
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

str

acquire_container_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_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

lease_duration
int
valor padrão: -1

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

proposed_lease_id
str
valor padrão: None

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
valor padrão: None

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
valor padrão: None

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
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

str

batch_delete_blobs

Envia um lote de várias solicitações de exclusão de blob.

O método de exclusão de blob exclui o blob ou o instantâneo especificado. Observe que excluir um blob também exclui todos os seus instantâneos. Para obter mais informações, consulte https://docs.microsoft.com/rest/api/storageservices/delete-blob.

batch_delete_blobs(batch_delete_sub_requests, timeout=None)

Parâmetros

batch_delete_sub_requests
list(BatchDeleteSubRequest)
Obrigatório

As solicitações de exclusão de blob para enviar como um lote.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

resposta HTTP de exclusão em lote analisada

Tipo de retorno

batch_set_standard_blob_tier

Envia um lote de várias solicitações de camadas de blob de blocos definidas. Essa API só tem suporte para blobs de blocos em contas de armazenamento padrão.

batch_set_standard_blob_tier(batch_set_blob_tier_sub_requests, timeout=None)

Parâmetros

batch_set_blob_tier_sub_requests
list(BatchSetBlobTierSubRequest)
Obrigatório

O conjunto de solicitações de camada de blob de blocos a serem enviadas como um lote.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

Retornos

resposta HTTP da camada de conjunto de lotes analisada que indica se cada sub-solicitação foi bem-sucedida.

Tipo de retorno

break_blob_lease

Interrompe a concessão, se o blob tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrer, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no blob. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.

Também é possível liberar uma concessão interrompida. Nesse caso, outro cliente pode adquirir imediatamente a concessão no blob.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

lease_break_period
int
valor padrão: None

Para uma operação de interrupção, essa é a duração proposta de segundos que a concessão deve continuar antes de ser interrompida, entre 0 e 60 segundos. Esse ponto de interrupção é usado somente se for menor do que o tempo restante da concessão. Se for mais longo, o tempo restante da concessão será usado. Uma nova concessão só estará disponível após a expiração do ponto de interrupção, mas a concessão poderá ser mantida por mais tempo do que o período de interrupção. Se esse cabeçalho não aparecer com uma operação de interrupção, uma concessão de duração fixa será interrompida após o período de concessão restante passar e uma concessão infinita será interrompida imediatamente.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

INT

break_container_lease

Interrompa a concessão, se o contêiner tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrer, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no contêiner. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

lease_break_period
int
valor padrão: None

Essa é a duração proposta de segundos que a concessão deve continuar antes de ser interrompida, entre 0 e 60 segundos. Esse ponto de interrupção é usado somente se for menor do que o tempo restante da concessão. Se for mais longo, o tempo restante da concessão será usado. Uma nova concessão só estará disponível após a expiração do ponto de interrupção, mas a concessão poderá ser mantida por mais tempo do que o período de interrupção. Se esse cabeçalho não aparecer com uma operação de interrupção, uma concessão de duração fixa será interrompida após o período de concessão restante passar e uma concessão infinita será interrompida imediatamente.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

INT

change_blob_lease

Altera a ID de uma concessão ativa. Uma alteração deve incluir a ID de concessão atual e uma nova ID de concessão.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

lease_id
str
Obrigatório

Obrigatório se o blob tiver uma concessão ativa.

proposed_lease_id
str
Obrigatório

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

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

change_container_lease

Altere a ID de concessão de uma concessão ativa. Uma alteração deve incluir a ID de concessão atual e uma nova ID de concessão.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

lease_id
str
Obrigatório

ID de concessão para concessão ativa.

proposed_lease_id
str
Obrigatório

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

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

copy_blob

Copia um blob. Esta operação retorna um objeto de propriedades de operação de cópia. A operação de cópia pode ser configurada para ser uma operação assíncrona e de melhor esforço ou uma operação síncrona.

A origem deverá ser um blob de blocos se requires_sync for verdadeiro. Qualquer blob de destino existente será substituído. O blob de destino não pode ser modificado quando uma operação de cópia está em andamento.

Ao copiar de um blob de blocos, todos os blocos confirmados e suas IDs de bloco são copiados. Os blocos não confirmados não são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos confirmada que a origem.

Você pode chamar get_blob_properties no blob de destino para marcar o status da operação de cópia. O blob final será confirmado quando a cópia for concluída.

Nome do contêiner de destino. O contêiner deve existir. :p aram str blob_name: nome do blob de destino. Se o blob de destino existir, ele será substituído. Caso contrário, ele será criado. :p aram str copy_source: uma URL de até 2 KB de comprimento que especifica um arquivo ou blob do Azure. O valor deve ser codificado em URL tal como apareceria em um pedido URI. Se a origem estiver em outra conta, a origem deverá ser pública ou deve ser autenticada por meio de uma assinatura de acesso compartilhado. Se a origem for pública, nenhuma autenticação será necessária. Exemplos: https://myaccount.blob.core.windows.net/mycontainer/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?instantâneo= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken metadados :p aram: pares nome-valor associados ao blob como metadados. Se nenhum par nome-valor for especificado, a operação copiará os metadados do blob ou arquivo de origem para o blob de destino. Se um ou mais pares nome-valor forem especificados, o blob de destino será criado com os metadados especificados e os metadados não serão copiados do blob ou arquivo de origem. :type metadata: dict(str, str) :p aram datetime source_if_modified_since: 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 condicional para copiar o blob somente se o blob de origem tiver sido modificado desde a data/hora especificada. :p am datetime source_if_unmodified_since: 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 condicional para copiar o blob somente se o blob de origem não tiver sido modificado desde a data/hora especificada. :p aram source_if_match ETag: um valor ETag ou o caractere curinga (). Especifique esse cabeçalho condicional para copiar o blob de origem somente se sua ETag corresponder ao valor especificado. Se os valores ETag não corresponderem, o serviço Blob retornará status código 412 (Falha na pré-condição). Esse cabeçalho não poderá ser especificado se a origem for um Arquivo do Azure. :p aram source_if_none_match ETag: um valor ETag ou o caractere curinga (). Especifique esse cabeçalho condicional para copiar o blob de origem somente se a ETag não corresponder ao valor especificado. Se os valores forem idênticos, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). Esse cabeçalho não poderá ser especificado se a origem for um Arquivo do Azure. :p aram datetime destination_if_modified_since: 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 condicional para copiar o blob somente se o blob de destino tiver sido modificado desde a data/hora especificada. Se o blob de destino não tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). :p am datetime destination_if_unmodified_since: 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 condicional para copiar o blob somente se o blob de destino não tiver sido modificado desde a data/hora especificada. Se o blob de destino tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). :p aram destination_if_match ETag: um valor ETag ou o caractere curinga (). Especifique um valor ETag para esse cabeçalho condicional para copiar o blob somente se o valor ETag especificado corresponder ao valor ETag de um blob de destino existente. Se a ETag do blob de destino não corresponder à ETag especificada para If-Match, o serviço Blob retornará status código 412 (Falha de Pré-condição). :p aram ETag destination_if_none_match: um valor ETag ou o caractere curinga (). Especifique um valor ETag para esse cabeçalho condicional copiar o blob somente se o valor ETag especificado não corresponder ao valor ETag do blob de destino. Especifique o caractere curinga (*) para executar a operação somente se o blob de destino não existir. Se a condição especificada não for atendida, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). :p aram str destination_lease_id: a ID de concessão especificada para esse cabeçalho deve corresponder à ID de concessão do blob de destino. Se a solicitação não incluir a ID de concessão ou não for válida, a operação falhará com o código de status 412 (Falha na Pré-condição). :p aram str source_lease_id: especifique isso para executar a operação Copiar Blob somente se a ID de concessão fornecida corresponder à ID de concessão ativa do blob de origem. :p am int timeout: o parâmetro de tempo limite é expresso em segundos. :p aram bool requires_sync: impõe que o serviço não retornará uma resposta até que a cópia seja concluída. :p aram StandardBlobTier standard_blob_tier: 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. :p aram RehydratePriority rehydrate_priority: indica a prioridade com a qual reidratar um blob arquivado :return: copiar propriedades da operação, como status, origem e ID. :rtype: CopyProperties

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

Parâmetros

container_name
str
Obrigatório
blob_name
Obrigatório
copy_source
Obrigatório
metadata
valor padrão: None
source_if_modified_since
valor padrão: None
source_if_unmodified_since
valor padrão: None
source_if_match
valor padrão: None
source_if_none_match
valor padrão: None
destination_if_modified_since
valor padrão: None
destination_if_unmodified_since
valor padrão: None
destination_if_match
valor padrão: None
destination_if_none_match
valor padrão: None
destination_lease_id
valor padrão: None
source_lease_id
valor padrão: None
timeout
valor padrão: None
requires_sync
valor padrão: None
standard_blob_tier
valor padrão: None
rehydrate_priority
valor padrão: None

create_blob_from_bytes

Cria um novo blob de uma matriz de bytes ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso.

create_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob a ser criado ou atualizado.

blob
bytes
Obrigatório

Conteúdo do blob como uma matriz de bytes.

index
int
valor padrão: 0

Inicie o índice na matriz de bytes.

count
int
valor padrão: None

Número de bytes a serem carregados. Defina como Nenhum ou valor negativo para carregar todos os bytes a partir do índice.

content_settings
ContentSettings
valor padrão: None

Objeto ContentSettings usado para definir propriedades de blob.

metadata
dict(str, str)
valor padrão: None

Pares de nome-valor associados ao blob como metadados.

validate_content
bool
valor padrão: False

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 é importante 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.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor padrão: None

Retorno de chamada para progresso com função de assinatura(atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob ou Nenhum se o tamanho total for desconhecido.

max_connections
int
valor padrão: 2

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

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

standard_blob_tier
StandardBlobTier
valor padrão: None

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.

Retornos

Propriedades ETag e última modificação para o Blob de Blocos

Tipo de retorno

create_blob_from_path

Cria um novo blob de um caminho de arquivo ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso.

create_blob_from_path(container_name, blob_name, file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob a ser criado ou atualizado.

file_path
str
Obrigatório

Caminho do arquivo a ser carregado como o conteúdo do blob.

content_settings
ContentSettings
valor padrão: None

Objeto ContentSettings usado para definir propriedades de blob.

metadata
dict(str, str)
valor padrão: None

Pares de nome-valor associados ao blob como metadados.

validate_content
bool
valor padrão: False

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 é importante 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, 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.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor padrão: None

Retorno de chamada para progresso com função de assinatura(atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob ou Nenhum se o tamanho total for desconhecido.

max_connections
int
valor padrão: 2

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

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

standard_blob_tier
StandardBlobTier
valor padrão: None

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.

Retornos

Propriedades ETag e última modificação para o Blob de Blocos

Tipo de retorno

create_blob_from_stream

Cria um novo blob de um arquivo/fluxo ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso.

create_blob_from_stream(container_name, blob_name, stream, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, use_byte_buffer=False, standard_blob_tier=None, cpk=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob a ser criado ou atualizado.

stream
IOBase
Obrigatório

Arquivo/fluxo aberto para carregar como o conteúdo do blob.

count
int
valor padrão: None

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

content_settings
ContentSettings
valor padrão: None

Objeto ContentSettings usado para definir propriedades de blob.

metadata
dict(str, str)
valor padrão: None

Pares de nome-valor associados ao blob como metadados.

validate_content
bool
valor padrão: False

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 é importante 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, 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.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor padrão: None

Retorno de chamada para progresso com função de assinatura(atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob ou Nenhum se o tamanho total for desconhecido.

max_connections
int
valor padrão: 2

Número máximo de conexões paralelas a serem usadas quando o tamanho do blob exceder 64 MB. Observe que o upload paralelo requer que o fluxo seja buscado.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

use_byte_buffer
bool
valor padrão: False

Se True, isso forçará o uso do caminho de carregamento de buffer completo original. Por padrão, esse valor é False e empregará um algoritmo de carregamento de streaming com eficiência de memória sob as seguintes condições: o fluxo fornecido é buscado, 'require_encryption' é False e MAX_BLOCK_SIZE >= MIN_LARGE_BLOCK_UPLOAD_THRESHOLD. Deve-se considerar as desvantagens de usar essa abordagem. Para obter eficiência de memória, um fluxo IOBase ou objeto semelhante a arquivo é segmentado em blocos lógicos usando um wrapper SubStream. Para ler os dados corretos, cada SubStream deve adquirir um bloqueio para que possa buscar com segurança a posição certa no fluxo subjacente compartilhado. Se max_connections > 1, a simultaneidade resultará em uma quantidade considerável de busca no fluxo subjacente. Para as entradas mais comuns, como um objeto de fluxo semelhante a um arquivo, buscar é uma operação barata e isso não é uma grande preocupação. No entanto, para outras variantes de fluxos, isso pode não ser o caso. A compensação por eficiência de memória deve ser ponderada em relação ao custo de busca com o fluxo de entrada. A classe SubStream tentará armazenar em buffer até 4 MB internamente para reduzir a quantidade de chamadas de busca e leitura para o fluxo subjacente. Isso é particularmente benéfico ao carregar blocos maiores.

standard_blob_tier
StandardBlobTier
valor padrão: None

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.

Retornos

Propriedades ETag e última modificação para o Blob de Blocos

Tipo de retorno

create_blob_from_text

Cria um novo blob de str/unicode ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso.

create_blob_from_text(container_name, blob_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob a ser criado ou atualizado.

text
str
Obrigatório

Texto a ser carregado no blob.

encoding
str
valor padrão: utf-8

Codificação do Python a ser usada para converter o texto em bytes.

content_settings
ContentSettings
valor padrão: None

Objeto ContentSettings usado para definir propriedades de blob.

metadata
dict(str, str)
valor padrão: None

Pares de nome-valor associados ao blob como metadados.

validate_content
bool
valor padrão: False

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 é importante 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.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor padrão: None

Retorno de chamada para progresso com função de assinatura(atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob ou Nenhum se o tamanho total for desconhecido.

max_connections
int
valor padrão: 2

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

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

standard_blob_tier
StandardBlobTier
valor padrão: None

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

Retornos

ETag e propriedades modificadas pela última vez para o Blob de Blocos

Tipo de retorno

create_container

Cria um novo contêiner na conta especificada. Se o contêiner com o mesmo nome já existir, a operação falhará se fail_on_exist for True.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner a ser criado. O nome do contêiner pode conter apenas letras minúsculas, números e hifens e deve começar com uma letra ou um número. Cada hífen deve ser precedido e seguido por um caractere que não seja um hífen. O nome também precisa ter entre 3 e 63 caracteres.

metadata
dict(str, str)
valor padrão: None

Um dict com name_value pares a serem associados ao contêiner como metadados. Exemplo:{'Category':'test'}

public_access
PublicAccess
valor padrão: None

Os valores possíveis incluem: contêiner, blob.

fail_on_exist
bool
valor padrão: False

Especifique se deve gerar uma exceção quando o contêiner existir.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

True se o contêiner for criado, False se o contêiner já existir.

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 Excluir Blob.

Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá temporariamente o blob ou instantâneo e manterá o blob ou instantâneo pelo 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 temporariamente é acessível por meio da API de Blobs de Lista especificando a opção include=Include.Deleted. Blob ou instantâneo excluídos temporariamente podem ser restaurados usando a API Undelete.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser excluído.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

delete_snapshots
DeleteSnapshot
valor padrão: None

Obrigatório se o blob tiver instantâneos associados.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

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(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner a ser excluído.

fail_not_exist
bool
valor padrão: False

Especifique se deve gerar uma exceção quando o contêiner não existir.

lease_id
str
valor padrão: None

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
valor padrão: None

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
valor padrão: None

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.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

True se o contêiner for excluído, o contêiner False não existirá.

Tipo de retorno

exists

Retorna um booliano que indica se o contêiner existe (se blob_name for Nenhum) ou, caso contrário, um booliano que indica se o blob existe.

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

Parâmetros

container_name
str
Obrigatório

Nome de um contêiner.

blob_name
str
valor padrão: None

Nome de um blob. Se Nenhum, o contêiner será verificado quanto à existência.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

Um booliano que indica se o recurso existe.

Tipo de retorno

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parâmetros

retry_context
Obrigatório

generate_account_shared_access_signature

Gera uma assinatura de acesso compartilhado para o serviço blob. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.

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

Parâmetros

resource_types
<xref:ResourceTypes>
Obrigatório

Especifica os tipos de recursos acessíveis com a SAS da conta.

permission
<xref:AccountPermissions>
Obrigatório

As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada.

expiry
datetime ou str
Obrigatório

A hora em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC.

start
datetime ou str
valor padrão: None

A hora em que a assinatura de acesso compartilhado se torna válida. Se for omitido, a hora de início para essa chamada será presumida como a hora na qual o serviço de armazenamento recebe a solicitação. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC.

ip
str
valor padrão: None

Especifica um endereço IP ou um intervalo de endereços IP dos quais aceitar solicitações. Se o endereço IP do qual a solicitação se origina não corresponder ao endereço IP ou ao intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 na SAS restringe a solicitação a esses endereços IP.

protocol
str
valor padrão: None

Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.

Retornos

Um token sas (Assinatura de Acesso Compartilhado).

Tipo de retorno

str

generate_blob_shared_access_signature

Gera uma assinatura de acesso compartilhado para o blob ou um de seus instantâneos. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner.

blob_name
str
Obrigatório

Nome do blob.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob para conceder permissão.

permission
BlobPermissions
valor padrão: None

As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. As permissões devem ser ordenadas para leitura, gravação, exclusão, lista. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada.

expiry
datetime ou str
valor padrão: None

A hora em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC.

start
datetime ou str
valor padrão: None

A hora em que a assinatura de acesso compartilhado se torna válida. Se for omitido, a hora de início para essa chamada será presumida como a hora na qual o serviço de armazenamento recebe a solicitação. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC.

id
str
valor padrão: None

Um valor exclusivo de até 64 caracteres que se correlaciona a uma política de acesso armazenada. Para criar uma política de acesso armazenada, use set_container_acl.

ip
str
valor padrão: None

Especifica um endereço IP ou um intervalo de endereços IP dos quais aceitar solicitações. Se o endereço IP do qual a solicitação se origina não corresponder ao endereço IP ou ao intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 na SAS restringe a solicitação a esses endereços IP.

protocol
str
valor padrão: None

Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.

cache_control
str
valor padrão: None

Valor do cabeçalho de resposta para Cache-Control quando o recurso é acessado usando essa assinatura de acesso compartilhado.

content_disposition
str
valor padrão: None

Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acessado usando essa assinatura de acesso compartilhado.

content_encoding
str
valor padrão: None

Valor do cabeçalho de resposta para Codificação de Conteúdo quando o recurso é acessado usando essa assinatura de acesso compartilhado.

content_language
str
valor padrão: None

Valor do cabeçalho de resposta para Content-Language quando o recurso é acessado usando essa assinatura de acesso compartilhado.

content_type
str
valor padrão: None

Valor do cabeçalho de resposta para Content-Type quando o recurso é acessado usando essa assinatura de acesso compartilhado.

user_delegation_key
UserDelegationKey
valor padrão: None

Em vez de uma chave de conta, o usuário pode passar uma chave de delegação de usuário. Uma chave de delegação de usuário pode ser obtida do serviço autenticando-se com uma identidade do AAD; isso pode ser feito chamando get_user_delegation_key. Quando presente, a SAS é assinada com a chave de delegação do usuário.

Retornos

Um token sas (Assinatura de Acesso Compartilhado).

Tipo de retorno

str

generate_container_shared_access_signature

Gera uma assinatura de acesso compartilhado para o contêiner. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner.

permission
ContainerPermissions
valor padrão: None

As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. As permissões devem ser ordenadas para leitura, gravação, exclusão, lista. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada.

expiry
datetime ou str
valor padrão: None

A hora em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC.

start
datetime ou str
valor padrão: None

A hora em que a assinatura de acesso compartilhado se torna válida. Se for omitido, a hora de início para essa chamada será presumida como a hora na qual o serviço de armazenamento recebe a solicitação. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC.

id
str
valor padrão: None

Um valor exclusivo de até 64 caracteres que se correlaciona a uma política de acesso armazenada. Para criar uma política de acesso armazenada, use set_blob_service_properties.

ip
str
valor padrão: None

Especifica um endereço IP ou um intervalo de endereços IP dos quais aceitar solicitações. Se o endereço IP do qual a solicitação se origina não corresponder ao endereço IP ou ao intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 na SAS restringe a solicitação a esses endereços IP.

protocol
str
valor padrão: None

Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.

cache_control
str
valor padrão: None

Valor do cabeçalho de resposta para Cache-Control quando o recurso é acessado usando essa assinatura de acesso compartilhado.

content_disposition
str
valor padrão: None

Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acessado usando essa assinatura de acesso compartilhado.

content_encoding
str
valor padrão: None

Valor do cabeçalho de resposta para Codificação de Conteúdo quando o recurso é acessado usando essa assinatura de acesso compartilhado.

content_language
str
valor padrão: None

Valor do cabeçalho de resposta para Content-Language quando o recurso é acessado usando essa assinatura de acesso compartilhado.

content_type
str
valor padrão: None

Valor do cabeçalho de resposta para Content-Type quando o recurso é acessado usando essa assinatura de acesso compartilhado.

user_delegation_key
UserDelegationKey
valor padrão: None

Em vez de uma chave de conta, o usuário pode passar uma chave de delegação de usuário. Uma chave de delegação de usuário pode ser obtida do serviço autenticando-se com uma identidade do AAD; isso pode ser feito chamando get_user_delegation_key. Quando presente, a SAS é assinada com a chave de delegação do usuário.

Retornos

Um token sas (Assinatura de Acesso Compartilhado).

Tipo de retorno

str

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

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

Parâmetros

container_name
str
valor padrão: None

Nome do contêiner existente. Opcional, a menos que use um token SAS para um contêiner ou blob específico, nesse caso ele é necessário.

blob_name
str
valor padrão: None

Nome do blob existente. Opcional, a menos que use um token SAS para um blob específico, nesse caso ele é necessário.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

O AccountInformation.

get_blob_metadata

Retorna todos os metadados definidos pelo usuário para o blob ou instantâneo especificados.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

Um dicionário que representa o nome dos metadados de blob, pares de valor.

Tipo de retorno

get_blob_properties

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

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

um objeto blob, incluindo propriedades e metadados.

Tipo de retorno

get_blob_service_properties

Obtém as propriedades do serviço Blob de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure.

get_blob_service_properties(timeout=None)

Parâmetros

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

O blob ServiceProperties com uma propriedade target_version anexada.

get_blob_service_stats

Recupera as estatísticas relacionadas à replicação do serviço Blob. Ela só estará disponível quando a replicação com redundância geográfica de acesso de leitura estiver habilitada para a conta de armazenamento.

Com a replicação georredundante, o Armazenamento do Azure mantém seus dados duráveis em dois locais. Em ambos os locais, o Armazenamento do Azure mantém constantemente várias réplicas íntegras de seus dados. O local onde você lê, cria, atualiza ou exclui dados é o local da conta de armazenamento principal. O local primário existe na região escolhida no momento em que você cria uma conta por meio do portal clássico do Azure Management Azure, por exemplo, Centro-Norte dos EUA. O local no qual seus dados são replicados é o local secundário. O local secundário é determinado automaticamente com base no local principal; ele está em um segundo data center que reside na mesma região que o local principal. O acesso somente leitura está disponível no local secundário se a replicação georredundante de acesso de leitura está habilitada para sua conta de armazenamento.

get_blob_service_stats(timeout=None)

Parâmetros

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

As estatísticas do serviço blob.

Tipo de retorno

get_blob_to_bytes

Baixa um blob como uma matriz de bytes, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades, metadados e conteúdo.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.

start_range
int
valor padrão: None

Início do intervalo de bytes a ser usado para baixar uma seção do blob. Se nenhuma end_range for fornecida, todos os bytes após o start_range serão baixados. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.

end_range
int
valor padrão: None

Fim do intervalo de bytes a ser usado para baixar uma seção do blob. Se end_range for fornecido, start_range deverá ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.

validate_content
bool
valor padrão: False

Se definido como true, valida um hash MD5 para cada parte recuperada do blob. Isso é importante principalmente para detectar bitflips no fio se o uso de http em vez de https como https (o padrão) já validará. Observe que o serviço retornará apenas MD5s transacionais para partes de 4 MB ou menos, portanto, a primeira solicitação get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como maior que 4 MB, um erro será gerado. Como a computação do MD5 leva tempo de processamento e mais solicitações precisarão ser feitas devido ao tamanho reduzido da parte, pode haver algum aumento na latência.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor padrão: None

Retorno de chamada para progresso com função de assinatura(atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob, se conhecido.

max_connections
int
valor padrão: 2

Se definido como 2 ou superior, uma obtenção inicial será feita para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se esse for o blob inteiro, o método retornará neste ponto. Se não estiver, ele baixará os dados restantes paralelos usando o número de threads igual a max_connections. Cada parte será de tamanho próprio. MAX_CHUNK_GET_SIZE. Se definido como 1, uma única solicitação get grande será feita. Isso geralmente não é recomendado, mas está disponível se muito poucos threads devem ser usados, as solicitações de rede são muito caras ou um fluxo não pesquisável impede o download paralelo. Isso também pode ser útil se muitos blobs devem estar vazios, pois uma solicitação extra é necessária para blobs vazios se max_connections for maior que 1.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

Retornos

Um Blob com propriedades e metadados. Se max_connections for maior que 1, o content_md5 (se definido no blob) não será retornado. Se você precisar desse valor, use get_blob_properties ou defina max_connections como 1.

Tipo de retorno

get_blob_to_path

Baixa um blob em um caminho de arquivo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades e metadados.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

file_path
str
Obrigatório

Caminho do arquivo para o qual gravar.

open_mode
str
valor padrão: wb

Modo a ser usado ao abrir o arquivo. Observe que a especificação de acréscimo apenas open_mode impede o download paralelo. Portanto, max_connections deve ser definido como 1 se esse open_mode for usado.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.

start_range
int
valor padrão: None

Início do intervalo de bytes a ser usado para baixar uma seção do blob. Se nenhuma end_range for fornecida, todos os bytes após a start_range serão baixados. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.

end_range
int
valor padrão: None

Fim do intervalo de bytes a ser usado para baixar uma seção do blob. Se end_range for fornecido, start_range deverá ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.

validate_content
bool
valor padrão: False

Se definido como true, valida um hash MD5 para cada parte recuperada do blob. Isso é importante principalmente para detectar bitflips na transmissão se usar http em vez de https como https (o padrão) já será validado. Observe que o serviço retornará apenas MD5s transacionais para partes de 4 MB ou menos, portanto, a primeira solicitação get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como maior que 4 MB, um erro será gerado. Como a computação do MD5 leva tempo de processamento e mais solicitações precisarão ser feitas devido ao tamanho reduzido da parte, pode haver algum aumento na latência.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor padrão: None

Retorno de chamada para progresso com a função de assinatura (atual, total) em que current é o número de bytes transferidos até agora, e total é o tamanho do blob, se conhecido.

max_connections
int
valor padrão: 2

Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se esse for o blob inteiro, o método retornará neste ponto. Se não estiver, ele baixará os dados restantes paralelos usando o número de threads igual a max_connections. Cada parte será de tamanho próprio. MAX_CHUNK_GET_SIZE. Se definido como 1, uma única solicitação de obtenção grande será feita. Isso geralmente não é recomendado, mas está disponível se muito poucos threads devem ser usados, as solicitações de rede são muito caras ou um fluxo não pesquisável impede o download paralelo. Isso também pode ser útil se muitos blobs devem estar vazios, pois uma solicitação extra é necessária para blobs vazios se max_connections for maior que 1.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

Retornos

Um Blob com propriedades e metadados. Se max_connections for maior que 1, o content_md5 (se definido no blob) não será retornado. Se você precisar desse valor, use get_blob_properties ou defina max_connections como 1.

Tipo de retorno

get_blob_to_stream

Baixa um blob em um fluxo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades e metadados.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

stream
IOBase
Obrigatório

Fluxo aberto para gravar.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.

start_range
int
valor padrão: None

Início do intervalo de bytes a ser usado para baixar uma seção do blob. Se nenhuma end_range for fornecida, todos os bytes após a start_range serão baixados. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.

end_range
int
valor padrão: None

Fim do intervalo de bytes a ser usado para baixar uma seção do blob. Se end_range for fornecido, start_range deverá ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.

validate_content
bool
valor padrão: False

Se definido como true, valida um hash MD5 para cada parte recuperada do blob. Isso é importante principalmente para detectar bitflips na transmissão se usar http em vez de https como https (o padrão) já será validado. Observe que o serviço retornará apenas MD5s transacionais para partes de 4 MB ou menos, portanto, a primeira solicitação get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como maior que 4 MB, um erro será gerado. Como a computação do MD5 leva tempo de processamento e mais solicitações precisarão ser feitas devido ao tamanho reduzido da parte, pode haver algum aumento na latência.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor padrão: None

Retorno de chamada para progresso com a função de assinatura (atual, total) em que current é o número de bytes transferidos até agora, e total é o tamanho do blob, se conhecido.

max_connections
int
valor padrão: 2

Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se esse for o blob inteiro, o método retornará neste ponto. Se não estiver, ele baixará os dados restantes paralelos usando o número de threads igual a max_connections. Cada parte será de tamanho próprio. MAX_CHUNK_GET_SIZE. Se definido como 1, uma única solicitação de obtenção grande será feita. Isso geralmente não é recomendado, mas está disponível se muito poucos threads devem ser usados, as solicitações de rede são muito caras ou um fluxo não pesquisável impede o download paralelo. Isso também pode ser útil se muitos blobs devem estar vazios, pois uma solicitação extra é necessária para blobs vazios se max_connections for maior que 1.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

Retornos

Um Blob com propriedades e metadados. Se max_connections for maior que 1, o content_md5 (se definido no blob) não será retornado. Se você precisar desse valor, use get_blob_properties ou defina max_connections como 1.

Tipo de retorno

get_blob_to_text

Baixa um blob como texto unicode, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades, metadados e conteúdo.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

encoding
str
valor padrão: utf-8

Codificação do Python a ser usada ao decodificar os dados de blob.

snapshot
str
valor padrão: None

O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.

start_range
int
valor padrão: None

Início do intervalo de bytes a ser usado para baixar uma seção do blob. Se nenhuma end_range for fornecida, todos os bytes após a start_range serão baixados. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.

end_range
int
valor padrão: None

Fim do intervalo de bytes a ser usado para baixar uma seção do blob. Se end_range for fornecido, start_range deverá ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.

validate_content
bool
valor padrão: False

Se definido como true, valida um hash MD5 para cada parte recuperada do blob. Isso é importante principalmente para detectar bitflips na transmissão se usar http em vez de https como https (o padrão) já será validado. Observe que o serviço retornará apenas MD5s transacionais para partes de 4 MB ou menos, portanto, a primeira solicitação get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como maior que 4 MB, um erro será gerado. Como a computação do MD5 leva tempo de processamento e mais solicitações precisarão ser feitas devido ao tamanho reduzido da parte, pode haver algum aumento na latência.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
valor padrão: None

Retorno de chamada para progresso com a função de assinatura (atual, total) em que current é o número de bytes transferidos até agora, e total é o tamanho do blob, se conhecido.

max_connections
int
valor padrão: 2

Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se esse for o blob inteiro, o método retornará neste ponto. Se não estiver, ele baixará os dados restantes paralelos usando o número de threads igual a max_connections. Cada parte será de tamanho próprio. MAX_CHUNK_GET_SIZE. Se definido como 1, uma única solicitação de obtenção grande será feita. Isso geralmente não é recomendado, mas está disponível se muito poucos threads devem ser usados, as solicitações de rede são muito caras ou um fluxo não pesquisável impede o download paralelo. Isso também pode ser útil se muitos blobs devem estar vazios, pois uma solicitação extra é necessária para blobs vazios se max_connections for maior que 1.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

Retornos

Um Blob com propriedades e metadados. Se max_connections for maior que 1, o content_md5 (se definido no blob) não será retornado. Se você precisar desse valor, use get_blob_properties ou defina max_connections como 1.

Tipo de retorno

get_block_list

Recupera a lista de blocos que foram carregados como parte de um blob de blocos. Há duas listas de blocos mantidas para um blob:

Lista de Blocos Confirmados: a lista de blocos que foram confirmados com êxito em um determinado blob com Put Block List.

Lista de Blocos Não Confirmada: a lista de blocos que foram carregados para um blob usando Put Block, mas que ainda não foram confirmados. Esses blocos são armazenados no Azure em associação com um blob, mas ainda não fazem parte do blob.

get_block_list(container_name, blob_name, snapshot=None, block_list_type=None, lease_id=None, timeout=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

snapshot
str
valor padrão: None

Datetime para determinar a hora de recuperar os blocos.

block_list_type
str
valor padrão: None

Especifica se é necessário retornar a lista de blocos confirmados, a lista de blocos não confirmados ou as duas listas. Os valores válidos são: confirmados, não confirmados ou todos.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

listar blocos confirmados e/ou não confirmados para Blob de Blocos

Tipo de retorno

get_container_acl

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_acl(container_name, lease_id=None, timeout=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

lease_id
valor padrão: None

Se especificado, get_container_acl só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

Um dicionário de políticas de acesso associadas ao contêiner. dict de str to AccessPolicy e uma propriedade public_access se o acesso público estiver ativado

get_container_metadata

Retorna todos os metadados definidos pelo usuário para o contêiner especificado.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

lease_id
str
valor padrão: None

Se especificado, get_container_metadata só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

Um dicionário que representa o nome dos metadados do contêiner, pares de valor.

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(container_name, lease_id=None, timeout=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

lease_id
str
valor padrão: None

Se especificado, get_container_properties só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

para o contêiner especificado dentro de um objeto de contêiner.

Tipo de retorno

get_user_delegation_key

Obtenha uma chave de delegação de usuário com a finalidade de assinar tokens SAS. Uma credencial de token deve estar presente no objeto de serviço para que essa solicitação seja bem-sucedida.

get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)

Parâmetros

key_start_time
datetime
Obrigatório

Um valor Datetime. Indica quando a chave se torna válida.

key_expiry_time
datetime
Obrigatório

Um valor Datetime. Indica quando a chave deixa de ser válida.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

A chave de delegação do usuário.

Tipo de retorno

list_blob_names

Retorna um gerador para listar os nomes de blob no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os blobs forem retornados ou num_results for atingido.

Se num_results for especificado e a conta tiver mais do que esse número de blobs, o gerador terá um campo de next_marker preenchido quando for concluído. Esse marcador poderá ser usado para criar um novo gerador se mais resultados forem desejados.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

prefix
str
valor padrão: None

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

num_results
int
valor padrão: None

Especifica o número máximo de blobs a ser retornado, inclusive todos os elementos <xref:azure.storage.blob.blockblobservice.BlobPrefix>. Se a solicitação não especificar num_results ou especificar um valor maior que 5.000, o servidor retornará até 5.000 itens. Definir num_results como um valor menor ou igual a zero resulta no código de resposta de erro 400 (solicitação incorreta).

include
Include
valor padrão: None

Especifica um ou mais conjuntos de dados adicionais a serem incluídos na resposta.

delimiter
str
valor padrão: None

Quando a solicitação inclui esse parâmetro, a operação retorna um BlobPrefix elemento na lista de resultados 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.

marker
str
valor padrão: None

Um token de continuação opaco. Esse valor poderá ser recuperado do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver terminado de enumerar os resultados. Se especificado, esse gerador começará a retornar resultados do ponto em que o gerador anterior parou.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

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 e interromperá quando todos os blobs forem retornados ou num_results for atingido.

Se num_results for especificado e a conta tiver mais do que esse número de blobs, o gerador terá um campo de next_marker preenchido quando for concluído. Esse marcador poderá ser usado para criar um novo gerador se mais resultados forem desejados.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

prefix
str
valor padrão: None

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

num_results
int
valor padrão: None

Especifica o número máximo de blobs a ser retornado, inclusive todos os elementos <xref:azure.storage.blob.blockblobservice.BlobPrefix>. Se a solicitação não especificar num_results ou especificar um valor maior que 5.000, o servidor retornará até 5.000 itens. Definir num_results como um valor menor ou igual a zero resulta no código de resposta de erro 400 (solicitação incorreta).

include
Include
valor padrão: None

Especifica um ou mais conjuntos de dados adicionais a serem incluídos na resposta.

delimiter
str
valor padrão: None

Quando a solicitação inclui esse parâmetro, a operação retorna um BlobPrefix elemento na lista de resultados 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.

marker
str
valor padrão: None

Um token de continuação opaco. Esse valor poderá ser recuperado do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver terminado de enumerar os resultados. Se especificado, esse gerador começará a retornar resultados do ponto em que o gerador anterior parou.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

list_containers

Retorna um gerador para listar os contêineres na conta especificada. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os contêineres forem retornados ou num_results for atingido.

Se num_results for especificado e a conta tiver mais do que esse número de contêineres, o gerador terá um campo de next_marker preenchido assim que for concluído. Esse marcador poderá ser usado para criar um novo gerador se mais resultados forem desejados.

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

Parâmetros

prefix
str
valor padrão: None

Filtra os resultados para retornar somente contêineres cujos nomes começam com o prefixo especificado.

num_results
int
valor padrão: None

Especifica o número máximo de contêineres a serem retornados. Uma única solicitação de lista pode retornar até 1000 contianers e, potencialmente, um token de continuação que deve ser seguido para obter resutls adicionais.

include_metadata
bool
valor padrão: False

Especifica que os metadados de contêiner sejam retornados na resposta.

marker
str
valor padrão: None

Um token de continuação opaco. Esse valor poderá ser recuperado do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver terminado de enumerar os resultados. Se especificado, esse gerador começará a retornar resultados do ponto em que o gerador anterior parou.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

make_blob_url

Cria a URL para acessar um blob.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner.

blob_name
str
Obrigatório

Nome do blob.

protocol
str
valor padrão: None

Protocolo a ser usado: 'http' ou 'https'. Se não for especificado, usará o protocolo especificado quando BaseBlobService foi inicializado.

sas_token
str
valor padrão: None

Token de assinatura de acesso compartilhado criado com generate_shared_access_signature.

snapshot
str
valor padrão: None

Um valor de cadeia de caracteres que identifica exclusivamente o instantâneo. O valor desse parâmetro de consulta indica a versão instantâneo.

Retornos

URL de acesso a blob.

Tipo de retorno

str

make_container_url

Cria a URL para acessar um contêiner.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner.

protocol
str
valor padrão: None

Protocolo a ser usado: 'http' ou 'https'. Se não for especificado, usará o protocolo especificado quando BaseBlobService foi inicializado.

sas_token
str
valor padrão: None

Token de assinatura de acesso compartilhado criado com generate_shared_access_signature.

Retornos

URL de acesso de contêiner.

Tipo de retorno

str

put_block

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

put_block(container_name, blob_name, block, block_id, validate_content=False, lease_id=None, timeout=None, cpk=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob.

block
IOBase ou <xref:<xref:bytes Content> of <xref:the block.>>
Obrigatório

Conteúdo do bloco.

block_id
str
Obrigatório

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

validate_content
bool
valor padrão: False

Se for true, calculará um hash MD5 do conteúdo do bloco. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é importante 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.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

put_block_from_url

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

put_block_from_url(container_name, blob_name, copy_source_url, block_id, source_range_start=None, source_range_end=None, source_content_md5=None, lease_id=None, timeout=None, cpk=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob.

copy_source_url
str
Obrigatório

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

source_range_start
int
valor padrão: None

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

source_range_end
int
valor padrão: None

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

block_id
str
Obrigatório

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

source_content_md5
str
valor padrão: None

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

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

put_block_list

Grava um blob especificando a lista de IDs de bloco que constituem o blob. Para ser gravado como parte de um blob, um bloco deve ter sido gravado com êxito no servidor em uma operação anterior put block.

Você pode chamar Put Block List para atualizar um blob carregando apenas os blocos que foram alterados e, em seguida, confirmando os blocos novos e existentes juntos. Para fazer isso, especifique se um bloco deve ser confirmado da lista de blocos confirmados ou da lista de blocos não confirmados, ou confirme a versão mais recente carregada do bloco, independentemente da lista à qual ele pertença.

put_block_list(container_name, blob_name, block_list, content_settings=None, metadata=None, validate_content=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

block_list
list(BlobBlock)
Obrigatório

Uma lista de <xref:azure.storeage.blob.models.BlobBlock> que contém as IDs de bloco e o estado do bloco.

content_settings
ContentSettings
valor padrão: None

Objeto ContentSettings usado para definir propriedades no blob.

metadata
dict(str, str)
valor padrão: None

Pares de nome-valor associados ao blob como metadados.

validate_content
bool
valor padrão: False

Se for true, calculará um hash MD5 do conteúdo da lista de blocos. O serviço de armazenamento verifica o hash do conteúdo da lista de blocos que chegou com o hash que foi enviado. Isso é importante 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 marcar está associado ao conteúdo da lista de blocos e não ao conteúdo do blob em si.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

standard_blob_tier
StandardBlobTier
valor padrão: None

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.

Retornos

ETag e propriedades modificadas pela última vez para o Blob de Blocos atualizado

Tipo de retorno

release_blob_lease

Libera a concessão. A concessão poderá ser liberada se a ID especificada na solicitação corresponder à associada ao blob. A liberação da concessão permite que outro cliente adquira imediatamente a concessão do blob assim que a liberação é concluída.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

lease_id
str
Obrigatório

ID de concessão para concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

release_container_lease

Libera a concessão. A concessão poderá ser liberada se o lease_id especificado corresponder ao associado ao contêiner. A liberação da concessão permite que outro cliente adquira imediatamente a concessão do contêiner assim que a liberação é concluída.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

lease_id
str
Obrigatório

ID de concessão para concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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
valor padrão: None

O parâmetro timeout é expresso em segundos.

renew_blob_lease

Renova a concessão. A concessão poderá ser renovada se a ID especificada na solicitação corresponder à associada ao blob. Observe que a concessão poderá ser renovada mesmo se tiver expirado, desde que o blob não tenha sido alterado nem concedido novamente desde a expiração da concessão. Quando você renova uma concessão, o relógio de duração é redefinido.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

lease_id
str
Obrigatório

ID de concessão para concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

str

renew_container_lease

Renova a concessão. A concessão poderá ser renovada se a ID de concessão especificada corresponder à associada ao contêiner. Observe que a concessão poderá ser renovada mesmo se tiver expirado, desde que o contêiner não tenha sido concedido novamente desde a expiração da concessão. Quando você renova uma concessão, o relógio de duração é redefinido.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

lease_id
str
Obrigatório

ID de concessão para concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

str

set_blob_metadata

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

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

metadata
dict(str, str)
valor padrão: None

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

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

Propriedades ETag e última modificação para o Blob atualizado

Tipo de retorno

set_blob_properties

Define as propriedades do sistema no blob. Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

content_settings
ContentSettings
valor padrão: None

Objeto ContentSettings usado para definir propriedades de blob.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

Propriedades ETag e última modificação para o Blob atualizado

Tipo de retorno

set_blob_service_properties

Define as propriedades do serviço Blob de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure. Se um elemento (ex Logging) for deixado como Nenhum, as configurações existentes no serviço para essa funcionalidade serão preservadas.

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

Parâmetros

logging
Logging
valor padrão: None

Agrupa as configurações de Log da Análise do Azure.

hour_metrics
Metrics
valor padrão: None

As configurações de métricas de hora fornecem um resumo das estatísticas de solicitação agrupadas pela API em agregações por hora para blobs.

minute_metrics
Metrics
valor padrão: None

As configurações de métricas de minuto fornecem estatísticas de solicitação para cada minuto para blobs.

cors
list(CorsRule)
valor padrão: None

Você pode incluir até cinco elementos CorsRule na lista. Se uma lista vazia for especificada, todas as regras CORS serão excluídas e o CORS será desabilitado para o serviço.

target_version
str
valor padrão: None

Indica a versão padrão a ser usada para solicitações se a versão de uma solicitação de entrada não for especificada.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

delete_retention_policy
DeleteRetentionPolicy
valor padrão: None

A política de retenção de exclusão especifica se os blobs excluídos devem ser retidos. Ele também especifica o número de dias e versões do blob a serem mantidos.

static_website
StaticWebsite
valor padrão: None

Especifica se o recurso de site estático está habilitado e, se sim, indica o documento de índice e o documento de erro 404 a ser usado.

set_container_acl

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_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

signed_identifiers
dict(str, AccessPolicy)
valor padrão: None

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.

public_access
PublicAccess
valor padrão: None

Os valores possíveis incluem: contêiner, blob.

lease_id
str
valor padrão: None

Se especificado, set_container_acl só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

ETag e propriedades modificadas pela última vez para o contêiner atualizado

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(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

metadata
dict(str, str)
valor padrão: None

Um ditado que contém pares nome-valor a serem associados ao contêiner como metadados. Exemplo: {'category':'test'}

lease_id
str
valor padrão: None

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
valor padrão: None

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.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

ETag e propriedades modificadas pela última vez para o contêiner atualizado

Tipo de retorno

set_proxy

Define o host e a porta do servidor proxy para o Túnel HTTP CONNECT.

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

Parâmetros

host
str
Obrigatório

Endereço do proxy. Ex: '192.168.0.100'

port
int
Obrigatório

Porta do proxy. Ex: 6000

user
str
valor padrão: None

Usuário para autorização de proxy.

password
str
valor padrão: None

Senha para autorização de proxy.

set_standard_blob_tier

Define as camadas de blob de blocos no blob. Essa API só tem suporte para blobs de blocos em contas de armazenamento padrão.

:p aram RehydratePriority rehydrate_priority: indica a prioridade com a qual reidratar um blob arquivado

set_standard_blob_tier(container_name, blob_name, standard_blob_tier, timeout=None, rehydrate_priority=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob a ser atualizado.

standard_blob_tier
StandardBlobTier
Obrigatório

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.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.

rehydrate_priority
valor padrão: None

snapshot_blob

Cria um instantâneo somente leitura de um blob.

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

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

metadata
dict(str, str)
valor padrão: None

Especifica um par de nome-valor definido pelo usuário associado ao blob. Se nenhum par de nome-valor for especificado, a operação copiará os metadados do blob de base no instantâneo. Se um ou mais pares de nome-valor forem especificados, o instantâneo será criado com os metadados especificados, e os metadados não serão copiados do blob de base.

if_modified_since
datetime
valor padrão: None

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
valor padrão: None

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.

if_match
str
valor padrão: None

Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.

if_none_match
str
valor padrão: None

Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.

lease_id
str
valor padrão: None

Obrigatório se o blob tiver uma concessão ativa.

cpk
CustomerProvidedEncryptionKey
valor padrão: None

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

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Retornos

instantâneo propriedades

Tipo de retorno

undelete_blob

A operação Desexcluir Blob restaura o conteúdo e os metadados de blob ou instantâneo excluídos temporariamente. A tentativa de remover um blob ou instantâneo que não é excluído temporariamente terá êxito sem nenhuma alteração.

undelete_blob(container_name, blob_name, timeout=None)

Parâmetros

container_name
str
Obrigatório

Nome do contêiner existente.

blob_name
str
Obrigatório

Nome do blob existente.

timeout
int
valor padrão: None

O parâmetro timeout é expresso em segundos.

Atributos

protocol

request_session

socket_timeout

MAX_BLOCK_SIZE

MAX_BLOCK_SIZE = 4194304

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432

MAX_SINGLE_PUT_SIZE

MAX_SINGLE_PUT_SIZE = 67108864

MIN_LARGE_BLOCK_UPLOAD_THRESHOLD

MIN_LARGE_BLOCK_UPLOAD_THRESHOLD = 4194305