PageBlobService Classe
Blobs de página são uma coleção de páginas de 512 bytes otimizadas para leitura aleatória e operações de gravação. Para criar um blob de página, inicialize-o e especifique o tamanho máximo que ele terá. Para adicionar ou atualizar o conteúdo de um blob de página, grave uma página, ou páginas, especificando um deslocamento e um intervalo que se alinhem aos limites de página de 512 bytes. Uma gravação em um blob de página pode substituir apenas uma página, algumas páginas, ou até 4 MB do blob de página. As gravações nos blobs de página acontecem in-loco e são imediatamente confirmadas no blob. O tamanho máximo de um blob de páginas é de 8 TB.
:type ~azure.storage.common.TokenCredential
- Herança
-
PageBlobService
Construtor
PageBlobService(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
O nome da conta de armazenamento. Isso é usado para autenticar solicitações assinadas com uma chave de conta e para construir o ponto de extremidade de armazenamento. Ele é necessário, a menos que um cadeia de conexão seja fornecido ou se um domínio personalizado for usado com autenticação anônima.
- account_key
- str
A chave da conta de armazenamento. Isso é usado para autenticação de chave compartilhada. Se nenhuma chave de conta ou token sas for especificado, o acesso anônimo será usado.
- sas_token
- str
Um token de assinatura de acesso compartilhado a ser usado para autenticar solicitações em vez da chave de conta. Se a chave de conta e o token sas forem especificados, a chave de conta será usada para assinar. Se nenhum for especificado, o acesso anônimo será usado.
- is_emulated
- bool
Se o emulador deve ser usado. Usa False como padrão. Se especificado, substituirá todos os outros parâmetros além de cadeia de conexão e sessão de solicitação.
- endpoint_suffix
- str
O componente base do host da URL, menos o nome da conta. O padrão é Azure (core.windows.net). Substitua isso para usar a nuvem da China (core.chinacloudapi.cn).
- custom_domain
- str
O domínio personalizado a ser usado. Isso pode ser definido no Portal do Azure. Por exemplo, 'www.mydomain.com'.
- request_session
- <xref:requests.Session>
O objeto de sessão a ser usado para solicitações HTTP.
- connection_string
- str
Se especificado, isso substituirá todos os outros parâmetros além da sessão de solicitação. Confira http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ o formato de cadeia de conexão.
- socket_timeout
- int
Se especificado, isso substituirá o tempo limite do soquete padrão. O tempo limite especificado é em segundos. Consulte DEFAULT_SOCKET_TIMEOUT em _constants.py para obter o valor padrão.
- token_credential
Uma credencial de token usada para autenticar solicitações HTTPS. O valor do token deve ser atualizado antes de sua expiração.
Variáveis
- MAX_PAGE_SIZE
- int
O tamanho das páginas colocadas pelos métodos create_blob_from_*. Páginas menores poderão ser colocadas se houver menos dados fornecidos. O tamanho máximo da página compatível com o serviço é de 4 MB. Ao usar os métodos create_blob_from_*, páginas vazias são ignoradas.
Métodos
| abort_copy_blob |
Anula uma operação de copy_blob pendente e deixa um blob de destino com comprimento zero e metadados completos. |
| acquire_blob_lease |
Solicita uma nova concessão. Se o blob não tiver uma concessão ativa, o serviço Blob criará uma no blob e retornará uma nova ID de concessão. |
| acquire_container_lease |
Solicita uma nova concessão. Se o contêiner não tiver uma concessão ativa, o serviço Blob criará uma no contêiner e retornará uma nova ID de concessão. |
| batch_delete_blobs |
Envia um lote de várias solicitações de exclusão de blob. O método de exclusão de blob exclui o blob ou o instantâneo especificados. Observe que a exclusão de um blob também exclui todos os seus instantâneos. Para obter mais informações, consulte https://docs.microsoft.com/rest/api/storageservices/delete-blob. |
| break_blob_lease |
Quebra a concessão, se o blob tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão é permitido decorrido, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no blob. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Também é possível liberar uma concessão interrompida. Nesse caso, outro cliente pode adquirir imediatamente a concessão no blob. |
| break_container_lease |
Quebre a concessão, se o contêiner tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão é permitido decorrido, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no contêiner. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. |
| change_blob_lease |
Altera a ID de uma concessão ativa. Uma alteração deve incluir a ID de concessão atual e uma nova ID de concessão. |
| change_container_lease |
Altere a ID de concessão de uma concessão ativa. Uma alteração deve incluir a ID de concessão atual e uma nova ID de concessão. |
| clear_page |
Limpa um intervalo de páginas. |
| copy_blob |
Copia um blob de forma assíncrona. Esta operação retorna um objeto de propriedades da operação de cópia, incluindo uma ID de cópia que você pode usar para marcar ou anular a operação de cópia. O serviço Blob copia blobs em uma base do melhor esforço. O blob de origem de uma operação de cópia deve ser um blob de páginas. Se o blob de destino já existir, ele deverá ser do mesmo tipo do blob de origem. Qualquer blob de destino existente será substituído. O blob de destino não pode ser modificado quando uma operação de cópia está em andamento. Ao copiar de um blob de páginas, o serviço Blob cria um blob de páginas de destino do comprimento do blob de origem, inicialmente contendo todos os zeros. Os intervalos de páginas de origem são enumerados em seguida e os intervalos não vazios são copiados. Se a camada no blob de origem for maior do que a camada que está sendo passada para essa operação de cópia ou se o tamanho do blob exceder a camada que está sendo passada para essa operação de cópia, a operação falhará. Você pode chamar get_blob_properties no blob de destino para marcar o status da operação de cópia. O blob final será confirmado quando a cópia for concluída. |
| create_blob |
Cria um novo Blob de Páginas. Confira create_blob_from_* para funções de alto nível que lidam com a criação e o upload de blobs grandes com notificações de agrupamento automático e progresso. |
| create_blob_from_bytes |
Cria um novo blob de uma matriz de bytes ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso. Partes vazias são ignoradas, enquanto as não emtpy (mesmo que apenas parcialmente preenchidas) são carregadas. |
| create_blob_from_path |
Cria um novo blob de um caminho de arquivo ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso. Partes vazias são ignoradas, enquanto as não emtpy (mesmo que apenas parcialmente preenchidas) são carregadas. |
| create_blob_from_stream |
Cria um novo blob de um arquivo/fluxo ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso. Partes vazias são ignoradas, enquanto as não emtpy (mesmo que apenas parcialmente preenchidas) são carregadas. |
| create_container |
Cria um novo contêiner na conta especificada. Se o contêiner com o mesmo nome já existir, a operação falhará se fail_on_exist for True. |
| delete_blob |
Marca o blob ou instantâneo especificado para exclusão. O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob. Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá o blob ou instantâneo e manterá o blob ou instantâneo para o número especificado de dias. Após o número especificado de dias, os dados do blob são removidos do serviço durante a coleta de lixo. O blob ou instantâneo excluídos reversível é acessível por meio da API de Blobs de Lista especificando a opção include=Include.Deleted. Blob ou instantâneo excluídos temporariamente podem ser restaurados usando a API Undelete. |
| delete_container |
Marca o contêiner especificado para exclusão. O contêiner e todos os blobs contidos são excluídos posteriormente, durante a coleta de lixo. |
| exists |
Retorna um booliano que indica se o contêiner existe (se blob_name for Nenhum) ou um booliano indicando se o blob existe. |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
Gera uma assinatura de acesso compartilhado para o serviço blob. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService. |
| generate_blob_shared_access_signature |
Gera uma assinatura de acesso compartilhado para o blob ou um de seus instantâneos. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService. |
| generate_container_shared_access_signature |
Gera uma assinatura de acesso compartilhado para o contêiner. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService. |
| get_blob_account_information |
Obtém informações relacionadas à conta de armazenamento. As informações também poderão ser recuperadas se o usuário tiver uma SAS para um contêiner ou blob. |
| get_blob_metadata |
Retorna todos os metadados definidos pelo usuário para o blob ou instantâneo especificados. |
| get_blob_properties |
Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o blob. Ela não retorna o conteúdo do blob. Retorna Blob com BlobProperties e um dict de metadados. |
| get_blob_service_properties |
Obtém as propriedades do serviço Blob de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure. |
| get_blob_service_stats |
Recupera as estatísticas relacionadas à replicação do serviço Blob. Ela só estará disponível quando a replicação com redundância geográfica de acesso de leitura estiver habilitada para a conta de armazenamento. Com a replicação georredundante, o Armazenamento do Azure mantém seus dados duráveis em dois locais. Em ambos os locais, o Armazenamento do Azure mantém constantemente várias réplicas íntegras de seus dados. O local onde você lê, cria, atualiza ou exclui dados é o local da conta de armazenamento principal. O local principal existe na região escolhida no momento em que você cria uma conta por meio do Portal Clássico do Azure de Gerenciamento do Azure, por exemplo, Centro-Norte dos EUA. O local no qual seus dados são replicados é o local secundário. O local secundário é determinado automaticamente com base no local principal; ele está em um segundo data center que reside na mesma região que o local principal. O acesso somente leitura está disponível no local secundário se a replicação georredundante de acesso de leitura está habilitada para sua conta de armazenamento. |
| get_blob_to_bytes |
Baixa um blob como uma matriz de bytes, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades, metadados e conteúdo. |
| get_blob_to_path |
Baixa um blob em um caminho de arquivo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades e metadados. |
| get_blob_to_stream |
Baixa um blob em um fluxo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades e metadados. |
| get_blob_to_text |
Baixa um blob como texto unicode, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades, metadados e conteúdo. |
| get_container_acl |
Obtém as permissões para o contêiner especificado. As permissões indicam se os dados de um contêiner podem ser acessados publicamente. |
| get_container_metadata |
Retorna todos os metadados definidos pelo usuário para o contêiner especificado. |
| get_container_properties |
Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o contêiner especificado. Os dados retornados não incluem a lista do contêiner de blobs. |
| get_page_ranges |
Retorna a lista de intervalos de página válidos para um Blob de Páginas ou instantâneo de um blob de páginas. |
| get_page_ranges_diff |
A resposta incluirá apenas as páginas diferentes entre um instantâneo recente ou o blob atual e um instantâneo anterior, incluindo páginas que foram desmarcadas. |
| get_user_delegation_key |
Obtenha uma chave de delegação de usuário com a finalidade de assinar tokens SAS. Uma credencial de token deve estar presente no objeto de serviço para que essa solicitação seja bem-sucedida. |
| incremental_copy_blob |
Copia uma cópia incremental de um blob de forma assíncrona. Esta operação retorna um objeto de propriedades da operação de cópia, incluindo uma ID de cópia que você pode usar para marcar ou anular a operação de cópia. O serviço Blob copia blobs em uma base do melhor esforço. O blob de origem para uma operação de cópia incremental deve ser um blob de páginas. Chame get_blob_properties no blob de destino para marcar o status da operação de cópia. O blob final será confirmado quando a cópia for concluída. |
| list_blob_names |
Retorna um gerador para listar os nomes de blob no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e será interrompido quando todos os blobs forem retornados ou num_results for atingido. Se num_results for especificado e a conta tiver mais do que esse número de blobs, o gerador terá um campo de next_marker populado quando terminar. Esse marcador pode ser usado para criar um novo gerador se mais resultados forem desejados. |
| list_blobs |
Retorna um gerador para listar os blobs no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e será interrompido quando todos os blobs forem retornados ou num_results for atingido. Se num_results for especificado e a conta tiver mais do que esse número de blobs, o gerador terá um campo de next_marker populado quando terminar. Esse marcador pode ser usado para criar um novo gerador se mais resultados forem desejados. |
| list_containers |
Retorna um gerador para listar os contêineres na conta especificada. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os contêineres forem retornados ou num_results for atingido. Se num_results for especificado e a conta tiver mais do que esse número de contêineres, o gerador terá um campo de next_marker populado assim que for concluído. Esse marcador pode ser usado para criar um novo gerador se mais resultados forem desejados. |
| make_blob_url |
Cria a URL para acessar um blob. |
| make_container_url |
Cria a URL para acessar um contêiner. |
| release_blob_lease |
Libera a concessão. A concessão poderá ser liberada se a ID especificada na solicitação corresponder à associada ao blob. A liberação da concessão permite que outro cliente adquira imediatamente a concessão do blob assim que a liberação é concluída. |
| release_container_lease |
Libera a concessão. A concessão poderá ser liberada se o lease_id especificado corresponder ao associado ao contêiner. A liberação da concessão permite que outro cliente adquira imediatamente a concessão do contêiner assim que a liberação é concluída. |
| renew_blob_lease |
Renova a concessão. A concessão poderá ser renovada se a ID especificada na solicitação corresponder à associada ao blob. Observe que a concessão poderá ser renovada mesmo se tiver expirado, desde que o blob não tenha sido alterado nem concedido novamente desde a expiração da concessão. Quando você renova uma concessão, o relógio de duração é redefinido. |
| renew_container_lease |
Renova a concessão. A concessão poderá ser renovada se a ID de concessão especificada corresponder à associada ao contêiner. Observe que a concessão poderá ser renovada mesmo se tiver expirado, desde que o contêiner não tenha sido concedido novamente desde a expiração da concessão. Quando você renova uma concessão, o relógio de duração é redefinido. |
| resize_blob |
Redimensiona um blob da página ao tamanho especificado. Se o valor especificado for menor do que o tamanho atual do blob, todas as páginas acima do valor especificado serão limpas. |
| set_blob_metadata |
Define metadados definidos pelo usuário para o blob especificado como um ou mais pares de nome-valor. |
| set_blob_properties |
Define as propriedades do sistema no blob. Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas. |
| set_blob_service_properties |
Define as propriedades do serviço Blob de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure. Se um elemento (ex Logging) for deixado como Nenhum, as configurações existentes no serviço para essa funcionalidade serão preservadas. |
| set_container_acl |
Define as permissões para o contêiner especificado ou políticas de acesso armazenadas que podem ser usadas com assinaturas de acesso compartilhado. As permissões indicam se os blobs de um contêiner podem ser acessados publicamente. |
| set_container_metadata |
Define um ou mais pares nome-valor definidos pelo usuário para o contêiner especificado. Cada chamada para essa operação substitui todos os metadados existentes anexados ao contêiner. Para remover todos os metadados do contêiner, chame essa operação sem um ditado de metadados. |
| set_premium_page_blob_tier |
Define as camadas de blob de página no blob. Essa API só tem suporte para blobs de páginas em contas premium. |
| set_proxy |
Define o host e a porta do servidor proxy para o Túnel HTTP CONNECT. |
| set_sequence_number |
Define o número da sequência de blob. |
| snapshot_blob |
Cria um instantâneo somente leitura de um blob. |
| undelete_blob |
A operação Desdelete Blob restaura o conteúdo e os metadados do blob ou do instantâneo excluídos. A tentativa de desmarcar um blob ou instantâneo que não seja excluído de forma reversível terá êxito sem nenhuma alteração. |
| update_page |
Atualizações um intervalo de páginas. |
| update_page_from_url |
Atualizações um intervalo de páginas para um blob de páginas em que o conteúdo é lido de uma URL. |
abort_copy_blob
Anula uma operação de copy_blob pendente e deixa um blob de destino com comprimento zero e metadados completos.
abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)Parâmetros
- copy_id
- str
Identificador de cópia fornecido no copy.id da operação de copy_blob original.
- lease_id
- str
Obrigatório se o blob de destino tiver uma concessão infinita ativa.
acquire_blob_lease
Solicita uma nova concessão. Se o blob não tiver uma concessão ativa, o serviço Blob criará uma no blob e retornará uma nova ID de concessão.
acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- lease_duration
- int
Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).
- proposed_lease_id
- str
ID proposta da concessão, em um formato de cadeia de caracteres GUID. O serviço Blob retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Retornos
str
acquire_container_lease
Solicita uma nova concessão. Se o contêiner não tiver uma concessão ativa, o serviço Blob criará uma no contêiner e retornará uma nova ID de concessão.
acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)Parâmetros
- lease_duration
- int
Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).
- proposed_lease_id
- str
ID proposta da concessão, em um formato de cadeia de caracteres GUID. O serviço Blob retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
Retornos
str
batch_delete_blobs
Envia um lote de várias solicitações de exclusão de blob.
O método de exclusão de blob exclui o blob ou o instantâneo especificados. Observe que a exclusão de um blob também exclui todos os seus instantâneos. Para obter mais informações, consulte https://docs.microsoft.com/rest/api/storageservices/delete-blob.
batch_delete_blobs(batch_delete_sub_requests, timeout=None)Parâmetros
- batch_delete_sub_requests
- list(BatchDeleteSubRequest)
As solicitações de exclusão de blob a serem enviadas como um lote.
Retornos
resposta HTTP de exclusão em lote analisada
Tipo de retorno
break_blob_lease
Quebra a concessão, se o blob tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão é permitido decorrido, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no blob. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.
Também é possível liberar uma concessão interrompida. Nesse caso, outro cliente pode adquirir imediatamente a concessão no blob.
break_blob_lease(container_name, blob_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- lease_break_period
- int
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. Esse ponto de interrupção é usado somente se for menor do que o tempo restante da concessão. Se for mais longo, o tempo restante da concessão será usado. Uma nova concessão só estará disponível após a expiração do ponto de interrupção, mas a concessão poderá ser mantida por mais tempo do que o período de interrupção. Se esse cabeçalho não aparecer com uma operação de interrupção, uma concessão de duração fixa será interrompida após o período de concessão restante decorrido e uma concessão infinita será interrompida imediatamente.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Retornos
INT
break_container_lease
Quebre a concessão, se o contêiner tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão é permitido decorrido, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no contêiner. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.
break_container_lease(container_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, timeout=None)Parâmetros
- lease_break_period
- int
Esta é a duração proposta de segundos que a concessão deve continuar antes de ser quebrada, entre 0 e 60 segundos. Esse ponto de interrupção é usado somente se for menor do que o tempo restante da concessão. Se for mais longo, o tempo restante da concessão será usado. Uma nova concessão só estará disponível após a expiração do ponto de interrupção, mas a concessão poderá ser mantida por mais tempo do que o período de interrupção. Se esse cabeçalho não aparecer com uma operação de interrupção, uma concessão de duração fixa será interrompida após o período de concessão restante decorrido e uma concessão infinita será interrompida imediatamente.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
Retornos
INT
change_blob_lease
Altera a ID de uma concessão ativa. Uma alteração deve incluir a ID de concessão atual e uma nova ID de concessão.
change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- proposed_lease_id
- str
ID proposta da concessão, em um formato de cadeia de caracteres GUID. O serviço Blob retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
change_container_lease
Altere a ID de concessão de uma concessão ativa. Uma alteração deve incluir a ID de concessão atual e uma nova ID de concessão.
change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)Parâmetros
- proposed_lease_id
- str
ID proposta da concessão, em um formato de cadeia de caracteres GUID. O serviço Blob retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
clear_page
Limpa um intervalo de páginas.
clear_page(container_name, blob_name, start_range, end_range, lease_id=None, if_sequence_number_lte=None, if_sequence_number_lt=None, if_sequence_number_eq=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- start_range
- int
Início do intervalo de bytes a ser usado para gravar em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos: 0 a 511, 512 a 1023 etc.
- end_range
- int
Fim do intervalo de bytes a ser usado para gravação em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos: 0 a 511, 512 a 1023 etc.
- if_sequence_number_lte
- int
Se o número de sequência do blob for menor ou igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_sequence_number_lt
- int
Se o número de sequência do blob for menor que o valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_sequence_number_eq
- int
Se o número de sequência do blob for igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique um valor ETag para esse cabeçalho condicional para gravar a página somente se o valor ETag do blob corresponder ao valor especificado. Se os valores não corresponderem, o serviço Blob falhará.
- if_none_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique um valor ETag para esse cabeçalho condicional para gravar a página somente se o valor ETag do blob não corresponder ao valor especificado. Se os valores forem idênticos, o serviço Blob falhará.
Retornos
ETag e propriedades modificadas pela última vez para o Blob de Páginas atualizado
Tipo de retorno
copy_blob
Copia um blob de forma assíncrona. Esta operação retorna um objeto de propriedades da operação de cópia, incluindo uma ID de cópia que você pode usar para marcar ou anular a operação de cópia. O serviço Blob copia blobs em uma base do melhor esforço.
O blob de origem de uma operação de cópia deve ser um blob de páginas. Se o blob de destino já existir, ele deverá ser do mesmo tipo do blob de origem. Qualquer blob de destino existente será substituído. O blob de destino não pode ser modificado quando uma operação de cópia está em andamento.
Ao copiar de um blob de páginas, o serviço Blob cria um blob de páginas de destino do comprimento do blob de origem, inicialmente contendo todos os zeros. Os intervalos de páginas de origem são enumerados em seguida e os intervalos não vazios são copiados.
Se a camada no blob de origem for maior do que a camada que está sendo passada para essa operação de cópia ou se o tamanho do blob exceder a camada que está sendo passada para essa operação de cópia, a operação falhará.
Você pode chamar get_blob_properties no blob de destino para marcar o status da operação de cópia. O blob final será confirmado quando a cópia for concluída.
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, premium_page_blob_tier=None)Parâmetros
- blob_name
- str
Nome do blob de destino. Se o blob de destino existir, ele será substituído. Caso contrário, ele será criado.
- copy_source
- str
Uma URL de até 2 KB de comprimento que especifica um arquivo ou blob do Azure. O valor deve ser codificado em URL tal como apareceria em um pedido URI. Se a origem estiver em outra conta, a origem deverá ser pública ou deve ser autenticada por meio de uma assinatura de acesso compartilhado. Se a origem for pública, nenhuma autenticação será necessária. Exemplos: https://myaccount.blob.core.windows.net/mycontainer/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?instantâneo=https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken
Pares de nome-valor associados ao blob como metadados. Se nenhum par nome-valor for especificado, a operação copiará os metadados do blob ou arquivo de origem para o blob de destino. Se um ou mais pares nome-valor forem especificados, o blob de destino será criado com os metadados especificados e os metadados não serão copiados do blob ou arquivo de origem.
- source_if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de origem tiver sido modificado desde a data/hora especificada.
- source_if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de origem não tiver sido modificado desde a data/hora especificada.
- source_if_match
- <xref:ETag>
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho condicional para copiar o blob de origem somente se a ETag corresponder ao valor especificado. Se os valores de ETag não coincidirem, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). Esse cabeçalho não poderá ser especificado se a origem for um Arquivo do Azure.
- source_if_none_match
- <xref:ETag>
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho condicional para copiar o blob de origem somente se a ETag não corresponder ao valor especificado. Se os valores forem idênticos, o serviço Blob retornará o código de status 412 (Falha na Pré-condição). Esse cabeçalho não poderá ser especificado se a origem for um Arquivo do Azure.
- destination_if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de destino tiver sido modificado desde a data/hora especificada. Se o blob de destino não tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição).
- destination_if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de destino não tiver sido modificado desde a data/hora especificada. Se o blob de destino tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição).
- destination_if_match
- <xref:ETag>
Um valor de ETag ou o caractere curinga (*). Especifique um valor ETag para esse cabeçalho condicional para copiar o blob somente se o valor ETag especificado corresponder ao valor de ETag para um blob de destino existente. Se a ETag do blob de destino não corresponder à ETag especificada para If-Match, o serviço Blob retornará status código 412 (Falha na pré-condição).
- destination_if_none_match
- <xref:ETag>
Um valor ETag ou o caractere curinga (). Especifique um valor de ETag para esse cabeçalho condicional para copiar o blob somente se o valor ETag especificado não corresponder ao valor de ETag para o blob de destino. Especifique o caractere curinga () para executar a operação somente se o blob de destino não existir. Se a condição especificada não for atendida, o serviço Blob retornará o código de status 412 (Falha na Pré-condição).
- destination_lease_id
- str
A ID da concessão especificada para esse cabeçalho deve corresponder à ID de concessão do blob de destino. Se a solicitação não incluir a ID de concessão ou não for válida, a operação falhará com o código de status 412 (Falha na Pré-condição).
- source_lease_id
- str
Especifique isso para executar a operação Copiar Blob somente se a ID de concessão fornecida corresponder à ID de concessão ativa do blob de origem.
- premium_page_blob_tier
- <xref:PageBlobTier>
Um valor da camada de blob de páginas a ser definido no blob de destino. A camada correlaciona-se ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento Premium. Se a camada no blob de origem for maior do que a camada que está sendo passada para essa operação de cópia ou se o tamanho do blob exceder a camada que está sendo passada para essa operação de cópia, a operação falhará.
Retornos
Copie as propriedades da operação, como status, origem e ID.
Tipo de retorno
create_blob
Cria um novo Blob de Páginas.
Confira create_blob_from_* para funções de alto nível que lidam com a criação e o upload de blobs grandes com notificações de agrupamento automático e progresso.
create_blob(container_name, blob_name, content_length, content_settings=None, sequence_number=None, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, premium_page_blob_tier=None, cpk=None)Parâmetros
- content_length
- int
Obrigatórios. Esse cabeçalho especifica o tamanho máximo do blob de páginas, até 1 TB. O tamanho do blob de páginas deve ser alinhado a um limite de 512 bytes.
- content_settings
- ContentSettings
Objeto ContentSettings usado para definir propriedades no blob.
- sequence_number
- int
O número de sequência é um valor controlado pelo usuário que você pode usar para rastrear solicitações. O valor do número de sequência deve ficar entre 0 e 2^63 - 1. O valor padrão é 0.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
- premium_page_blob_tier
- PremiumPageBlobTier
Um valor da camada de blob de páginas para o qual definir o blob. A camada correlaciona-se ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento Premium.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
ETag e propriedades modificadas pela última vez para o novo Blob de Páginas
Tipo de retorno
create_blob_from_bytes
Cria um novo blob de uma matriz de bytes ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso. Partes vazias são ignoradas, enquanto as não emtpy (mesmo que apenas parcialmente preenchidas) são carregadas.
create_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, premium_page_blob_tier=None, cpk=None)Parâmetros
- count
- int
Número de bytes a serem carregados. Defina como Nenhum ou valor negativo para carregar todos os bytes a partir do índice.
- content_settings
- ContentSettings
Objeto ContentSettings usado para definir propriedades de blob.
- validate_content
- bool
Se for true, calculará um hash MD5 para cada página do blob. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é importante principalmente para detectar bitflips na transmissão se usar http em vez de https como https (o padrão) já será validado. Observe que esse hash MD5 não é armazenado com o blob.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Retorno de chamada para progresso com função de assinatura (atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob ou Nenhum se o tamanho total for desconhecido.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
- timeout
- int
O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
- premium_page_blob_tier
Um valor da camada de blob de páginas para o qual definir o blob. A camada correlaciona-se ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento Premium.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
ETag e propriedades modificadas pela última vez para o Blob de Páginas
Tipo de retorno
create_blob_from_path
Cria um novo blob de um caminho de arquivo ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso. Partes vazias são ignoradas, enquanto as não emtpy (mesmo que apenas parcialmente preenchidas) são carregadas.
create_blob_from_path(container_name, blob_name, file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, premium_page_blob_tier=None, cpk=None)Parâmetros
- content_settings
- ContentSettings
Objeto ContentSettings usado para definir propriedades de blob.
- validate_content
- bool
Se for true, calculará um hash MD5 para cada página do blob. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é importante principalmente para detectar bitflips na transmissão se usar http em vez de https como https (o padrão) já será validado. Observe que esse hash MD5 não é armazenado com o blob.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Retorno de chamada para progresso com função de assinatura (atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob ou Nenhum se o tamanho total for desconhecido.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
- timeout
- int
O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
- premium_page_blob_tier
Um valor da camada de blob de páginas para o qual definir o blob. A camada correlaciona-se ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento Premium.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
Propriedades ETag e última modificação para o Blob de Páginas
Tipo de retorno
create_blob_from_stream
Cria um novo blob de um arquivo/fluxo ou atualiza o conteúdo de um blob existente, com notificações automáticas de agrupamento e progresso. Partes vazias são ignoradas, enquanto as não emtpy (mesmo que apenas parcialmente preenchidas) são carregadas.
create_blob_from_stream(container_name, blob_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, premium_page_blob_tier=None, cpk=None)Parâmetros
- count
- int
Número de bytes a serem lidos do fluxo. Isso é necessário, um blob de páginas não pode ser criado se a contagem for desconhecida.
- content_settings
- ContentSettings
Objeto ContentSettings usado para definir as propriedades do blob.
- validate_content
- bool
Se for true, calculará um hash MD5 para cada página do blob. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é importante principalmente para detectar bitflips no fio se o uso de http em vez de https como https (o padrão) já validará. Observe que esse hash MD5 não é armazenado com o blob.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Retorno de chamada para progresso com função de assinatura(atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob ou Nenhum se o tamanho total for desconhecido.
- max_connections
- int
Número máximo de conexões paralelas a serem usadas. Observe que o upload paralelo requer que o fluxo seja buscado.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
- timeout
- int
O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
- premium_page_blob_tier
Um valor de camada de blob de página para definir o blob. A camada se correlaciona ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento premium.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
Propriedades ETag e última modificação para o Blob de Páginas
Tipo de retorno
create_container
Cria um novo contêiner na conta especificada. Se o contêiner com o mesmo nome já existir, a operação falhará se fail_on_exist for True.
create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, timeout=None)Parâmetros
- container_name
- str
Nome do contêiner a ser criado. O nome do contêiner só pode conter letras minúsculas, números e hifens e deve começar com uma letra ou um número. Cada hífen deve ser precedido e seguido por um caractere que não seja um hífen. O nome também precisa ter entre 3 e 63 caracteres.
Um ditado com pares name_value para associar ao contêiner como metadados. Exemplo:{'Category':'test'}
- fail_on_exist
- bool
Especifique se deve gerar uma exceção quando o contêiner existir.
Retornos
True se o contêiner for criado, False se o contêiner já existir.
Tipo de retorno
delete_blob
Marca o blob ou instantâneo especificado para exclusão. O blob é excluído posteriormente, durante a coleta de lixo.
Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob.
Se uma política de retenção de exclusão estiver habilitada para o serviço, essa operação excluirá o blob ou instantâneo e manterá o blob ou instantâneo para o número especificado de dias. Após o número especificado de dias, os dados do blob são removidos do serviço durante a coleta de lixo. O blob ou instantâneo excluídos reversível é acessível por meio da API de Blobs de Lista especificando a opção include=Include.Deleted. Blob ou instantâneo excluídos temporariamente podem ser restaurados usando a API Undelete.
delete_blob(container_name, blob_name, snapshot=None, lease_id=None, delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica a instantâneo de blob a ser excluída.
- delete_snapshots
- DeleteSnapshot
Obrigatório se o blob tiver instantâneos associados.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
delete_container
Marca o contêiner especificado para exclusão. O contêiner e todos os blobs contidos são excluídos posteriormente, durante a coleta de lixo.
delete_container(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)Parâmetros
- fail_not_exist
- bool
Especifique se deve gerar uma exceção quando o contêiner não existir.
- lease_id
- str
Se especificado, delete_container só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID. Obrigatório se o contêiner tiver uma concessão ativa.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
Retornos
True se o contêiner for excluído, o contêiner False não existirá.
Tipo de retorno
exists
Retorna um booliano que indica se o contêiner existe (se blob_name for Nenhum) ou um booliano indicando se o blob existe.
exists(container_name, blob_name=None, snapshot=None, timeout=None)Parâmetros
- blob_name
- str
Nome de um blob. Se Nenhum, o contêiner será verificado quanto à existência.
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo.
Retornos
Um booliano que indica se o recurso existe.
Tipo de retorno
extract_date_and_request_id
static extract_date_and_request_id(retry_context)Parâmetros
- retry_context
generate_account_shared_access_signature
Gera uma assinatura de acesso compartilhado para o serviço blob. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)Parâmetros
- resource_types
- <xref:ResourceTypes>
Especifica os tipos de recursos acessíveis com a SAS da conta.
- permission
- <xref:AccountPermissions>
As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. Obrigatório, a menos que uma ID seja fornecida fazendo referência a uma política de acesso armazenada que contenha esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada.
O momento em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que uma ID seja fornecida fazendo referência a uma política de acesso armazenada que contenha esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC.
O momento em que a assinatura de acesso compartilhado se torna válida. Se for omitido, a hora de início para essa chamada será presumida como a hora na qual o serviço de armazenamento recebe a solicitação. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC.
- ip
- str
Especifica um endereço IP ou um intervalo de endereços IP dos quais aceitar solicitações. Se o endereço IP do qual a solicitação se origina não corresponder ao endereço IP ou intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 na SAS restringe a solicitação a esses endereços IP.
- protocol
- str
Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.
Retornos
Um token sas (Assinatura de Acesso Compartilhado).
Tipo de retorno
generate_blob_shared_access_signature
Gera uma assinatura de acesso compartilhado para o blob ou um de seus instantâneos. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.
generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)Parâmetros
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob para conceder permissão.
- permission
- BlobPermissions
As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. As permissões devem ser ordenadas para leitura, gravação, exclusão, lista. Obrigatório, a menos que uma ID seja fornecida fazendo referência a uma política de acesso armazenada que contenha esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada.
O momento em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que uma ID seja fornecida fazendo referência a uma política de acesso armazenada que contenha esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC.
O momento em que a assinatura de acesso compartilhado se torna válida. Se for omitido, a hora de início para essa chamada será presumida como a hora na qual o serviço de armazenamento recebe a solicitação. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC.
- id
- str
Um valor exclusivo de até 64 caracteres de comprimento que se correlaciona a uma política de acesso armazenada. Para criar uma política de acesso armazenada, use set_container_acl.
- ip
- str
Especifica um endereço IP ou um intervalo de endereços IP dos quais aceitar solicitações. Se o endereço IP do qual a solicitação se origina não corresponder ao endereço IP ou intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 na SAS restringe a solicitação a esses endereços IP.
- protocol
- str
Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.
- cache_control
- str
O valor do cabeçalho de resposta para Cache-Control quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- content_disposition
- str
Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- content_encoding
- str
Valor do cabeçalho de resposta para Codificação de Conteúdo quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- content_language
- str
Valor do cabeçalho de resposta para Content-Language quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- content_type
- str
Valor do cabeçalho de resposta para Content-Type quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- user_delegation_key
- UserDelegationKey
Em vez de uma chave de conta, o usuário pode passar uma chave de delegação de usuário. Uma chave de delegação de usuário pode ser obtida do serviço autenticando-se com uma identidade do AAD; isso pode ser feito chamando get_user_delegation_key. Quando presente, a SAS é assinada com a chave de delegação do usuário.
Retornos
Um token sas (Assinatura de Acesso Compartilhado).
Tipo de retorno
generate_container_shared_access_signature
Gera uma assinatura de acesso compartilhado para o contêiner. Use a assinatura retornada com o parâmetro sas_token de qualquer BlobService.
generate_container_shared_access_signature(container_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)Parâmetros
- permission
- ContainerPermissions
As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. As permissões devem ser ordenadas para leitura, gravação, exclusão, lista. Obrigatório, a menos que uma ID seja fornecida fazendo referência a uma política de acesso armazenada que contenha esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada.
O momento em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que uma ID seja fornecida fazendo referência a uma política de acesso armazenada que contenha esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC.
O momento em que a assinatura de acesso compartilhado se torna válida. Se for omitido, a hora de início para essa chamada será presumida como a hora na qual o serviço de armazenamento recebe a solicitação. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC.
- id
- str
Um valor exclusivo de até 64 caracteres de comprimento que se correlaciona a uma política de acesso armazenada. Para criar uma política de acesso armazenada, use set_blob_service_properties.
- ip
- str
Especifica um endereço IP ou um intervalo de endereços IP dos quais aceitar solicitações. Se o endereço IP do qual a solicitação se origina não corresponder ao endereço IP ou intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 na SAS restringe a solicitação a esses endereços IP.
- protocol
- str
Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.
- cache_control
- str
O valor do cabeçalho de resposta para Cache-Control quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- content_disposition
- str
Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- content_encoding
- str
Valor do cabeçalho de resposta para Codificação de Conteúdo quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- content_language
- str
Valor do cabeçalho de resposta para Content-Language quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- content_type
- str
Valor do cabeçalho de resposta para Content-Type quando o recurso é acessado usando essa assinatura de acesso compartilhado.
- user_delegation_key
- UserDelegationKey
Em vez de uma chave de conta, o usuário pode passar uma chave de delegação de usuário. Uma chave de delegação de usuário pode ser obtida do serviço autenticando-se com uma identidade do AAD; isso pode ser feito chamando get_user_delegation_key. Quando presente, a SAS é assinada com a chave de delegação do usuário.
Retornos
Um token sas (Assinatura de Acesso Compartilhado).
Tipo de retorno
get_blob_account_information
Obtém informações relacionadas à conta de armazenamento. As informações também poderão ser recuperadas se o usuário tiver uma SAS para um contêiner ou blob.
get_blob_account_information(container_name=None, blob_name=None, timeout=None)Parâmetros
- container_name
- str
Nome do contêiner existente. Opcional, a menos que use um token SAS para um contêiner ou blob específico, nesse caso ele é necessário.
- blob_name
- str
Nome do blob existente. Opcional, a menos que use um token SAS para um blob específico, nesse caso ele é necessário.
Retornos
get_blob_metadata
Retorna todos os metadados definidos pelo usuário para o blob ou instantâneo especificados.
get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parâmetros
- snapshot
- str
O parâmetro instantâneo é um valor opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
Um dicionário que representa o nome dos metadados de blob, pares de valor.
Tipo de retorno
get_blob_properties
Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o blob. Ela não retorna o conteúdo do blob. Retorna Blob com BlobProperties e um dict de metadados.
get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parâmetros
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
um objeto de blob, incluindo propriedades e metadados.
Tipo de retorno
get_blob_service_properties
Obtém as propriedades do serviço Blob de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure.
get_blob_service_properties(timeout=None)Parâmetros
Retornos
O blob ServiceProperties com uma propriedade target_version anexada.
get_blob_service_stats
Recupera as estatísticas relacionadas à replicação do serviço Blob. Ela só estará disponível quando a replicação com redundância geográfica de acesso de leitura estiver habilitada para a conta de armazenamento.
Com a replicação georredundante, o Armazenamento do Azure mantém seus dados duráveis em dois locais. Em ambos os locais, o Armazenamento do Azure mantém constantemente várias réplicas íntegras de seus dados. O local onde você lê, cria, atualiza ou exclui dados é o local da conta de armazenamento principal. O local principal existe na região escolhida no momento em que você cria uma conta por meio do Portal Clássico do Azure de Gerenciamento do Azure, por exemplo, Centro-Norte dos EUA. O local no qual seus dados são replicados é o local secundário. O local secundário é determinado automaticamente com base no local principal; ele está em um segundo data center que reside na mesma região que o local principal. O acesso somente leitura está disponível no local secundário se a replicação georredundante de acesso de leitura está habilitada para sua conta de armazenamento.
get_blob_service_stats(timeout=None)Parâmetros
Retornos
As estatísticas do serviço blob.
Tipo de retorno
get_blob_to_bytes
Baixa um blob como uma matriz de bytes, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades, metadados e conteúdo.
get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parâmetros
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.
- start_range
- int
Início do intervalo de bytes a ser usado para baixar uma seção do blob. Se nenhuma end_range for fornecida, todos os bytes após a start_range serão baixados. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.
- end_range
- int
Fim do intervalo de bytes a ser usado para baixar uma seção do blob. Se end_range for fornecido, start_range deverá ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.
- validate_content
- bool
Se definido como true, valida um hash MD5 para cada parte recuperada do blob. Isso é importante principalmente para detectar bitflips na transmissão se usar http em vez de https como https (o padrão) já será validado. Observe que o serviço retornará apenas MD5s transacionais para partes de 4 MB ou menos, portanto, a primeira solicitação get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como maior que 4 MB, um erro será gerado. Como a computação do MD5 leva tempo de processamento e mais solicitações precisarão ser feitas devido ao tamanho reduzido da parte, pode haver algum aumento na latência.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Retorno de chamada para progresso com a função de assinatura (atual, total) em que current é o número de bytes transferidos até agora, e total é o tamanho do blob, se conhecido.
- max_connections
- int
Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se esse for o blob inteiro, o método retornará neste ponto. Se não estiver, ele baixará os dados restantes paralelos usando o número de threads igual a max_connections. Cada parte será de tamanho próprio. MAX_CHUNK_GET_SIZE. Se definido como 1, uma única solicitação de obtenção grande será feita. Isso geralmente não é recomendado, mas está disponível se muito poucos threads devem ser usados, as solicitações de rede são muito caras ou um fluxo não pesquisável impede o download paralelo. Isso também pode ser útil se muitos blobs devem estar vazios, pois uma solicitação extra é necessária para blobs vazios se max_connections for maior que 1.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
- timeout
- int
O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
Retornos
Um Blob com propriedades e metadados. Se max_connections for maior que 1, o content_md5 (se definido no blob) não será retornado. Se você precisar desse valor, use get_blob_properties ou defina max_connections como 1.
Tipo de retorno
get_blob_to_path
Baixa um blob em um caminho de arquivo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades e metadados.
get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parâmetros
- open_mode
- str
Modo a ser usado ao abrir o arquivo. Observe que a especificação de acréscimo apenas open_mode impede o download paralelo. Portanto, max_connections deve ser definido como 1 se esse open_mode for usado.
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.
- start_range
- int
Início do intervalo de bytes a ser usado para baixar uma seção do blob. Se nenhuma end_range for fornecida, todos os bytes após o start_range serão baixados. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.
- end_range
- int
Fim do intervalo de bytes a ser usado para baixar uma seção do blob. Se end_range for fornecido, start_range deverá ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.
- validate_content
- bool
Se definido como true, valida um hash MD5 para cada parte recuperada do blob. Isso é importante principalmente para detectar bitflips no fio se o uso de http em vez de https como https (o padrão) já validará. Observe que o serviço retornará apenas MD5s transacionais para partes de 4 MB ou menos, portanto, a primeira solicitação get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como maior que 4 MB, um erro será gerado. Como a computação do MD5 leva tempo de processamento e mais solicitações precisarão ser feitas devido ao tamanho reduzido da parte, pode haver algum aumento na latência.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Retorno de chamada para progresso com função de assinatura(atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob, se conhecido.
- max_connections
- int
Se definido como 2 ou superior, uma obtenção inicial será feita para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se esse for o blob inteiro, o método retornará neste ponto. Se não estiver, ele baixará os dados restantes paralelos usando o número de threads igual a max_connections. Cada parte será de tamanho próprio. MAX_CHUNK_GET_SIZE. Se definido como 1, uma única solicitação get grande será feita. Isso geralmente não é recomendado, mas está disponível se muito poucos threads devem ser usados, as solicitações de rede são muito caras ou um fluxo não pesquisável impede o download paralelo. Isso também pode ser útil se muitos blobs devem estar vazios, pois uma solicitação extra é necessária para blobs vazios se max_connections for maior que 1.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
- timeout
- int
O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
Retornos
Um Blob com propriedades e metadados. Se max_connections for maior que 1, o content_md5 (se definido no blob) não será retornado. Se você precisar desse valor, use get_blob_properties ou defina max_connections como 1.
Tipo de retorno
get_blob_to_stream
Baixa um blob em um fluxo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades e metadados.
get_blob_to_stream(container_name, blob_name, stream, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parâmetros
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.
- start_range
- int
Início do intervalo de bytes a ser usado para baixar uma seção do blob. Se nenhuma end_range for fornecida, todos os bytes após o start_range serão baixados. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.
- end_range
- int
Fim do intervalo de bytes a ser usado para baixar uma seção do blob. Se end_range for fornecido, start_range deverá ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.
- validate_content
- bool
Se definido como true, valida um hash MD5 para cada parte recuperada do blob. Isso é importante principalmente para detectar bitflips no fio se o uso de http em vez de https como https (o padrão) já validará. Observe que o serviço retornará apenas MD5s transacionais para partes de 4 MB ou menos, portanto, a primeira solicitação get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como maior que 4 MB, um erro será gerado. Como a computação do MD5 leva tempo de processamento e mais solicitações precisarão ser feitas devido ao tamanho reduzido da parte, pode haver algum aumento na latência.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Retorno de chamada para progresso com função de assinatura(atual, total) em que atual é o número de bytes transferidos até agora, e total é o tamanho do blob, se conhecido.
- max_connections
- int
Se definido como 2 ou superior, uma obtenção inicial será feita para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se esse for o blob inteiro, o método retornará neste ponto. Se não estiver, ele baixará os dados restantes paralelos usando o número de threads igual a max_connections. Cada parte será de tamanho próprio. MAX_CHUNK_GET_SIZE. Se definido como 1, uma única solicitação get grande será feita. Isso geralmente não é recomendado, mas está disponível se muito poucos threads devem ser usados, as solicitações de rede são muito caras ou um fluxo não pesquisável impede o download paralelo. Isso também pode ser útil se muitos blobs devem estar vazios, pois uma solicitação extra é necessária para blobs vazios se max_connections for maior que 1.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
- timeout
- int
O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
Retornos
Um Blob com propriedades e metadados. Se max_connections for maior que 1, o content_md5 (se definido no blob) não será retornado. Se você precisar desse valor, use get_blob_properties ou defina max_connections como 1.
Tipo de retorno
get_blob_to_text
Baixa um blob como texto unicode, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Blob com propriedades, metadados e conteúdo.
get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parâmetros
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob a ser recuperado.
- start_range
- int
Início do intervalo de bytes a ser usado para baixar uma seção do blob. Se nenhuma end_range for fornecida, todos os bytes após a start_range serão baixados. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.
- end_range
- int
Fim do intervalo de bytes a ser usado para baixar uma seção do blob. Se end_range for fornecido, start_range deverá ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes de blob.
- validate_content
- bool
Se definido como true, valida um hash MD5 para cada parte recuperada do blob. Isso é importante principalmente para detectar bitflips na transmissão se usar http em vez de https como https (o padrão) já será validado. Observe que o serviço retornará apenas MD5s transacionais para partes de 4 MB ou menos, portanto, a primeira solicitação get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como maior que 4 MB, um erro será gerado. Como a computação do MD5 leva tempo de processamento e mais solicitações precisarão ser feitas devido ao tamanho reduzido da parte, pode haver algum aumento na latência.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Retorno de chamada para progresso com a função de assinatura (atual, total) em que current é o número de bytes transferidos até agora, e total é o tamanho do blob, se conhecido.
- max_connections
- int
Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do blob. Se esse for o blob inteiro, o método retornará neste ponto. Se não estiver, ele baixará os dados restantes paralelos usando o número de threads igual a max_connections. Cada parte será de tamanho próprio. MAX_CHUNK_GET_SIZE. Se definido como 1, uma única solicitação de obtenção grande será feita. Isso geralmente não é recomendado, mas está disponível se muito poucos threads devem ser usados, as solicitações de rede são muito caras ou um fluxo não pesquisável impede o download paralelo. Isso também pode ser útil se muitos blobs devem estar vazios, pois uma solicitação extra é necessária para blobs vazios se max_connections for maior que 1.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Descriptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
- timeout
- int
O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
Retornos
Um Blob com propriedades e metadados. Se max_connections for maior que 1, o content_md5 (se definido no blob) não será retornado. Se você precisar desse valor, use get_blob_properties ou defina max_connections como 1.
Tipo de retorno
get_container_acl
Obtém as permissões para o contêiner especificado. As permissões indicam se os dados de um contêiner podem ser acessados publicamente.
get_container_acl(container_name, lease_id=None, timeout=None)Parâmetros
- lease_id
Se especificado, get_container_acl só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.
Retornos
Um dicionário de políticas de acesso associadas ao contêiner. dict de str to AccessPolicy e uma propriedade public_access se o acesso público estiver ativado
get_container_metadata
Retorna todos os metadados definidos pelo usuário para o contêiner especificado.
get_container_metadata(container_name, lease_id=None, timeout=None)Parâmetros
- lease_id
- str
Se especificado, get_container_metadata só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.
Retornos
Um dicionário que representa o nome dos metadados do contêiner, pares de valor.
Tipo de retorno
get_container_properties
Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o contêiner especificado. Os dados retornados não incluem a lista do contêiner de blobs.
get_container_properties(container_name, lease_id=None, timeout=None)Parâmetros
- lease_id
- str
Se especificado, get_container_properties só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.
Retornos
para o contêiner especificado dentro de um objeto de contêiner.
Tipo de retorno
get_page_ranges
Retorna a lista de intervalos de página válidos para um Blob de Páginas ou instantâneo de um blob de páginas.
get_page_ranges(container_name, blob_name, snapshot=None, start_range=None, end_range=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que, quando presente, especifica o instantâneo de blob do qual recuperar informações.
- start_range
- int
Início do intervalo de bytes a ser usado para obter intervalos de página válidos. Se nenhuma end_range for fornecida, todos os bytes após o start_range serão pesquisados. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos são 0-511, 512-, etc.
- end_range
- int
Fim do intervalo de bytes a ser usado para obter intervalos de página válidos. Se end_range for fornecido, start_range deverá ser fornecido. Esse intervalo retornará intervalos de página válidos para desde a inicialização do deslocamento até a extremidade de deslocamento. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos são 0-511, 512-, etc.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Retornos
Uma lista de Intervalos de Páginas válidos para o Blob de Páginas.
Tipo de retorno
get_page_ranges_diff
A resposta incluirá apenas as páginas diferentes entre um instantâneo recente ou o blob atual e um instantâneo anterior, incluindo páginas que foram desmarcadas.
get_page_ranges_diff(container_name, blob_name, previous_snapshot, snapshot=None, start_range=None, end_range=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- previous_snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que especifica um instantâneo de blob anterior a ser comparado com um instantâneo mais recente ou o blob atual.
- snapshot
- str
O parâmetro instantâneo é um valor datetime opaco que especifica um instantâneo de blob mais recente a ser comparado com um instantâneo anterior (previous_snapshot).
- start_range
- int
Início do intervalo de bytes a ser usado para obter intervalos de páginas diferentes. Se nenhuma end_range for fornecida, todos os bytes após o start_range serão pesquisados. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos são 0-511, 512-, etc.
- end_range
- int
Fim do intervalo de bytes a ser usado para obter intervalos de páginas diferentes. Se end_range for fornecido, start_range deverá ser fornecido. Esse intervalo retornará intervalos de página válidos para desde a inicialização do deslocamento até a extremidade de deslocamento. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos são 0-511, 512-, etc.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Retornos
Uma lista de intervalos de páginas diferentes para o Blob de Páginas.
Tipo de retorno
get_user_delegation_key
Obtenha uma chave de delegação de usuário com a finalidade de assinar tokens SAS. Uma credencial de token deve estar presente no objeto de serviço para que essa solicitação seja bem-sucedida.
get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)Parâmetros
Retornos
A chave de delegação do usuário.
Tipo de retorno
incremental_copy_blob
Copia uma cópia incremental de um blob de forma assíncrona. Esta operação retorna um objeto de propriedades da operação de cópia, incluindo uma ID de cópia que você pode usar para marcar ou anular a operação de cópia. O serviço Blob copia blobs em uma base do melhor esforço.
O blob de origem para uma operação de cópia incremental deve ser um blob de páginas. Chame get_blob_properties no blob de destino para marcar o status da operação de cópia. O blob final será confirmado quando a cópia for concluída.
incremental_copy_blob(container_name, blob_name, copy_source, metadata=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
- blob_name
- str
Nome do blob de destino. Se o blob de destino existir, ele será substituído. Caso contrário, ele será criado.
- copy_source
- str
Uma URL de até 2 KB de comprimento que especifica um blob de páginas do Azure. O valor deve ser codificado em URL tal como apareceria em um pedido URI. A origem da cópia deve ser um instantâneo e incluir um token SAS válido ou ser público. Exemplo: https://myaccount.blob.core.windows.net/mycontainer/myblob?instantâneo=&sastoken
Pares de nome-valor associados ao blob como metadados. Se nenhum par nome-valor for especificado, a operação copiará os metadados do blob ou arquivo de origem para o blob de destino. Se um ou mais pares nome-valor forem especificados, o blob de destino será criado com os metadados especificados e os metadados não serão copiados do blob ou arquivo de origem.
- destination_if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de destino tiver sido modificado desde a data/hora especificada. Se o blob de destino não tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição).
- destination_if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho condicional para copiar o blob somente se o blob de destino não tiver sido modificado desde o ate/time especificado. Se o blob de destino tiver sido modificado, o serviço Blob retornará o código de status 412 (Falha na Pré-condição).
- destination_if_match
- <xref:ETag>
Um valor de ETag ou o caractere curinga (*). Especifique um valor ETag para esse cabeçalho condicional para copiar o blob somente se o valor ETag especificado corresponder ao valor de ETag para um blob de destino existente. Se a ETag do blob de destino não corresponder à ETag especificada para If-Match, o serviço Blob retornará status código 412 (Falha na pré-condição).
- destination_if_none_match
- <xref:ETag>
Um valor ETag ou o caractere curinga (). Especifique um valor de ETag para esse cabeçalho condicional para copiar o blob somente se o valor ETag especificado não corresponder ao valor de ETag para o blob de destino. Especifique o caractere curinga () para executar a operação somente se o blob de destino não existir. Se a condição especificada não for atendida, o serviço Blob retornará o código de status 412 (Falha na Pré-condição).
- destination_lease_id
- str
A ID da concessão especificada para esse cabeçalho deve corresponder à ID de concessão do blob de destino. Se a solicitação não incluir a ID de concessão ou não for válida, a operação falhará com o código de status 412 (Falha na Pré-condição).
- source_lease_id
- str
Especifique isso para executar a operação Copiar Blob somente se a ID de concessão fornecida corresponder à ID de concessão ativa do blob de origem.
Retornos
Copie as propriedades da operação, como status, origem e ID.
Tipo de retorno
list_blob_names
Retorna um gerador para listar os nomes de blob no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e será interrompido quando todos os blobs forem retornados ou num_results for atingido.
Se num_results for especificado e a conta tiver mais do que esse número de blobs, o gerador terá um campo de next_marker populado quando terminar. Esse marcador pode ser usado para criar um novo gerador se mais resultados forem desejados.
list_blob_names(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)Parâmetros
- prefix
- str
Filtra os resultados para retornar apenas os blobs cujos nomes começam com o prefixo especificado.
- num_results
- int
Especifica o número máximo de blobs a ser retornado, inclusive todos os elementos <xref:azure.storage.blob.pageblobservice.BlobPrefix>. Se a solicitação não especificar num_results ou especificar um valor maior que 5.000, o servidor retornará até 5.000 itens. Definir num_results como um valor menor ou igual a zero resulta no código de resposta de erro 400 (solicitação incorreta).
- include
- Include
Especifica um ou mais conjuntos de dados adicionais a serem incluídos na resposta.
- delimiter
- str
Quando a solicitação inclui esse parâmetro, a operação retorna um BlobPrefix elemento na lista de resultados que atua como um espaço reservado para todos os blobs cujos nomes começam com a mesma subcadeia de caracteres até a aparência do caractere delimitador. O delimitador pode ser um único caractere ou uma cadeia de caracteres.
- marker
- str
Um token de continuação opaco. Esse valor poderá ser recuperado do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver terminado de enumerar os resultados. Se especificado, esse gerador começará a retornar os resultados do ponto em que o gerador anterior parou.
list_blobs
Retorna um gerador para listar os blobs no contêiner especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e será interrompido quando todos os blobs forem retornados ou num_results for atingido.
Se num_results for especificado e a conta tiver mais do que esse número de blobs, o gerador terá um campo de next_marker populado quando terminar. Esse marcador pode ser usado para criar um novo gerador se mais resultados forem desejados.
list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)Parâmetros
- prefix
- str
Filtra os resultados para retornar apenas os blobs cujos nomes começam com o prefixo especificado.
- num_results
- int
Especifica o número máximo de blobs a ser retornado, inclusive todos os elementos <xref:azure.storage.blob.pageblobservice.BlobPrefix>. Se a solicitação não especificar num_results ou especificar um valor maior que 5.000, o servidor retornará até 5.000 itens. Definir num_results como um valor menor ou igual a zero resulta em código de resposta de erro 400 (Solicitação Incorreta).
- include
- Include
Especifica um ou mais conjuntos de dados adicionais a serem incluídos na resposta.
- delimiter
- str
Quando a solicitação inclui esse parâmetro, a operação retorna um BlobPrefix elemento na lista de resultados que atua como um espaço reservado para todos os blobs cujos nomes começam com a mesma subcadeia de caracteres até a aparência do caractere delimitador. O delimitador pode ser um único caractere ou uma cadeia de caracteres.
- marker
- str
Um token de continuação opaco. Esse valor poderá ser recuperado do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver terminado de enumerar os resultados. Se especificado, esse gerador começará a retornar os resultados do ponto em que o gerador anterior parou.
list_containers
Retorna um gerador para listar os contêineres na conta especificada. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os contêineres forem retornados ou num_results for atingido.
Se num_results for especificado e a conta tiver mais do que esse número de contêineres, o gerador terá um campo de next_marker populado assim que for concluído. Esse marcador pode ser usado para criar um novo gerador se mais resultados forem desejados.
list_containers(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)Parâmetros
- prefix
- str
Filtra os resultados para retornar somente contêineres cujos nomes começam com o prefixo especificado.
- num_results
- int
Especifica o número máximo de contêineres a serem retornados. Uma única solicitação de lista pode retornar até 1.000 contianers e, potencialmente, um token de continuação que deve ser seguido para obter resuções adicionais.
- include_metadata
- bool
Especifica que os metadados de contêiner sejam retornados na resposta.
- marker
- str
Um token de continuação opaco. Esse valor poderá ser recuperado do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver terminado de enumerar os resultados. Se especificado, esse gerador começará a retornar os resultados do ponto em que o gerador anterior parou.
make_blob_url
Cria a URL para acessar um blob.
make_blob_url(container_name, blob_name, protocol=None, sas_token=None, snapshot=None)Parâmetros
- protocol
- str
Protocolo a ser usado: 'http' ou 'https'. Se não for especificado, usará o protocolo especificado quando BaseBlobService foi inicializado.
- sas_token
- str
Token de assinatura de acesso compartilhado criado com generate_shared_access_signature.
- snapshot
- str
Um valor de cadeia de caracteres que identifica exclusivamente o instantâneo. O valor desse parâmetro de consulta indica a versão instantâneo.
Retornos
URL de acesso a blob.
Tipo de retorno
make_container_url
Cria a URL para acessar um contêiner.
make_container_url(container_name, protocol=None, sas_token=None)Parâmetros
- protocol
- str
Protocolo a ser usado: 'http' ou 'https'. Se não for especificado, usará o protocolo especificado quando BaseBlobService foi inicializado.
- sas_token
- str
Token de assinatura de acesso compartilhado criado com generate_shared_access_signature.
Retornos
URL de acesso de contêiner.
Tipo de retorno
release_blob_lease
Libera a concessão. A concessão poderá ser liberada se a ID especificada na solicitação corresponder à associada ao blob. A liberação da concessão permite que outro cliente adquira imediatamente a concessão do blob assim que a liberação é concluída.
release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
release_container_lease
Libera a concessão. A concessão poderá ser liberada se o lease_id especificado corresponder ao associado ao contêiner. A liberação da concessão permite que outro cliente adquira imediatamente a concessão do contêiner assim que a liberação é concluída.
release_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)Parâmetros
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
renew_blob_lease
Renova a concessão. A concessão poderá ser renovada se a ID especificada na solicitação corresponder à associada ao blob. Observe que a concessão poderá ser renovada mesmo se tiver expirado, desde que o blob não tenha sido alterado nem concedido novamente desde a expiração da concessão. Quando você renova uma concessão, o relógio de duração é redefinido.
renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Retornos
str
renew_container_lease
Renova a concessão. A concessão poderá ser renovada se a ID de concessão especificada corresponder à associada ao contêiner. Observe que a concessão poderá ser renovada mesmo se tiver expirado, desde que o contêiner não tenha sido concedido novamente desde a expiração da concessão. Quando você renova uma concessão, o relógio de duração é redefinido.
renew_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)Parâmetros
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
Retornos
str
resize_blob
Redimensiona um blob da página ao tamanho especificado. Se o valor especificado for menor do que o tamanho atual do blob, todas as páginas acima do valor especificado serão limpas.
resize_blob(container_name, blob_name, content_length, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Retornos
Propriedades ETag e última modificação para o Blob de Página atualizado
Tipo de retorno
set_blob_metadata
Define metadados definidos pelo usuário para o blob especificado como um ou mais pares de nome-valor.
set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parâmetros
Ditado que contém pares de nome e valor. Cada chamada para essa operação substitui todos os metadados existentes anexados ao blob. Para remover todos os metadados do blob, chame essa operação sem cabeçalhos de metadados.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
Propriedades ETag e última modificação para o Blob atualizado
Tipo de retorno
set_blob_properties
Define as propriedades do sistema no blob. Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas.
set_blob_properties(container_name, blob_name, content_settings=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parâmetros
- content_settings
- ContentSettings
Objeto ContentSettings usado para definir propriedades de blob.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
Propriedades ETag e última modificação para o Blob atualizado
Tipo de retorno
set_blob_service_properties
Define as propriedades do serviço Blob de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure. Se um elemento (ex Logging) for deixado como Nenhum, as configurações existentes no serviço para essa funcionalidade serão preservadas.
set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None)Parâmetros
- hour_metrics
- Metrics
As configurações de métricas de hora fornecem um resumo das estatísticas de solicitação agrupadas pela API em agregações por hora para blobs.
- minute_metrics
- Metrics
As configurações de métricas de minuto fornecem estatísticas de solicitação para cada minuto para blobs.
- cors
- list(CorsRule)
Você pode incluir até cinco elementos CorsRule na lista. Se uma lista vazia for especificada, todas as regras CORS serão excluídas e o CORS será desabilitado para o serviço.
- target_version
- str
Indica a versão padrão a ser usada para solicitações se a versão de uma solicitação de entrada não for especificada.
- delete_retention_policy
- DeleteRetentionPolicy
A política de retenção de exclusão especifica se os blobs excluídos devem ser retidos. Ele também especifica o número de dias e versões do blob a serem mantidos.
- static_website
- StaticWebsite
Especifica se o recurso de site estático está habilitado e, se sim, indica o documento de índice e o documento de erro 404 a ser usado.
set_container_acl
Define as permissões para o contêiner especificado ou políticas de acesso armazenadas que podem ser usadas com assinaturas de acesso compartilhado. As permissões indicam se os blobs de um contêiner podem ser acessados publicamente.
set_container_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)Parâmetros
- signed_identifiers
- dict(str, AccessPolicy)
Um dicionário de políticas de acesso a serem associadas ao contêiner. O dicionário pode conter até 5 elementos. Um dicionário vazio limpará as políticas de acesso definidas no serviço.
- lease_id
- str
Se especificado, set_container_acl só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.
- if_modified_since
- datetime
Um valor datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a data/hora especificada.
- if_unmodified_since
- datetime
Um valor datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
Retornos
ETag e propriedades modificadas pela última vez para o contêiner atualizado
Tipo de retorno
set_container_metadata
Define um ou mais pares nome-valor definidos pelo usuário para o contêiner especificado. Cada chamada para essa operação substitui todos os metadados existentes anexados ao contêiner. Para remover todos os metadados do contêiner, chame essa operação sem um ditado de metadados.
set_container_metadata(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)Parâmetros
Um ditado que contém pares nome-valor a serem associados ao contêiner como metadados. Exemplo: {'category':'test'}
- lease_id
- str
Se especificado, set_container_metadata só terá êxito se a concessão do contêiner estiver ativa e corresponder a essa ID.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
Retornos
ETag e propriedades modificadas pela última vez para o contêiner atualizado
Tipo de retorno
set_premium_page_blob_tier
Define as camadas de blob de página no blob. Essa API só tem suporte para blobs de páginas em contas premium.
set_premium_page_blob_tier(container_name, blob_name, premium_page_blob_tier, timeout=None)Parâmetros
- premium_page_blob_tier
- PremiumPageBlobTier
Um valor de camada de blob de página para definir o blob. A camada se correlaciona ao tamanho do blob e ao número de IOPS permitidos. Isso só é aplicável a blobs de páginas em contas de armazenamento premium.
- timeout
- int
O parâmetro timeout é expresso em segundos. Esse método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente.
set_proxy
Define o host e a porta do servidor proxy para o Túnel HTTP CONNECT.
set_proxy(host, port, user=None, password=None)Parâmetros
set_sequence_number
Define o número da sequência de blob.
set_sequence_number(container_name, blob_name, sequence_number_action, sequence_number=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parâmetros
- sequence_number_action
- str
Essa propriedade indica como o serviço deve modificar o número de sequência do blob. Consulte SequenceNumberAction para obter mais informações.
- sequence_number
- str
Essa propriedade define o número de sequência do blob. O número de sequência é uma propriedade controlada pelo usuário que você pode usar para monitorar solicitações e gerenciar problemas de simultaneidade.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Retornos
Propriedades ETag e última modificação para o Blob de Página atualizado
Tipo de retorno
snapshot_blob
Cria um instantâneo somente leitura de um blob.
snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, cpk=None)Parâmetros
Especifica um par de nome-valor definido pelo usuário associado ao blob. Se nenhum par de nome-valor for especificado, a operação copiará os metadados do blob de base no instantâneo. Se um ou mais pares de nome-valor forem especificados, o instantâneo será criado com os metadados especificados, e os metadados não serão copiados do blob de base.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
instantâneo propriedades
Tipo de retorno
undelete_blob
A operação Desdelete Blob restaura o conteúdo e os metadados do blob ou do instantâneo excluídos. A tentativa de desmarcar um blob ou instantâneo que não seja excluído de forma reversível terá êxito sem nenhuma alteração.
undelete_blob(container_name, blob_name, timeout=None)Parâmetros
update_page
Atualizações um intervalo de páginas.
update_page(container_name, blob_name, page, start_range, end_range, validate_content=False, lease_id=None, if_sequence_number_lte=None, if_sequence_number_lt=None, if_sequence_number_eq=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, cpk=None, timeout=None)Parâmetros
- start_range
- int
Início do intervalo de bytes a ser usado para gravar em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos: 0 a 511, 512 a 1023 etc.
- end_range
- int
Fim do intervalo de bytes a ser usado para gravação em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos: 0 a 511, 512 a 1023 etc.
- validate_content
- bool
Se for true, calculará um hash MD5 do conteúdo da página. O serviço de armazenamento verifica o hash do conteúdo que chegou com o hash que foi enviado. Isso é importante principalmente para detectar bitflips no fio se o uso de http em vez de https como https (o padrão) já validará. Observe que esse hash MD5 não é armazenado com o blob.
- if_sequence_number_lte
- int
Se o número de sequência do blob for menor ou igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_sequence_number_lt
- int
Se o número de sequência do blob for menor que o valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_sequence_number_eq
- int
Se o número de sequência do blob for igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique um valor ETag para esse cabeçalho condicional para gravar a página somente se o valor ETag do blob corresponder ao valor especificado. Se os valores não corresponderem, o serviço Blob falhará.
- if_none_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique um valor ETag para esse cabeçalho condicional para gravar a página somente se o valor ETag do blob não corresponder ao valor especificado. Se os valores forem idênticos, o serviço Blob falhará.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Retornos
Propriedades ETag e última modificação para o Blob de Página atualizado
Tipo de retorno
update_page_from_url
Atualizações um intervalo de páginas para um blob de páginas em que o conteúdo é lido de uma URL.
update_page_from_url(container_name, blob_name, start_range, end_range, copy_source_url, source_range_start, source_content_md5=None, source_if_modified_since=None, source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, lease_id=None, if_sequence_number_lte=None, if_sequence_number_lt=None, if_sequence_number_eq=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, cpk=None, timeout=None)Parâmetros
- start_range
- int
Início do intervalo de bytes a ser usado para gravar em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos: 0 a 511, 512 a 1023 etc.
- end_range
- int
Fim do intervalo de bytes a ser usado para gravação em uma seção do blob. As páginas devem estar alinhadas com limites de 512 bytes, o deslocamento inicial deve ser um módulo de 512 e o deslocamento final deve ser um módulo de 512-1. Exemplos de intervalos de bytes válidos: 0 a 511, 512 a 1023 etc.
- copy_source_url
- str
A URL dos dados de origem. Ele pode apontar para qualquer Blob ou Arquivo do Azure, que seja público ou tenha uma assinatura de acesso compartilhado anexada.
- source_range_start
- int
Isso indica o início do intervalo de bytes(inclusive) que deve ser obtido da origem da cópia. O serviço lerá o mesmo número de bytes que o intervalo de destino (end_range-start_range).
- source_content_md5
- str
Se for fornecido, o serviço calculará o hash MD5 do conteúdo do bloco e será comparado com esse valor.
- source_if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso de origem tiver sido modificado desde o horário especificado.
- source_if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso de origem não tiver sido modificado desde a data/hora especificada.
- source_if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso de origem corresponder ao valor especificado.
- source_if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso de origem não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso de origem não existir e falhar na operação se ela existir.
- if_sequence_number_lte
- int
Se o número de sequência do blob for menor ou igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_sequence_number_lt
- int
Se o número de sequência do blob for menor que o valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_sequence_number_eq
- int
Se o número de sequência do blob for igual ao valor especificado, a solicitação continuará; caso contrário, ele falhará.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a hora especificada.
- if_unmodified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- if_match
- str
Um valor de ETag ou o caractere curinga (*). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado.
- if_none_match
- str
Um valor ETag ou o caractere curinga (). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. Especifique o caractere curinga () para executar a operação somente se o recurso não existir e falhe na operação se ela existir.
Criptografa os dados no lado do serviço com a chave fornecida. O uso de chaves fornecidas pelo cliente deve ser feito por HTTPS. Como a própria chave de criptografia é fornecida na solicitação, uma conexão segura deve ser estabelecida para transferir a chave.
Atributos
protocol
request_session
socket_timeout
MAX_CHUNK_GET_SIZE
MAX_CHUNK_GET_SIZE = 4194304MAX_PAGE_SIZE
MAX_PAGE_SIZE = 4194304MAX_SINGLE_GET_SIZE
MAX_SINGLE_GET_SIZE = 33554432
Azure SDK for Python