AppendBlobService Classe

Um blob de acréscimo é composto por blocos e está otimizado para operações de acréscimo. Quando modifica um blob de acréscimo, os blocos são adicionados apenas ao fim do blob, através da operação de append_block. A atualização ou eliminação de blocos existentes não é suportada. Ao contrário de um blob de blocos, um blob de acréscimo não expõe os respetivos IDs de bloco.

Cada bloco num blob de acréscimo pode ter um tamanho diferente, até um máximo de 4 MB, e um blob de acréscimo pode incluir até 50 000 blocos. Por conseguinte, o tamanho máximo de um blob de acréscimo é ligeiramente superior a 195 GB (4 MB X 50 000 blocos).

:type ~azure.storage.common.TokenCredential

Herança

BaseBlobService

AppendBlobService

Construtor

AppendBlobService(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 predefinido: None

O nome da conta de armazenamento. Isto é utilizado para autenticar pedidos assinados com uma chave de conta e para construir o ponto final de armazenamento. É necessário, a menos que seja dada uma cadeia de ligação ou se um domínio personalizado for utilizado com autenticação anónima.

account_key

str

valor predefinido: None

A chave da conta de armazenamento. Isto é utilizado para autenticação de chave partilhada. Se não for especificado nenhum token de chave de conta ou sas, será utilizado o acesso anónimo.

sas_token

str

valor predefinido: None

Um token de assinatura de acesso partilhado para utilizar para autenticar pedidos em vez da chave de conta. Se a chave de conta e o token sas forem especificados, a chave de conta será utilizada para assinar. Se nenhum dos dois for especificado, será utilizado o acesso anónimo.

is_emulated

bool

valor predefinido: False

Se pretende utilizar o emulador. Predefinições para Falso. Se especificado, substituirá todos os outros parâmetros para além de cadeia de ligação e pedir sessão.

protocol

str

valor predefinido: https

O protocolo a utilizar para pedidos. Predefinições para https.

endpoint_suffix

str

valor predefinido: core.windows.net

O componente base do anfitrião do URL, menos o nome da conta. Predefinições para o Azure (core.windows.net). Substitua-o para utilizar a cloud da China (core.chinacloudapi.cn).

custom_domain

str

valor predefinido: None

O domínio personalizado a utilizar. Isto pode ser definido no Portal do Azure. Por exemplo, "www.mydomain.com".

request_session

<xref:requests.Session>

valor predefinido: None

O objeto de sessão a utilizar para pedidos http.

connection_string

str

valor predefinido: None

Se for especificado, esta ação substituirá todos os outros parâmetros para além da sessão de pedido. Veja http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ o formato cadeia de ligação.

socket_timeout

int

valor predefinido: None

Se especificado, isto substituirá o tempo limite predefinido do socket. O tempo limite especificado é em segundos. Veja DEFAULT_SOCKET_TIMEOUT em _constants.py para obter o valor predefinido.

token_credential

valor predefinido: None

Uma credencial de token utilizada para autenticar pedidos HTTPS. O valor do token deve ser atualizado antes da expiração.

Variáveis

MAX_BLOCK_SIZE

int

O tamanho dos blocos colocados pelos métodos append_blob_from_*. Podem ser colocados blocos mais pequenos se existirem menos dados fornecidos. O tamanho máximo de bloco suportado pelo serviço é 4 MB.

Métodos

abort_copy_blob	Aborta uma operação de copy_blob pendente e deixa um blob de destino com comprimento zero e metadados completos.
acquire_blob_lease	Pede uma nova concessão. Se o blob não tiver uma concessão ativa, o serviço Blob cria uma concessão no blob e devolve um novo ID de concessão.
acquire_container_lease	Pede uma nova concessão. Se o contentor não tiver uma concessão ativa, o serviço Blob cria uma concessão no contentor e devolve um novo ID de concessão.
append_blob_from_bytes	Anexa ao conteúdo de um blob existente a partir de uma matriz de bytes, com segmentação automática e notificações de progresso.
append_blob_from_path	Anexa ao conteúdo de um blob existente a partir de um caminho de ficheiro, com segmentação automática e notificações de progresso.
append_blob_from_stream	Anexa ao conteúdo de um blob existente a partir de um ficheiro/fluxo, com segmentação automática e notificações de progresso.
append_blob_from_text	Anexa ao conteúdo de um blob existente a partir de str/unicode, com segmentação automática e notificações de progresso.
append_block	Consolida um novo bloco de dados no final de um blob de acréscimo existente.
append_block_from_url	Cria um novo bloco a ser consolidado como parte de um blob, onde os conteúdos são lidos a partir de um URL de origem.
batch_delete_blobs	Envia um lote de vários pedidos de eliminação de blobs. O método de eliminação de blobs elimina o blob ou instantâneo especificado. Tenha em atenção que eliminar um blob também elimina todos os respetivos instantâneos. Para mais informações, consulte https://docs.microsoft.com/rest/api/storageservices/delete-blob
break_blob_lease	Interrompe a concessão, se o blob tiver uma concessão ativa. Depois de uma concessão ser interrompida, não pode ser renovada. Qualquer pedido autorizado pode interromper a concessão; o pedido não é necessário para especificar um ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual nenhuma operação de concessão, exceto quebra e libertação, pode ser realizada no blob. Quando uma concessão é quebrada com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Uma concessão que tenha sido interrompida também pode ser libertada, caso em que outro cliente pode adquirir imediatamente a concessão no blob.
break_container_lease	Quebre a concessão, se o contentor tiver uma concessão ativa. Depois de uma concessão ser interrompida, não pode ser renovada. Qualquer pedido autorizado pode interromper a concessão; o pedido não é necessário para especificar um ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual nenhuma operação de concessão, exceto quebra e libertação, pode ser realizada no contentor. Quando uma concessão é quebrada com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.
change_blob_lease	Altera o ID de concessão de uma concessão ativa. Uma alteração tem de incluir o ID de concessão atual e um novo ID de concessão.
change_container_lease	Altere o ID de concessão de uma concessão ativa. Uma alteração tem de incluir o ID de concessão atual e um novo ID de concessão.
copy_blob	Copia um blob de forma assíncrona. Esta operação devolve um objeto de propriedades da operação de cópia, incluindo um ID de cópia que pode utilizar para verificar ou abortar a operação de cópia. O serviço Blob copia os blobs com base no melhor esforço. O blob de origem para uma operação de cópia pode ser um blob de blocos, um blob de acréscimo ou um blob de páginas. Se o blob de destino já existir, tem de ser do mesmo tipo de blob que o blob de origem. Qualquer blob de destino existente será substituído. Não é possível modificar o blob de destino enquanto estiver em curso uma operação de cópia. Ao copiar de um blob de páginas, o serviço Blob cria um blob de página de destino do comprimento do blob de origem, inicialmente contendo todos os zeros. Em seguida, os intervalos de páginas de origem são enumerados e os intervalos não vazios são copiados. Para um blob de blocos ou um blob de acréscimo, o serviço Blob cria um blob consolidado de comprimento zero antes de regressar desta operação. Ao copiar de um blob de blocos, todos os blocos consolidados e os respetivos IDs de bloco são copiados. Os blocos não consolidados não são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos consolidada que a origem. Ao copiar de um blob de acréscimo, todos os blocos consolidados são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos consolidada que a origem. Para todos os tipos de blobs, pode chamar get_blob_properties no blob de destino para verificar o estado da operação de cópia. O blob final será consolidado quando a cópia for concluída.
create_blob	Cria um blob ou substitui um blob existente. Utilize if_none_match=* para impedir a substituição de um blob existente. Veja create_blob_from_* para obter funções de alto nível que processam a criação e carregamento de blobs grandes com segmentação automática e notificações de progresso.
create_container	Cria um novo contentor na conta especificada. Se o contentor com o mesmo nome já existir, a operação falhará se fail_on_exist for Verdadeiro.
delete_blob	Marca o blob ou instantâneo especificado para eliminação. O blob é posteriormente eliminado durante a libertação da memória. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação Eliminar Blob. Se uma política de retenção de eliminação estiver ativada para o serviço, esta operação elimina de forma recuperável o blob ou instantâneo e mantém o blob ou instantâneo durante um número especificado de dias. Após o número especificado de dias, os dados do blob são removidos do serviço durante a libertação da memória. O blob ou instantâneo eliminado de forma recuperável está acessível através da API de Blobs de Lista que especifica a opção include=Include.Deleted. O blob ou instantâneo eliminado de forma recuperável pode ser restaurado com a API Undelete.
delete_container	Marca o contentor especificado para eliminação. O contentor e quaisquer blobs nele contidos são posteriormente eliminados durante a libertação da memória.
exists	Devolve um valor booleano que indica se o contentor existe (se blob_name for Nenhum) ou um booleano que indica se o blob existe.
extract_date_and_request_id
generate_account_shared_access_signature	Gera uma assinatura de acesso partilhado para o serviço blob. Utilize a assinatura devolvida com o parâmetro sas_token de qualquer BlobService.
generate_blob_shared_access_signature	Gera uma assinatura de acesso partilhado para o blob ou um dos respetivos instantâneos. Utilize a assinatura devolvida com o parâmetro sas_token de qualquer BlobService.
generate_container_shared_access_signature	Gera uma assinatura de acesso partilhado para o contentor. Utilize a assinatura devolvida com o parâmetro sas_token de qualquer BlobService.
get_blob_account_information	Obtém informações relacionadas com a conta de armazenamento. As informações também podem ser obtidas se o utilizador tiver uma SAS para um contentor ou blob.
get_blob_metadata	Devolve todos os metadados definidos pelo utilizador para o blob ou instantâneo especificado.
get_blob_properties	Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o blob. Não devolve o conteúdo do blob. Devolve Blob com BlobProperties e um ditado de metadados.
get_blob_service_properties	Obtém as propriedades do serviço Blob de uma conta de armazenamento, incluindo o Azure Análise de Armazenamento.
get_blob_service_stats	Obtém estatísticas relacionadas com a replicação do serviço Blob. Só está disponível quando a replicação georredundante de acesso de leitura está ativada para a conta de armazenamento. Com a replicação georredundante, o Armazenamento do Azure mantém os seus dados duráveis em duas localizações. Em ambas as localizações, o Armazenamento do Azure mantém constantemente múltiplas réplicas em bom estado de funcionamento dos seus dados. A localização onde lê, cria, atualiza ou elimina dados é a localização da conta de armazenamento principal. A localização primária existe na região que escolher no momento em que cria uma conta através do portal clássico do Azure Management do Azure, por exemplo, E.U.A. Centro-Norte. A localização para a qual os seus dados são replicados é a localização secundária. A localização secundária é determinada automaticamente com base na localização da localização primária; é num segundo datacenter que reside na mesma região que a localização primária. O acesso só de leitura está disponível a partir da localização secundária, se a replicação georredundante de acesso de leitura estiver ativada para a sua conta de armazenamento.
get_blob_to_bytes	Transfere um blob como uma matriz de bytes, com segmentações automáticas e notificações de progresso. Devolve uma instância com Blob propriedades, metadados e conteúdo.
get_blob_to_path	Transfere um blob para um caminho de ficheiro, com segmentação automática e notificações de progresso. Devolve uma instância de Blob com propriedades e metadados.
get_blob_to_stream	Transfere um blob para um fluxo, com segmentação automática e notificações de progresso. Devolve uma instância de Blob com propriedades e metadados.
get_blob_to_text	Transfere um blob como texto unicode, com segmentação automática e notificações de progresso. Devolve uma instância de Blob com propriedades, metadados e conteúdo.
get_container_acl	Obtém as permissões para o contentor especificado. As permissões indicam se os dados de contentor podem ser acedidos publicamente.
get_container_metadata	Devolve todos os metadados definidos pelo utilizador para o contentor especificado.
get_container_properties	Devolve todos os metadados definidos pelo utilizador e as propriedades do sistema para o contentor especificado. Os dados devolvidos não incluem a lista de blobs do contentor.
get_user_delegation_key	Obtenha uma chave de delegação de utilizador para fins de assinatura de tokens SAS. Tem de estar presente uma credencial de token no objeto de serviço para que este pedido seja bem-sucedido.
list_blob_names	Devolve um gerador para listar os nomes dos blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os blobs tiverem sido devolvidos 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 assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.
list_blobs	Devolve um gerador para listar os blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os blobs tiverem sido devolvidos 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 assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.
list_containers	Devolve um gerador para listar os contentores na conta especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os contentores tiverem sido devolvidos ou num_results for atingido. Se num_results for especificado e a conta tiver mais do que esse número de contentores, o gerador terá um campo de next_marker preenchido assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.
make_blob_url	Cria o URL para aceder a um blob.
make_container_url	Cria o URL para aceder a um contentor.
release_blob_lease	Liberta a concessão. A concessão poderá ser libertada se o ID de concessão especificado no pedido corresponder ao associado ao blob. Libertar a concessão permite que outro cliente adquira imediatamente a concessão do blob assim que a versão estiver concluída.
release_container_lease	Liberte a concessão. A concessão poderá ser libertada se o lease_id especificado corresponder ao associado ao contentor. A libertação da concessão permite que outro cliente adquira imediatamente a concessão do contentor assim que a versão estiver concluída.
renew_blob_lease	Renova a concessão. A concessão pode ser renovada se o ID de concessão especificado no pedido corresponder ao associado ao blob. Tenha em atenção que a concessão pode ser renovada mesmo que tenha expirado desde que o blob não tenha sido modificado ou concedido novamente desde a expiração dessa concessão. Quando renova uma concessão, o relógio de duração da concessão é reposto.
renew_container_lease	Renova a concessão. A concessão pode ser renovada se o ID de concessão especificado corresponder ao associado ao contentor. Tenha em atenção que a concessão pode ser renovada mesmo que tenha expirado, desde que o contentor não tenha sido novamente arrendado desde a expiração dessa concessão. Quando renova uma concessão, o relógio de duração da concessão é reposto.
set_blob_metadata	Define metadados definidos pelo utilizador para o blob especificado como um ou mais pares nome-valor.
set_blob_properties	Define as propriedades do sistema no blob. Se uma propriedade estiver 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 o Azure Análise de Armazenamento. Se um elemento (ex Registo) for deixado como Nenhum, as definições existentes no serviço para essa funcionalidade serão preservadas.
set_container_acl	Define as permissões para o contentor especificado ou políticas de acesso armazenado que podem ser utilizadas com Assinaturas de Acesso Partilhado. As permissões indicam se os blobs num contentor podem ser acedidos publicamente.
set_container_metadata	Define um ou mais pares nome-valor definidos pelo utilizador para o contentor especificado. Cada chamada para esta operação substitui todos os metadados existentes anexados ao contentor. Para remover todos os metadados do contentor, chame esta operação sem dict de metadados.
set_proxy	Define o anfitrião e a porta do servidor proxy para o Túnel HTTP CONNECT.
snapshot_blob	Cria um instantâneo só de leitura de um blob.
undelete_blob	A operação anular a eliminação de Blobs restaura os conteúdos e metadados do blob ou instantâneo eliminado de forma recuperável. Tentar anular a eliminação de um blob ou instantâneo que não seja eliminado de forma recuperável será bem-sucedido sem quaisquer alterações.

abort_copy_blob

Aborta 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

Necessário

Nome do contentor de destino.

blob_name

str

Necessário

Nome do blob de destino.

copy_id

str

Necessário

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

lease_id

str

valor predefinido: None

Necessário se o blob de destino tiver uma concessão infinita ativa.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

acquire_blob_lease

Pede uma nova concessão. Se o blob não tiver uma concessão ativa, o serviço Blob cria uma concessão no blob e devolve um novo 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

lease_duration

int

valor predefinido: -1

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

proposed_lease_id

str

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

str

acquire_container_lease

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

acquire_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

Necessário

Nome do contentor existente.

lease_duration

int

valor predefinido: -1

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

proposed_lease_id

str

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

str

append_blob_from_bytes

Anexa ao conteúdo de um blob existente a partir de uma matriz de bytes, com segmentação automática e notificações de progresso.

append_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None, timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, cpk=None)

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob para criar ou atualizar.

blob

bytes

Necessário

Conteúdo do blob como uma matriz de bytes.

index

int

valor predefinido: 0

Iniciar índice na matriz de bytes.

count

int

valor predefinido: None

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

validate_content

bool

valor predefinido: False

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

maxsize_condition

int

valor predefinido: None

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

progress_callback

<xref:func>(<xref:current>, <xref:total>)

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

timeout

int

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

Devoluções

ETag e propriedades modificadas pela última vez para o Blob de Acréscimo

Tipo de retorno

ResourceProperties

append_blob_from_path

Anexa ao conteúdo de um blob existente a partir de um caminho de ficheiro, com segmentação automática e notificações de progresso.

append_blob_from_path(container_name, blob_name, file_path, validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None, timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, cpk=None)

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob para criar ou atualizar.

file_path

str

Necessário

Caminho do ficheiro a carregar como o conteúdo do blob.

validate_content

bool

valor predefinido: False

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

maxsize_condition

int

valor predefinido: None

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

progress_callback

<xref:func>(<xref:current>, <xref:total>)

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

timeout

int

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

Devoluções

ETag e propriedades modificadas pela última vez para o Blob de Acréscimo

Tipo de retorno

ResourceProperties

append_blob_from_stream

Anexa ao conteúdo de um blob existente a partir de um ficheiro/fluxo, com segmentação automática e notificações de progresso.

append_blob_from_stream(container_name, blob_name, stream, count=None, validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None, timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, cpk=None)

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob para criar ou atualizar.

stream

IOBase

Necessário

Fluxo aberto para carregar como o conteúdo do blob.

count

int

valor predefinido: None

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

validate_content

bool

valor predefinido: False

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

maxsize_condition

int

valor predefinido: None

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

progress_callback

<xref:func>(<xref:current>, <xref:total>)

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

timeout

int

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

Devoluções

ETag e propriedades modificadas pela última vez para o Blob de Acréscimo

Tipo de retorno

ResourceProperties

append_blob_from_text

Anexa ao conteúdo de um blob existente a partir de str/unicode, com segmentação automática e notificações de progresso.

append_blob_from_text(container_name, blob_name, text, encoding='utf-8', validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None, timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, cpk=None)

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob para criar ou atualizar.

text

str

Necessário

Texto para carregar para o blob.

encoding

str

valor predefinido: utf-8

Codificação python a utilizar para converter o texto em bytes.

validate_content

bool

valor predefinido: False

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

maxsize_condition

int

valor predefinido: None

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

progress_callback

<xref:func>(<xref:current>, <xref:total>)

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

timeout

int

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

Devoluções

ETag e propriedades modificadas pela última vez para o Blob de Acréscimo

Tipo de retorno

ResourceProperties

append_block

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

append_block(container_name, blob_name, block, validate_content=False, maxsize_condition=None, appendpos_condition=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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

block

bytes

Necessário

Conteúdo do bloco em bytes.

validate_content

bool

valor predefinido: False

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

maxsize_condition

int

valor predefinido: None

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

appendpos_condition

int

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

Propriedades do ETag, última modificação, desvio de acréscimo e contagem de blocos consolidadas para o Blob de Acréscimo atualizado

Tipo de retorno

AppendBlockProperties

append_block_from_url

Cria um novo bloco a ser consolidado como parte de um blob, onde os conteúdos são lidos a partir de um URL de origem.

append_block_from_url(container_name, blob_name, copy_source_url, source_range_start=None, source_range_end=None, source_content_md5=None, source_if_modified_since=None, source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, maxsize_condition=None, appendpos_condition=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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob.

copy_source_url

str

Necessário

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

source_range_start

int

valor predefinido: None

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

source_range_end

int

valor predefinido: None

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

source_content_md5

str

valor predefinido: None

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

source_if_modified_since

datetime

valor predefinido: None

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

source_if_unmodified_since

datetime

valor predefinido: None

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

source_if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso de origem corresponder ao valor especificado.

source_if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso de origem não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso de origem não existir e falhar a operação se existir.

maxsize_condition

int

valor predefinido: None

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

appendpos_condition

int

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

batch_delete_blobs

Envia um lote de vários pedidos de eliminação de blobs.

O método de eliminação de blobs elimina o blob ou instantâneo especificado. Tenha em atenção que eliminar um blob também elimina todos os respetivos instantâneos. Para 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)

Necessário

Os pedidos de eliminação de blobs para enviar como um lote.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

resposta HTTP de eliminação de lote analisada

Tipo de retorno

list <xref:of> BatchSubResponse

break_blob_lease

Interrompe a concessão, se o blob tiver uma concessão ativa. Depois de uma concessão ser interrompida, não pode ser renovada. Qualquer pedido autorizado pode interromper a concessão; o pedido não é necessário para especificar um ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual nenhuma operação de concessão, exceto quebra e libertação, pode ser realizada no blob. Quando uma concessão é quebrada com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.

Uma concessão que tenha sido interrompida também pode ser libertada, caso em que 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

lease_break_period

int

valor predefinido: None

Para uma operação de interrupção, esta é a duração proposta de segundos que a concessão deve continuar antes de ser interrompida, entre 0 e 60 segundos. Este período de interrupção só é utilizado se for mais curto do que o tempo restante na concessão. Se for mais longo, é utilizado o tempo restante na concessão. Uma nova concessão não estará disponível antes de o período de interrupção expirar, mas a concessão pode ser mantida por mais tempo do que o período de interrupção. Se este cabeçalho não for apresentado com uma operação de interrupção, uma concessão de duração fixa é interrompida após o período de concessão restante terminar e uma concessão infinita é interrompida imediatamente.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

int

break_container_lease

Quebre a concessão, se o contentor tiver uma concessão ativa. Depois de uma concessão ser interrompida, não pode ser renovada. Qualquer pedido autorizado pode interromper a concessão; o pedido não é necessário para especificar um ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual nenhuma operação de concessão, exceto quebra e libertação, pode ser realizada no contentor. Quando uma concessão é quebrada 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

Necessário

Nome do contentor existente.

lease_break_period

int

valor predefinido: None

Esta é a duração proposta de segundos que a concessão deve continuar antes de ser quebrada, entre 0 e 60 segundos. Este período de interrupção só é utilizado se for mais curto do que o tempo restante na concessão. Se for mais longo, é utilizado o tempo restante na concessão. Uma nova concessão não estará disponível antes de o período de interrupção expirar, mas a concessão pode ser mantida por mais tempo do que o período de interrupção. Se este cabeçalho não for apresentado com uma operação de interrupção, uma concessão de duração fixa é interrompida após o período de concessão restante terminar e uma concessão infinita é interrompida imediatamente.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

int

change_blob_lease

Altera o ID de concessão de uma concessão ativa. Uma alteração tem de incluir o ID de concessão atual e um novo 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

lease_id

str

Necessário

Necessário se o blob tiver uma concessão ativa.

proposed_lease_id

str

Necessário

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

change_container_lease

Altere o ID de concessão de uma concessão ativa. Uma alteração tem de incluir o ID de concessão atual e um novo 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

Necessário

Nome do contentor existente.

lease_id

str

Necessário

ID de concessão para concessão ativa.

proposed_lease_id

str

Necessário

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

copy_blob

Copia um blob de forma assíncrona. Esta operação devolve um objeto de propriedades da operação de cópia, incluindo um ID de cópia que pode utilizar para verificar ou abortar a operação de cópia. O serviço Blob copia os blobs com base no melhor esforço.

O blob de origem para uma operação de cópia pode ser um blob de blocos, um blob de acréscimo ou um blob de páginas. Se o blob de destino já existir, tem de ser do mesmo tipo de blob que o blob de origem. Qualquer blob de destino existente será substituído. Não é possível modificar o blob de destino enquanto estiver em curso uma operação de cópia.

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

Para um blob de blocos ou um blob de acréscimo, o serviço Blob cria um blob consolidado de comprimento zero antes de regressar desta operação. Ao copiar de um blob de blocos, todos os blocos consolidados e os respetivos IDs de bloco são copiados. Os blocos não consolidados não são copiados. No final da operação de cópia, o blob de destino terá a mesma contagem de blocos consolidada que a origem.

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

Para todos os tipos de blobs, pode chamar get_blob_properties no blob de destino para verificar o estado da operação de cópia. O blob final será consolidado quando a cópia for concluída.

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)

Parâmetros

container_name

str

Necessário

Nome do contentor de destino. O contentor tem de existir.

blob_name

str

Necessário

Nome do blob de destino. Se o blob de destino existir, será substituído. Caso contrário, será criado.

copy_source

str

Necessário

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

metadata

dict(str, str)

valor predefinido: None

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

source_if_modified_since

datetime

valor predefinido: None

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

source_if_unmodified_since

datetime

valor predefinido: None

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

source_if_match

<xref:ETag>

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho condicional para copiar o blob de origem apenas se a ETag corresponder ao valor especificado. Se os valores de ETag não corresponderem, o serviço Blob devolve o código de estado 412 (Falha na Pré-condição). Não é possível especificar este cabeçalho se a origem for um Ficheiro do Azure.

source_if_none_match

<xref:ETag>

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho condicional para copiar o blob apenas se a ETag não corresponder ao valor especificado. Se os valores forem idênticos, o serviço Blob devolve o código de estado 412 (Falha na Pré-condição). Não é possível especificar este cabeçalho se a origem for um Ficheiro do Azure.

destination_if_modified_since

datetime

valor predefinido: None

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho condicional para copiar o blob apenas se o blob de destino tiver sido modificado desde a data/hora especificada. Se o blob de destino não tiver sido modificado, o serviço Blob devolve o código de estado 412 (Falha na Pré-condição).

destination_if_unmodified_since

datetime

valor predefinido: None

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho condicional para copiar o blob apenas se o blob de destino não tiver sido modificado desde a data/hora especificada. Se o blob de destino tiver sido modificado, o serviço Blob devolve o código de estado 412 (Falha na Pré-condição).

destination_if_match

<xref:ETag>

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique um valor ETag para este cabeçalho condicional para copiar o blob apenas se o valor ETag especificado corresponder ao valor ETag de um blob de destino existente. Se a ETag para o blob de destino não corresponder à ETag especificada para If-Match, o serviço Blob devolve o código de estado 412 (Falha na Pré-condição).

destination_if_none_match

<xref:ETag>

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique um valor ETag para este cabeçalho condicional para copiar o blob apenas se o valor ETag especificado não corresponder ao valor ETag do blob de destino. Especifique o caráter universal () para executar a operação apenas se o blob de destino não existir. Se a condição especificada não for cumprida, o serviço Blob devolve o código de estado 412 (Falha na Pré-condição).

destination_lease_id

str

valor predefinido: None

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

source_lease_id

str

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

Copie as propriedades da operação, como o estado, a origem e o ID.

Tipo de retorno

CopyProperties

create_blob

Cria um blob ou substitui um blob existente. Utilize if_none_match=* para impedir a substituição de um blob existente.

Veja create_blob_from_* para obter funções de alto nível que processam a criação e carregamento de blobs grandes com segmentação automática e notificações de progresso.

create_blob(container_name, blob_name, content_settings=None, 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob a criar ou atualizar.

content_settings

ContentSettings

valor predefinido: None

Objeto ContentSettings utilizado para definir propriedades do blob.

metadata

dict(str, str)

valor predefinido: None

Pares nome-valor associados ao blob como metadados.

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

ETag e propriedades modificadas pela última vez para o Blob de Acréscimo atualizado

Tipo de retorno

ResourceProperties

create_container

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

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

Parâmetros

container_name

str

Necessário

Nome do contentor a criar. O nome do contentor só pode conter letras minúsculas, números e hífenes e tem de começar com uma letra ou um número. Cada hífen tem de ser precedido e seguido de um caráter que não seja um hífen. O nome também tem de ter entre 3 e 63 carateres.

metadata

dict(str, str)

valor predefinido: None

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

public_access

PublicAccess

valor predefinido: None

Os valores possíveis incluem: contentor, blob.

fail_on_exist

bool

valor predefinido: False

Especifique se pretende gerar uma exceção quando o contentor existe.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

Verdadeiro se o contentor for criado, Falso se o contentor já existir.

Tipo de retorno

bool

delete_blob

Marca o blob ou instantâneo especificado para eliminação. O blob é posteriormente eliminado durante a libertação da memória.

Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação Eliminar Blob.

Se uma política de retenção de eliminação estiver ativada para o serviço, esta operação elimina de forma recuperável o blob ou instantâneo e mantém o blob ou instantâneo durante um número especificado de dias. Após o número especificado de dias, os dados do blob são removidos do serviço durante a libertação da memória. O blob ou instantâneo eliminado de forma recuperável está acessível através da API de Blobs de Lista que especifica a opção include=Include.Deleted. O blob ou instantâneo eliminado de forma recuperável pode ser restaurado com 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

snapshot

str

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

delete_snapshots

DeleteSnapshot

valor predefinido: None

Necessário se o blob tiver instantâneos associados.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

delete_container

Marca o contentor especificado para eliminação. O contentor e quaisquer blobs nele contidos são posteriormente eliminados durante a libertação da memória.

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

Necessário

Nome do contentor a eliminar.

fail_not_exist

bool

valor predefinido: False

Especifique se pretende gerar uma exceção quando o contentor não existe.

lease_id

str

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

Verdadeiro se o contentor for eliminado, o contentor False não existe.

Tipo de retorno

bool

exists

Devolve um valor booleano que indica se o contentor existe (se blob_name for Nenhum) ou um booleano que indica se o blob existe.

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

Parâmetros

container_name

str

Necessário

Nome de um contentor.

blob_name

str

valor predefinido: None

Nome de um blob. Se Não, o contentor será verificado quanto à existência.

snapshot

str

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

Um booleano que indica se o recurso existe.

Tipo de retorno

bool

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parâmetros

retry_context

Necessário

generate_account_shared_access_signature

Gera uma assinatura de acesso partilhado para o serviço blob. Utilize a assinatura devolvida 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>

Necessário

Especifica os tipos de recursos que estão acessíveis com a SAS da conta.

permission

<xref:AccountPermissions>

Necessário

As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada.

expiry

datetime ou str

Necessário

O momento em que a assinatura de acesso partilhado se torna inválida. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.

start

datetime ou str

valor predefinido: None

O momento em que a assinatura de acesso partilhado se torna válida. Se for omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.

ip

str

valor predefinido: None

Especifica um endereço IP ou um intervalo de endereços IP a partir do qual aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 no SAS restringe o pedido a esses endereços IP.

protocol

str

valor predefinido: None

Especifica o protocolo permitido para um pedido feito. O valor predefinido é https,http. Veja Protocol os valores possíveis.

Devoluções

Um token de Assinatura de Acesso Partilhado (sas).

Tipo de retorno

str

generate_blob_shared_access_signature

Gera uma assinatura de acesso partilhado para o blob ou um dos respetivos instantâneos. Utilize a assinatura devolvida 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

Necessário

Nome do contentor.

blob_name

str

Necessário

Nome do blob.

snapshot

str

valor predefinido: None

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

permission

BlobPermissions

valor predefinido: None

As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. As permissões têm de ser ordenadas como leitura, escrita, eliminação, lista. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada.

expiry

datetime ou str

valor predefinido: None

O momento em que a assinatura de acesso partilhado se torna inválida. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.

start

datetime ou str

valor predefinido: None

O momento em que a assinatura de acesso partilhado se torna válida. Se for omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.

id

str

valor predefinido: None

Um valor exclusivo com até 64 carateres de comprimento que se correlaciona com uma política de acesso armazenada. Para criar uma política de acesso armazenada, utilize set_container_acl.

ip

str

valor predefinido: None

Especifica um endereço IP ou um intervalo de endereços IP a partir do qual aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 no SAS restringe o pedido a esses endereços IP.

protocol

str

valor predefinido: None

Especifica o protocolo permitido para um pedido feito. O valor predefinido é https,http. Veja Protocol os valores possíveis.

cache_control

str

valor predefinido: None

Valor do cabeçalho de resposta para Cache-Control quando o recurso é acedido com esta assinatura de acesso partilhado.

content_disposition

str

valor predefinido: None

Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acedido com esta assinatura de acesso partilhado.

content_encoding

str

valor predefinido: None

Valor do cabeçalho de resposta para Content-Encoding quando o recurso é acedido com esta assinatura de acesso partilhado.

content_language

str

valor predefinido: None

Valor do cabeçalho de resposta para Content-Language quando o recurso é acedido com esta assinatura de acesso partilhado.

content_type

str

valor predefinido: None

Valor do cabeçalho de resposta para Content-Type quando o recurso é acedido com esta assinatura de acesso partilhado.

user_delegation_key

UserDelegationKey

valor predefinido: None

Em vez de uma chave de conta, o utilizador pode transmitir uma chave de delegação de utilizador. Uma chave de delegação de utilizador pode ser obtida a partir do serviço através da autenticação com uma identidade do AAD; isto pode ser conseguido ao chamar get_user_delegation_key. Quando estiver presente, a SAS é assinada com a chave de delegação de utilizador.

Devoluções

Um token de Assinatura de Acesso Partilhado (sas).

Tipo de retorno

str

generate_container_shared_access_signature

Gera uma assinatura de acesso partilhado para o contentor. Utilize a assinatura devolvida 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

Necessário

Nome do contentor.

permission

ContainerPermissions

valor predefinido: None

As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. As permissões têm de ser ordenadas como leitura, escrita, eliminação, lista. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada.

expiry

datetime ou str

valor predefinido: None

O momento em que a assinatura de acesso partilhado se torna inválida. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.

start

datetime ou str

valor predefinido: None

O momento em que a assinatura de acesso partilhado se torna válida. Se for omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.

id

str

valor predefinido: None

Um valor exclusivo com até 64 carateres de comprimento que se correlaciona com uma política de acesso armazenada. Para criar uma política de acesso armazenada, utilize set_blob_service_properties.

ip

str

valor predefinido: None

Especifica um endereço IP ou um intervalo de endereços IP a partir do qual aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 no SAS restringe o pedido a esses endereços IP.

protocol

str

valor predefinido: None

Especifica o protocolo permitido para um pedido feito. O valor predefinido é https,http. Veja Protocol os valores possíveis.

cache_control

str

valor predefinido: None

Valor do cabeçalho de resposta para Cache-Control quando o recurso é acedido com esta assinatura de acesso partilhado.

content_disposition

str

valor predefinido: None

Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acedido com esta assinatura de acesso partilhado.

content_encoding

str

valor predefinido: None

Valor do cabeçalho de resposta para Content-Encoding quando o recurso é acedido com esta assinatura de acesso partilhado.

content_language

str

valor predefinido: None

Valor do cabeçalho de resposta para Content-Language quando o recurso é acedido com esta assinatura de acesso partilhado.

content_type

str

valor predefinido: None

Valor do cabeçalho de resposta para Content-Type quando o recurso é acedido com esta assinatura de acesso partilhado.

user_delegation_key

UserDelegationKey

valor predefinido: None

Em vez de uma chave de conta, o utilizador pode transmitir uma chave de delegação de utilizador. Uma chave de delegação de utilizador pode ser obtida a partir do serviço através da autenticação com uma identidade do AAD; isto pode ser conseguido ao chamar get_user_delegation_key. Quando estiver presente, a SAS é assinada com a chave de delegação de utilizador.

Devoluções

Um token de Assinatura de Acesso Partilhado (sas).

Tipo de retorno

str

get_blob_account_information

Obtém informações relacionadas com a conta de armazenamento. As informações também podem ser obtidas se o utilizador tiver uma SAS para um contentor ou blob.

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

Parâmetros

container_name

str

valor predefinido: None

Nome do contentor existente. Opcional, a menos que utilize um token de SAS para um contentor ou blob específico, caso em que é necessário.

blob_name

str

valor predefinido: None

Nome do blob existente. Opcional, a menos que utilize um token de SAS para um blob específico, caso em que é necessário.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

O campo AccountInformation.

get_blob_metadata

Devolve todos os metadados definidos pelo utilizador para o blob ou instantâneo especificado.

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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

snapshot

str

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

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

Tipo de retorno

dict(str, str)

get_blob_properties

Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o blob. Não devolve o conteúdo do blob. Devolve Blob com BlobProperties e um ditado 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

snapshot

str

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

um objeto de blob, incluindo propriedades e metadados.

Tipo de retorno

Blob

get_blob_service_properties

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

get_blob_service_properties(timeout=None)

Parâmetros

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

O blob ServiceProperties com uma propriedade de target_version anexada.

get_blob_service_stats

Obtém estatísticas relacionadas com a replicação do serviço Blob. Só está disponível quando a replicação georredundante de acesso de leitura está ativada para a conta de armazenamento.

Com a replicação georredundante, o Armazenamento do Azure mantém os seus dados duráveis em duas localizações. Em ambas as localizações, o Armazenamento do Azure mantém constantemente múltiplas réplicas em bom estado de funcionamento dos seus dados. A localização onde lê, cria, atualiza ou elimina dados é a localização da conta de armazenamento principal. A localização primária existe na região que escolher no momento em que cria uma conta através do portal clássico do Azure Management do Azure, por exemplo, E.U.A. Centro-Norte. A localização para a qual os seus dados são replicados é a localização secundária. A localização secundária é determinada automaticamente com base na localização da localização primária; é num segundo datacenter que reside na mesma região que a localização primária. O acesso só de leitura está disponível a partir da localização secundária, se a replicação georredundante de acesso de leitura estiver ativada para a sua conta de armazenamento.

get_blob_service_stats(timeout=None)

Parâmetros

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

As estatísticas do serviço blob.

Tipo de retorno

ServiceStats

get_blob_to_bytes

Transfere um blob como uma matriz de bytes, com segmentações automáticas e notificações de progresso. Devolve uma instância com Blob 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

snapshot

str

valor predefinido: None

O parâmetro instantâneo é um valor dateTime opaco que, quando presente, especifica o instantâneo do blob a obter.

start_range

int

valor predefinido: None

Início do intervalo de bytes a utilizar para transferir uma secção do blob. Se não for dada nenhuma end_range, todos os bytes após o start_range serão transferidos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de blob.

end_range

int

valor predefinido: None

Fim do intervalo de bytes a utilizar para transferir uma secção do blob. Se end_range for dada, start_range têm de ser fornecidas. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de blob.

validate_content

bool

valor predefinido: False

Se for definido como verdadeiro, valida um hash MD5 para cada parte recuperada do blob. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que o serviço só devolverá MD5s transacionais para segmentos de 4 MB ou menos, pelo que o primeiro pedido 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 superior a 4 MB, será emitido um erro. Uma vez que a computação do MD5 demora o processamento e mais pedidos terão de ser feitos devido ao tamanho reduzido do segmento, poderá haver algum aumento na latência.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

valor predefinido: None

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

max_connections

int

valor predefinido: 2

Se estiver definido como 2 ou superior, será feita uma obtenção inicial para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se este for todo o blob, o método será devolvido neste momento. Se não for, transferirá os restantes dados paralelos com o número de threads iguais a max_connections. Cada segmento terá um tamanho próprio. MAX_CHUNK_GET_SIZE. Se estiver definido como 1, será feito um único pedido get grande. Geralmente, isto não é recomendado, mas está disponível se forem utilizados muito poucos threads, os pedidos de rede são muito caros ou um fluxo não procurado impede a transferência paralela. Isto também pode ser útil se se esperar que muitos blobs estejam vazios, uma vez que é necessário um pedido adicional para blobs vazios se max_connections for superior a 1.

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

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

Devoluções

Um Blob com propriedades e metadados. Se max_connections for superior a 1, o content_md5 (se definido no blob) não será devolvido. Se precisar deste valor, utilize get_blob_properties ou defina max_connections como 1.

Tipo de retorno

Blob

get_blob_to_path

Transfere um blob para um caminho de ficheiro, com segmentação automática e notificações de progresso. Devolve 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

file_path

str

Necessário

Caminho do ficheiro para o qual escrever.

open_mode

str

valor predefinido: wb

Modo a utilizar ao abrir o ficheiro. Tenha em atenção que especificar acrescentar apenas open_mode impede a transferência paralela. Assim, max_connections tem de ser definido como 1 se este open_mode for utilizado.

snapshot

str

valor predefinido: None

O parâmetro instantâneo é um valor dateTime opaco que, quando presente, especifica o instantâneo do blob a obter.

start_range

int

valor predefinido: None

Início do intervalo de bytes a utilizar para transferir uma secção do blob. Se não for dada nenhuma end_range, todos os bytes após o start_range serão transferidos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de blob.

end_range

int

valor predefinido: None

Fim do intervalo de bytes a utilizar para transferir uma secção do blob. Se end_range for dada, start_range têm de ser fornecidas. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de blob.

validate_content

bool

valor predefinido: False

Se for definido como verdadeiro, valida um hash MD5 para cada parte recuperada do blob. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que o serviço só devolverá MD5s transacionais para segmentos de 4 MB ou menos, pelo que o primeiro pedido 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 superior a 4 MB, será emitido um erro. Uma vez que a computação do MD5 demora o processamento e mais pedidos terão de ser feitos devido ao tamanho reduzido do segmento, poderá haver algum aumento na latência.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

valor predefinido: None

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

max_connections

int

valor predefinido: 2

Se estiver definido como 2 ou superior, será feita uma obtenção inicial para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se este for todo o blob, o método será devolvido neste momento. Se não for, transferirá os restantes dados paralelos com o número de threads iguais a max_connections. Cada segmento terá um tamanho próprio. MAX_CHUNK_GET_SIZE. Se estiver definido como 1, será feito um único pedido get grande. Geralmente, isto não é recomendado, mas está disponível se forem utilizados muito poucos threads, os pedidos de rede são muito caros ou um fluxo não procurado impede a transferência paralela. Isto também pode ser útil se se esperar que muitos blobs estejam vazios, uma vez que é necessário um pedido adicional para blobs vazios se max_connections for superior a 1.

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

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

Devoluções

Um Blob com propriedades e metadados. Se max_connections for superior a 1, o content_md5 (se definido no blob) não será devolvido. Se precisar deste valor, utilize get_blob_properties ou defina max_connections como 1.

Tipo de retorno

Blob

get_blob_to_stream

Transfere um blob para um fluxo, com segmentação automática e notificações de progresso. Devolve 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

stream

IOBase

Necessário

Fluxo aberto para escrever.

snapshot

str

valor predefinido: None

O parâmetro instantâneo é um valor dateTime opaco que, quando presente, especifica o instantâneo do blob a obter.

start_range

int

valor predefinido: None

Início do intervalo de bytes a utilizar para transferir uma secção do blob. Se não for dada nenhuma end_range, todos os bytes após o start_range serão transferidos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de blob.

end_range

int

valor predefinido: None

Fim do intervalo de bytes a utilizar para transferir uma secção do blob. Se end_range for dada, start_range têm de ser fornecidas. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de blob.

validate_content

bool

valor predefinido: False

Se for definido como verdadeiro, valida um hash MD5 para cada parte recuperada do blob. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que o serviço só devolverá MD5s transacionais para segmentos de 4 MB ou menos, pelo que o primeiro pedido 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 superior a 4 MB, será emitido um erro. Uma vez que a computação do MD5 demora o processamento e mais pedidos terão de ser feitos devido ao tamanho reduzido do segmento, poderá haver algum aumento na latência.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

valor predefinido: None

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

max_connections

int

valor predefinido: 2

Se estiver definido como 2 ou superior, será feita uma obtenção inicial para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se este for todo o blob, o método será devolvido neste momento. Se não for, transferirá os restantes dados paralelos com o número de threads iguais a max_connections. Cada segmento terá um tamanho próprio. MAX_CHUNK_GET_SIZE. Se estiver definido como 1, será feito um único pedido get grande. Geralmente, isto não é recomendado, mas está disponível se forem utilizados muito poucos threads, os pedidos de rede são muito caros ou um fluxo não procurado impede a transferência paralela. Isto também pode ser útil se se esperar que muitos blobs estejam vazios, uma vez que é necessário um pedido adicional para blobs vazios se max_connections for superior a 1.

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

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

Devoluções

Um Blob com propriedades e metadados. Se max_connections for superior a 1, o content_md5 (se definido no blob) não será devolvido. Se precisar deste valor, utilize get_blob_properties ou defina max_connections como 1.

Tipo de retorno

Blob

get_blob_to_text

Transfere um blob como texto unicode, com segmentação automática e notificações de progresso. Devolve 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

encoding

str

valor predefinido: utf-8

Codificação python a utilizar ao descodificar os dados de blobs.

snapshot

str

valor predefinido: None

O parâmetro instantâneo é um valor dateTime opaco que, quando presente, especifica o instantâneo do blob a obter.

start_range

int

valor predefinido: None

Início do intervalo de bytes a utilizar para transferir uma secção do blob. Se não for dada nenhuma end_range, todos os bytes após o start_range serão transferidos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de blob.

end_range

int

valor predefinido: None

Fim do intervalo de bytes a utilizar para transferir uma secção do blob. Se end_range for dada, start_range têm de ser fornecidas. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de blob.

validate_content

bool

valor predefinido: False

Se for definido como verdadeiro, valida um hash MD5 para cada parte recuperada do blob. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que o serviço só devolverá MD5s transacionais para segmentos de 4 MB ou menos, pelo que o primeiro pedido 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 superior a 4 MB, será emitido um erro. Uma vez que a computação do MD5 demora o processamento e mais pedidos terão de ser feitos devido ao tamanho reduzido do segmento, poderá haver algum aumento na latência.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

valor predefinido: None

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

max_connections

int

valor predefinido: 2

Se estiver definido como 2 ou superior, será feita uma obtenção inicial para o primeiro self. MAX_SINGLE_GET_SIZE bytes do blob. Se este for o blob inteiro, o método será devolvido neste momento. Se não estiver, transferirá os dados restantes paralelos com o número de threads iguais a max_connections. Cada segmento terá um tamanho próprio. MAX_CHUNK_GET_SIZE. Se estiver definido como 1, será feito um único pedido get grande. Geralmente, isto não é recomendado, mas está disponível se forem utilizados muito poucos threads, os pedidos de rede são muito dispendiosos ou um fluxo não pesquisável impede a transferência paralela. Isto também pode ser útil se se esperar que muitos blobs estejam vazios, uma vez que é necessário um pedido adicional para blobs vazios se max_connections for superior a 1.

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

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

Devoluções

Um Blob com propriedades e metadados. Se max_connections for superior a 1, o content_md5 (se definido no blob) não será devolvido. Se precisar deste valor, utilize get_blob_properties ou defina max_connections como 1.

Tipo de retorno

Blob

get_container_acl

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

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

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

lease_id

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

Um dicionário de políticas de acesso associadas ao contentor. dict of str to and a AccessPolicy public_access property if public access is turned on

get_container_metadata

Devolve todos os metadados definidos pelo utilizador para o contentor especificado.

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

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

lease_id

str

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

Um dicionário que representa o nome dos metadados do contentor, pares de valores.

Tipo de retorno

dict(str, str)

get_container_properties

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

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

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

lease_id

str

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

propriedades do contentor especificado num objeto de contentor.

Tipo de retorno

Container

get_user_delegation_key

Obtenha uma chave de delegação de utilizador para fins de assinatura de tokens SAS. Tem de estar presente uma credencial de token no objeto de serviço para que este pedido seja bem-sucedido.

get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)

Parâmetros

key_start_time

datetime

Necessário

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

key_expiry_time

datetime

Necessário

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

A chave de delegação do utilizador.

Tipo de retorno

UserDelegationKey

list_blob_names

Devolve um gerador para listar os nomes dos blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os blobs tiverem sido devolvidos 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 assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.

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

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

prefix

str

valor predefinido: None

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

num_results

int

valor predefinido: None

Especifica o número máximo de blobs a devolver, incluindo todos os <xref:azure.storage.blob.appendblobservice.BlobPrefix> elementos. Se o pedido não especificar num_results ou especificar um valor superior a 5000, o servidor devolverá até 5000 itens. Definir num_results para um valor menor ou igual a zero resulta no código de resposta de erro 400 (Pedido Incorreto).

include

Include

valor predefinido: None

Especifica um ou mais conjuntos de dados adicionais a incluir na resposta.

delimiter

str

valor predefinido: None

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

marker

str

valor predefinido: None

Um token de continuação opaco. Este valor pode ser obtido a partir do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver concluído a enumeração de resultados. Se for especificado, este gerador começará a devolver resultados do ponto em que o gerador anterior parou.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

list_blobs

Devolve um gerador para listar os blobs no contentor especificado. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os blobs tiverem sido devolvidos 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 assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.

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

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

prefix

str

valor predefinido: None

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

num_results

int

valor predefinido: None

Especifica o número máximo de blobs a devolver, incluindo todos os <xref:azure.storage.blob.appendblobservice.BlobPrefix> elementos. Se o pedido não especificar num_results ou especificar um valor superior a 5000, o servidor devolverá até 5000 itens. Definir num_results para um valor menor ou igual a zero resulta no código de resposta de erro 400 (Pedido Incorreto).

include

Include

valor predefinido: None

Especifica um ou mais conjuntos de dados adicionais a incluir na resposta.

delimiter

str

valor predefinido: None

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

marker

str

valor predefinido: None

Um token de continuação opaco. Este valor pode ser obtido a partir do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver concluído a enumeração de resultados. Se for especificado, este gerador começará a devolver resultados do ponto em que o gerador anterior parou.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

list_containers

Devolve um gerador para listar os contentores na conta especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os contentores tiverem sido devolvidos ou num_results for atingido.

Se num_results for especificado e a conta tiver mais do que esse número de contentores, o gerador terá um campo de next_marker preenchido assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.

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

Parâmetros

prefix

str

valor predefinido: None

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

num_results

int

valor predefinido: None

Especifica o número máximo de contentores a devolver. Um pedido de lista única pode devolver até 1000 contianers e, potencialmente, um token de continuação que deve ser seguido para obter reencaminhamentos adicionais.

include_metadata

bool

valor predefinido: False

Especifica que os metadados do contentor são devolvidos na resposta.

marker

str

valor predefinido: None

Um token de continuação opaco. Este valor pode ser obtido a partir do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver concluído a enumeração de resultados. Se for especificado, este gerador começará a devolver resultados do ponto em que o gerador anterior parou.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

make_blob_url

Cria o URL para aceder a um blob.

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

Parâmetros

container_name

str

Necessário

Nome do contentor.

blob_name

str

Necessário

Nome do blob.

protocol

str

valor predefinido: None

Protocolo a utilizar: "http" ou "https". Se não for especificado, utiliza o protocolo especificado quando BaseBlobService foi inicializado.

sas_token

str

valor predefinido: None

Token de assinatura de acesso partilhado criado com generate_shared_access_signature.

snapshot

str

valor predefinido: None

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

Devoluções

URL de acesso a blobs.

Tipo de retorno

str

make_container_url

Cria o URL para aceder a um contentor.

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

Parâmetros

container_name

str

Necessário

Nome do contentor.

protocol

str

valor predefinido: None

Protocolo a utilizar: "http" ou "https". Se não for especificado, utiliza o protocolo especificado quando BaseBlobService foi inicializado.

sas_token

str

valor predefinido: None

Token de assinatura de acesso partilhado criado com generate_shared_access_signature.

Devoluções

URL de acesso ao contentor.

Tipo de retorno

str

release_blob_lease

Liberta a concessão. A concessão poderá ser libertada se o ID de concessão especificado no pedido corresponder ao associado ao blob. Libertar a concessão permite que outro cliente adquira imediatamente a concessão do blob assim que a versão estiver 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

lease_id

str

Necessário

ID de concessão para concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

release_container_lease

Liberte a concessão. A concessão poderá ser libertada se o lease_id especificado corresponder ao associado ao contentor. A libertação da concessão permite que outro cliente adquira imediatamente a concessão do contentor assim que a versão estiver concluída.

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

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

lease_id

str

Necessário

ID de concessão para concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

renew_blob_lease

Renova a concessão. A concessão pode ser renovada se o ID de concessão especificado no pedido corresponder ao associado ao blob. Tenha em atenção que a concessão pode ser renovada mesmo que tenha expirado desde que o blob não tenha sido modificado ou concedido novamente desde a expiração dessa concessão. Quando renova uma concessão, o relógio de duração da concessão é reposto.

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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

lease_id

str

Necessário

ID de concessão para concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

str

renew_container_lease

Renova a concessão. A concessão pode ser renovada se o ID de concessão especificado corresponder ao associado ao contentor. Tenha em atenção que a concessão pode ser renovada mesmo que tenha expirado, desde que o contentor não tenha sido novamente arrendado desde a expiração dessa concessão. Quando renova uma concessão, o relógio de duração da concessão é reposto.

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

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

lease_id

str

Necessário

ID de concessão para concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

str

set_blob_metadata

Define metadados definidos pelo utilizador para o blob especificado como um ou mais pares 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

metadata

dict(str, str)

valor predefinido: None

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

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

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

Tipo de retorno

ResourceProperties

set_blob_properties

Define as propriedades do sistema no blob. Se uma propriedade estiver 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

content_settings

ContentSettings

valor predefinido: None

Objeto ContentSettings utilizado para definir propriedades de blobs.

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para efetuar a operação apenas se o recurso não existir e falhar a operação se existir.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

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

Tipo de retorno

ResourceProperties

set_blob_service_properties

Define as propriedades do serviço Blob de uma conta de armazenamento, incluindo o Azure Análise de Armazenamento. Se um elemento (ex Registo) for deixado como Nenhum, as definiçõ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 predefinido: None

Agrupa as definições de Registo do Azure Analytics.

hour_metrics

Metrics

valor predefinido: None

As definições de métricas de hora fornecem um resumo das estatísticas de pedido agrupadas pela API em agregados por hora para blobs.

minute_metrics

Metrics

valor predefinido: None

As definições de métricas de minutos fornecem estatísticas de pedidos para cada minuto para blobs.

cors

list(CorsRule)

valor predefinido: None

Pode incluir até cinco elementos CorsRule na lista. Se for especificada uma lista vazia, todas as regras CORS serão eliminadas e o CORS será desativado para o serviço.

target_version

str

valor predefinido: None

Indica a versão predefinida a utilizar para pedidos se a versão de um pedido de entrada não for especificada.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

delete_retention_policy

DeleteRetentionPolicy

valor predefinido: None

A política de retenção eliminar especifica se pretende reter blobs eliminados. Também especifica o número de dias e versões do blob a manter.

static_website

StaticWebsite

valor predefinido: None

Especifica se a funcionalidade de site estático estático está ativada e, se sim, indica o documento de índice e o documento de erro 404 a utilizar.

set_container_acl

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

set_container_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

Necessário

Nome do contentor existente.

signed_identifiers

dict(str, AccessPolicy)

valor predefinido: None

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

public_access

PublicAccess

valor predefinido: None

Os valores possíveis incluem: contentor, blob.

lease_id

str

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

ETag e propriedades modificadas pela última vez para o Contentor atualizado

Tipo de retorno

ResourceProperties

set_container_metadata

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

set_container_metadata(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

metadata

dict(str, str)

valor predefinido: None

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

lease_id

str

valor predefinido: None

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

if_modified_since

datetime

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

ETag e propriedades modificadas pela última vez para o Contentor atualizado

Tipo de retorno

ResourceProperties

set_proxy

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

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

Parâmetros

host

str

Necessário

Endereço do proxy. Ex: '192.168.0.100'

port

int

Necessário

Porta do proxy. Ex: 6000

user

str

valor predefinido: None

Utilizador para autorização de proxy.

password

str

valor predefinido: None

Palavra-passe para autorização de proxy.

snapshot_blob

Cria um instantâneo só de 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

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

metadata

dict(str, str)

valor predefinido: None

Especifica um par nome-valor definido pelo utilizador associado ao blob. Se não forem especificados pares nome-valor, a operação copiará os metadados do blob base para o instantâneo. Se forem especificados um ou mais pares name-value, o instantâneo é criado com os metadados especificados e os metadados não são copiados do blob base.

if_modified_since

datetime

valor predefinido: None

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

if_unmodified_since

datetime

valor predefinido: None

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

if_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (*). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso corresponder ao valor especificado.

if_none_match

str

valor predefinido: None

Um valor ETag ou o caráter universal (). Especifique este cabeçalho para executar a operação apenas se a ETag do recurso não corresponder ao valor especificado. Especifique o caráter universal () para executar a operação apenas se o recurso não existir e falhe a operação se existir.

lease_id

str

valor predefinido: None

Necessário se o blob tiver uma concessão ativa.

cpk

CustomerProvidedEncryptionKey

valor predefinido: None

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

timeout

int

valor predefinido: None

O parâmetro de tempo limite é expresso em segundos.

Devoluções

propriedades do instantâneo

Tipo de retorno

Blob

undelete_blob

A operação anular a eliminação de Blobs restaura os conteúdos e metadados do blob ou instantâneo eliminado de forma recuperável. Tentar anular a eliminação de um blob ou instantâneo que não seja eliminado de forma recuperável será bem-sucedido sem quaisquer alterações.

undelete_blob(container_name, blob_name, timeout=None)

Parâmetros

container_name

str

Necessário

Nome do contentor existente.

blob_name

str

Necessário

Nome do blob existente.

timeout

int

valor predefinido: None

O parâmetro de tempo limite é 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