FileService Classe

Referência

O protocolo SMB é o protocolo de compartilhamento de arquivos preferido usado atualmente no local. O serviço Arquivo do Microsoft Azure permite que os clientes aproveitem a disponibilidade e a escalabilidade do SMB de IaaS (infraestrutura como serviço) de nuvem do Azure sem precisar reescrever aplicativos cliente SMB.

O serviço de arquivo do Azure também oferece uma alternativa atraente às soluções DAS e SAN tradicionais, que geralmente são complexas e caras para instalar, configurar e operar.

Herança: StorageClient

FileService

Construtor

FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)

Parâmetros

Nome	Description
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. Ela é necessária, a menos que um cadeia de conexão seja dado. valor padrão: None
account_key	str A chave da conta de armazenamento. Isso é usado para autenticação de chave compartilhada. valor padrão: None
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 da conta e o token sas forem especificados, a chave da conta será usada para assinar. valor padrão: None
protocol	str O protocolo a ser usado para solicitações. O padrão é https. valor padrão: https
endpoint_suffix	str O componente base do host da URL, menos o nome da conta. O padrão é o Azure (core.windows.net). Substitua isso para usar a nuvem da China (core.chinacloudapi.cn). valor padrão: core.windows.net
request_session	<xref:requests.Session> O objeto de sessão a ser usado para solicitações HTTP. valor padrão: None
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 cadeia de conexão. valor padrão: None
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. valor padrão: None

Variáveis

Nome	Description
MAX_SINGLE_GET_SIZE	int O tamanho do primeiro intervalo será executado por métodos get_file_to_* se max_connections for maior que 1. Menos dados serão retornados se o arquivo for menor do que isso.
MAX_CHUNK_GET_SIZE	int O tamanho do intervalo subsequente será executado por métodos get_file_to_* se max_connections for maior que 1 e o arquivo for maior que MAX_SINGLE_GET_SIZE. Menos dados serão retornados se o restante do arquivo for menor do que isso. Se isso for definido como maior que 4 MB, content_validation gerará um erro se habilitado. No entanto, se content_validation não for desejado, um tamanho maior que 4 MB poderá ser ideal. Não é recomendável definir isso abaixo de 4 MB.
MAX_RANGE_SIZE	int O tamanho dos intervalos colocados pelos métodos create_file_from_*. Intervalos menores poderão ser colocados se houver menos dados fornecidos. O tamanho máximo de intervalo compatível com o serviço é de 4 MB.

Métodos

abort_copy_file	Anula uma operação de copy_file pendente e deixa um arquivo de destino com comprimento zero e metadados completos.
clear_range	Limpa o intervalo especificado e libera o espaço usado no armazenamento para esse intervalo.
close_handles	Retorna um gerador para fechar identificadores abertos em um diretório ou um arquivo sob o compartilhamento especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todas as alças tiverem sido fechadas. Os valores gerados representam o número de identificadores que foram fechados em cada transação.
copy_file	Copia um arquivo de forma assíncrona. Esta operação retorna um objeto de propriedades de 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 Arquivo copia arquivos com base no melhor esforço. Se o arquivo de destino existir, ele será substituído. O arquivo de destino não pode ser modificado enquanto a operação de cópia estiver em andamento.
create_directory	Cria um novo diretório no diretório pai ou compartilhamento especificado. Se o diretório com o mesmo nome já existir, a operação falhará no serviço. Por padrão, a exceção é engolida pelo cliente. Para expor a exceção, especifique True para fail_on_exists.
create_file	Cria um arquivo novo. Confira create_file_from_* para funções de alto nível que lidam com a criação e o upload de arquivos grandes com notificações automáticas de agrupamento e progresso.
create_file_from_bytes	Cria um novo arquivo de uma matriz de bytes ou atualiza o conteúdo de um arquivo existente, com notificações automáticas de agrupamento e progresso.
create_file_from_path	Cria um novo arquivo do Azure de um caminho de arquivo local ou atualiza o conteúdo de um arquivo existente, com notificações automáticas de agrupamento e progresso.
create_file_from_stream	Cria um novo arquivo de um arquivo/fluxo ou atualiza o conteúdo de um arquivo existente, com notificações automáticas de agrupamento e progresso.
create_file_from_text	Cria um novo arquivo de str/unicode ou atualiza o conteúdo de um arquivo existente, com notificações automáticas de agrupamento e progresso.
create_permission_for_share	Crie uma permissão (um descritor de segurança) no nível do compartilhamento. Essa 'permissão' pode ser usada para os arquivos/diretórios no compartilhamento. Se já existir uma 'permissão', ela retornará a chave dela, caso contrário, criará uma nova permissão no nível do compartilhamento e retornará sua chave. :retorna uma chave de permissão de arquivo :rtype str
create_share	Cria um novo compartilhamento na conta especificada. Se o compartilhamento com o mesmo nome já existir, a operação falhará no serviço. Por padrão, a exceção é engolida pelo cliente. Para expor a exceção, especifique True para fail_on_exists.
delete_directory	Exclui o diretório vazio especificado. Observe que o diretório deve estar vazio antes que possa ser excluído. A tentativa de excluir diretórios que não estão vazios falhará. Se o diretório não existir, a operação falhará no serviço. Por padrão, a exceção é engolida pelo cliente. Para expor a exceção, especifique True para fail_not_exist.
delete_file	Marca o arquivo especificado para exclusão. O arquivo é posteriormente excluído durante a coleta de lixo.
delete_share	Marca o compartilhamento especificado para exclusão. Se o compartilhamento não existir, a operação falhará no serviço. Por padrão, a exceção é engolida pelo cliente. Para expor a exceção, especifique True para fail_not_exist.
exists	Retorna um booliano que indica se o compartilhamento existe se apenas o nome do compartilhamento for fornecido. Se directory_name for específico, um booliano será retornado indicando se o diretório existe. Se file_name também for especificado, um booliano será retornado indicando se o arquivo existe.
extract_date_and_request_id
generate_account_shared_access_signature	Gera uma assinatura de acesso compartilhado para o serviço de arquivo. Use a assinatura retornada com o parâmetro sas_token do FileService.
generate_file_shared_access_signature	Gera uma assinatura de acesso compartilhado para o arquivo. Use a assinatura retornada com o parâmetro sas_token de FileService.
generate_share_shared_access_signature	Gera uma assinatura de acesso compartilhado para o compartilhamento. Use a assinatura retornada com o parâmetro sas_token de FileService.
get_directory_metadata	Retorna todos os metadados definidos pelo usuário para o diretório especificado.
get_directory_properties	Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o diretório especificado. Os dados retornados não incluem a lista de arquivos do diretório.
get_file_metadata	Retorna todos os metadados definidos pelo usuário para o arquivo especificado.
get_file_properties	Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Retorna uma instância de File com FileProperties e um dict de metadados.
get_file_service_properties	Obtém as propriedades do serviço Arquivo de uma conta de armazenamento, incluindo o Azure Análise de Armazenamento.
get_file_to_bytes	Baixa um arquivo como uma matriz de bytes, com notificações automáticas de agrupamento e progresso. Retorna uma instância de File com propriedades, metadados e conteúdo.
get_file_to_path	Baixa um arquivo em um caminho de arquivo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de Arquivo com propriedades e metadados.
get_file_to_stream	Baixa um arquivo em um fluxo, com notificações automáticas de agrupamento e progresso. Retorna uma instância de File com propriedades e metadados.
get_file_to_text	Baixa um arquivo como texto unicode, com notificações automáticas de agrupamento e progresso. Retorna uma instância de File com propriedades, metadados e conteúdo.
get_permission_for_share	Crie uma permissão (um descritor de segurança) no nível do compartilhamento. Essa 'permissão' pode ser usada para os arquivos/diretórios no compartilhamento. Se já existir uma 'permissão', ela retornará a chave dela, caso contrário, criará uma nova permissão no nível do compartilhamento e retornará sua chave. :retorna uma permissão de arquivo (um SDDL portátil) :rtype str
get_share_acl	Obtém as permissões para o compartilhamento especificado.
get_share_metadata	Retorna todos os metadados definidos pelo usuário para o compartilhamento especificado.
get_share_properties	Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o compartilhamento especificado. Os dados retornados não incluem a lista de arquivos ou diretórios dos compartilhamentos.
get_share_stats	Obtém o tamanho aproximado dos dados armazenados no compartilhamento, arredondados para o gigabyte mais próximo. Observe que esse valor pode não incluir todos os arquivos recém-criados ou redimensionados recentemente.
get_share_stats_in_bytes	Obtém o tamanho aproximado dos dados armazenados no compartilhamento em bytes. Observe que esse valor pode não incluir todos os arquivos recém-criados ou redimensionados recentemente.
list_directories_and_files	Retorna um gerador para listar os diretórios e arquivos no compartilhamento especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os diretórios e arquivos forem retornados ou num_results for atingido. Se num_results for especificado e o compartilhamento tiver mais do que esse número de arquivos e diretórios, 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_handles	Retorna um gerador para listar identificadores abertos em um diretório ou um arquivo no compartilhamento especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e será interrompido quando todos os identificadores forem retornados ou num_results for atingido. Se num_results for especificado e o compartilhamento tiver mais do que esse número de arquivos e diretórios, 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_ranges	Recupera os intervalos válidos para um arquivo.
list_shares	Retorna um gerador para listar os compartilhamentos na conta especificada. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os compartilhamentos forem retornados ou num_results for atingido. Se num_results for especificado e a conta tiver mais do que esse número de compartilhamentos, 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.
make_file_url	Cria a URL para acessar um arquivo.
resize_file	Redimensiona um arquivo com o tamanho especificado. Se o valor de byte especificado é menor do que o tamanho atual do arquivo, então todos os intervalos acima do valor de byte especificado são limpos.
set_directory_metadata	Define um ou mais pares nome-valor definidos pelo usuário para o diretório especificado. Cada chamada para essa operação substitui todos os metadados existentes anexados ao diretório. Para remover todos os metadados do diretório, chame essa operação sem um ditado de metadados.
set_directory_properties
set_file_metadata	Define metadados definidos pelo usuário para o arquivo especificado como um ou mais pares nome-valor.
set_file_properties	Define as propriedades do sistema no arquivo. Se uma propriedade for definida para o content_settings, todas as propriedades serão substituídas.
set_file_service_properties	Define as propriedades do serviço Arquivo de uma conta de armazenamento, incluindo Análise de Armazenamento do Azure. Se um elemento (ex HourMetrics) for deixado como Nenhum, as configurações existentes no serviço para essa funcionalidade serão preservadas.
set_proxy	Define o host e a porta do servidor proxy para o Túnel HTTP CONNECT.
set_share_acl	Define as permissões para as políticas de acesso armazenadas ou de compartilhamento especificadas que podem ser usadas com assinaturas de acesso compartilhado.
set_share_metadata	Define um ou mais pares nome-valor definidos pelo usuário para o compartilhamento especificado. Cada chamada para essa operação substitui todos os metadados existentes anexados ao compartilhamento. Para remover todos os metadados do compartilhamento, chame essa operação sem um ditado de metadados.
set_share_properties	Define as propriedades definidas pelo serviço para o compartilhamento especificado.
snapshot_share	Cria um instantâneo de um compartilhamento existente na conta especificada.
update_range	Grava os bytes especificados pelo corpo da solicitação no intervalo especificado.
update_range_from_file_url	Grava os bytes de um ponto de extremidade de Arquivo do Azure no intervalo especificado de outro ponto de extremidade de Arquivo do Azure.

abort_copy_file

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

abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento de destino.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo de destino.
copy_id Obrigatório	str Identificador de cópia fornecido no copy.id da operação de copy_file original.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

clear_range

Limpa o intervalo especificado e libera o espaço usado no armazenamento para esse intervalo.

clear_range(share_name, directory_name, file_name, start_range, end_range, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
start_range Obrigatório	int Início do intervalo de bytes a ser usado para limpar uma seção do arquivo. O intervalo pode ter até 4 MB de tamanho. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo.
end_range Obrigatório	int Fim do intervalo de bytes a ser usado para limpar uma seção do arquivo. O intervalo pode ter até 4 MB de tamanho. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

close_handles

Retorna um gerador para fechar identificadores abertos em um diretório ou um arquivo sob o compartilhamento especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todas as alças tiverem sido fechadas. Os valores gerados representam o número de identificadores que foram fechados em cada transação.

close_handles(share_name, directory_name=None, file_name=None, recursive=None, handle_id=None, marker=None, snapshot=None, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name	str O caminho para o diretório. valor padrão: None
file_name	str Nome do arquivo existente. valor padrão: None
recursive	bool Boolean que especifica se a operação deve ser aplicada ao diretório especificado no URI, seus arquivos, seus subdiretórios e seus arquivos. valor padrão: None
handle_id	str Obrigatórios. Especifica a ID do identificador aberta no arquivo ou diretório a ser fechado. Astrix ('*') é um curinga que especifica todos os identificadores. valor padrão: None
marker	str Um token de continuação opaco. Esse valor poderá ser recuperado do campo next_marker de um objeto gerador anterior se ele não tiver terminado as alças de fechamento. Se especificado, esse gerador começará a fechar identificadores do ponto em que o gerador anterior parou. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

copy_file

Copia um arquivo de forma assíncrona. Esta operação retorna um objeto de propriedades de 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 Arquivo copia arquivos com base no melhor esforço.

Se o arquivo de destino existir, ele será substituído. O arquivo de destino não pode ser modificado enquanto a operação de cópia estiver em andamento.

copy_file(share_name, directory_name, file_name, copy_source, metadata=None, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento de destino. O compartilhamento deve existir.
directory_name Obrigatório	str Nome do diretório de destino. O diretório precisa existir.
file_name Obrigatório	str Nome do arquivo de destino. Se o arquivo de destino existir, ele será substituído. Caso contrário, ele será criado.
copy_source Obrigatório	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.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
metadata	dict(str, str)<xref:./> Pares de nome-valor associados ao arquivo como metadados. Se nenhum par nome-valor for especificado, a operação copiará os metadados do blob ou arquivo de origem para o arquivo de destino. Se um ou mais pares nome-valor forem especificados, o arquivo de destino será criado com os metadados especificados e os metadados não serão copiados do blob ou arquivo de origem. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
CopyProperties	Copie as propriedades da operação, como status, origem e ID.

create_directory

Cria um novo diretório no diretório pai ou compartilhamento especificado. Se o diretório com o mesmo nome já existir, a operação falhará no serviço. Por padrão, a exceção é engolida pelo cliente. Para expor a exceção, especifique True para fail_on_exists.

create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str Nome do diretório a ser criado, incluindo o caminho para o diretório pai.
metadata	dict(str, str)<xref::> Um ditado com pares de name_value a serem associados ao compartilhamento como metadados. Exemplo:{'Category':'test'} valor padrão: None
fail_on_exist	bool especifique se deve gerar uma exceção quando o diretório existir. Falso por padrão. valor padrão: False
file_permission	str Permissão de arquivo, um SDDL portátil valor padrão: None
smb_properties	SMBProperties Define as propriedades de arquivo relacionadas ao SMB
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
bool	True se o diretório for criado, False se o diretório já existir.

create_file

Cria um arquivo novo.

Confira create_file_from_* para funções de alto nível que lidam com a criação e o upload de arquivos grandes com notificações automáticas de agrupamento e progresso.

create_file(share_name, directory_name, file_name, content_length, content_settings=None, metadata=None, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo a ser criado ou atualizado.
content_length Obrigatório	int Comprimento do arquivo em bytes.
content_settings	ContentSettings Objeto ContentSettings usado para definir propriedades de arquivo. valor padrão: None
metadata	dict(str, str) Pares de nome-valor associados ao arquivo como metadados. valor padrão: None
file_permission	str Permissão de arquivo, um SDDL portátil valor padrão: None
smb_properties	SMBProperties Define as propriedades de arquivo relacionadas ao SMB
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

create_file_from_bytes

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

create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo a ser criado ou atualizado.
file Obrigatório	str Conteúdo do arquivo como uma matriz de bytes.
index	int Inicie o índice na matriz de bytes. valor padrão: 0
count	int Número de bytes a serem carregados. Defina como Nenhum ou valor negativo para carregar todos os bytes a partir do índice. valor padrão: None
content_settings	ContentSettings Objeto ContentSettings usado para definir propriedades de arquivo. valor padrão: None
metadata	dict(str, str) Pares de nome-valor associados ao arquivo como metadados. valor padrão: None
validate_content	bool Se for true, calculará um hash MD5 para cada intervalo do arquivo. 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 arquivo . valor padrão: False
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 arquivo ou Nenhum se o tamanho total for desconhecido. valor padrão: None
max_connections	int Número máximo de conexões paralelas a serem usadas. valor padrão: 2
file_permission	str Permissão de arquivo, um SDDL portátil valor padrão: None
smb_properties	SMBProperties Define as propriedades de arquivo relacionadas ao SMB
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. valor padrão: None

create_file_from_path

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

create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo a ser criado ou atualizado.
local_file_path Obrigatório	str Caminho do arquivo local a ser carregado como o conteúdo do arquivo.
content_settings	ContentSettings Objeto ContentSettings usado para definir propriedades de arquivo. valor padrão: None
metadata	dict(str, str) Pares de nome-valor associados ao arquivo como metadados. valor padrão: None
validate_content	bool Se for true, calculará um hash MD5 para cada intervalo do arquivo. 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 arquivo . valor padrão: False
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 arquivo ou Nenhum se o tamanho total for desconhecido. valor padrão: None
max_connections	int Número máximo de conexões paralelas a serem usadas. valor padrão: 2
file_permission	str Permissão de arquivo, um SDDL portátil valor padrão: None
smb_properties	SMBProperties Define as propriedades de arquivo relacionadas ao SMB
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. valor padrão: None

create_file_from_stream

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

create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo a ser criado ou atualizado.
stream Obrigatório	IOBase Arquivo/fluxo aberto para carregar como o conteúdo do arquivo.
count Obrigatório	int Número de bytes a serem lidos do fluxo. Isso é necessário, um arquivo não poderá ser criado se a contagem for desconhecida.
content_settings	ContentSettings Objeto ContentSettings usado para definir propriedades de arquivo. valor padrão: None
metadata	dict(str, str) Pares de nome-valor associados ao arquivo como metadados. valor padrão: None
validate_content	bool Se for true, calculará um hash MD5 para cada intervalo do arquivo. 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 arquivo . valor padrão: False
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 arquivo ou Nenhum se o tamanho total for desconhecido. valor padrão: None
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. valor padrão: 2
file_permission	str Permissão de arquivo, um SDDL portátil valor padrão: None
smb_properties	SMBProperties Define as propriedades de arquivo relacionadas ao SMB
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. valor padrão: None

create_file_from_text

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

create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo a ser criado ou atualizado.
text Obrigatório	str Texto a ser carregado no arquivo.
encoding	str Codificação do Python a ser usada para converter o texto em bytes. valor padrão: utf-8
content_settings	ContentSettings Objeto ContentSettings usado para definir propriedades de arquivo. valor padrão: None
metadata	dict(str, str) Pares de nome-valor associados ao arquivo como metadados. valor padrão: None
validate_content	bool Se for true, calculará um hash MD5 para cada intervalo do arquivo. 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 arquivo . valor padrão: False
file_permission	str Permissão de arquivo, um SDDL portátil valor padrão: None
smb_properties	SMBProperties Define as propriedades de arquivo relacionadas ao SMB
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. valor padrão: None

Crie uma permissão (um descritor de segurança) no nível do compartilhamento. Essa 'permissão' pode ser usada para os arquivos/diretórios no compartilhamento. Se já existir uma 'permissão', ela retornará a chave dela, caso contrário, criará uma nova permissão no nível do compartilhamento e retornará sua chave.

:retorna uma chave de permissão de arquivo :rtype str

create_permission_for_share(share_name, file_permission, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	Nome do compartilhamento.
file_permission Obrigatório	Permissão de arquivo, um SDDL portátil
timeout	O parâmetro timeout é expresso em segundos. valor padrão: None

Cria um novo compartilhamento na conta especificada. Se o compartilhamento com o mesmo nome já existir, a operação falhará no serviço. Por padrão, a exceção é engolida pelo cliente. Para expor a exceção, especifique True para fail_on_exists.

create_share(share_name, metadata=None, quota=None, fail_on_exist=False, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento a ser criado.
metadata	dict(str, str) Um dict com name_value pares a serem associados ao compartilhamento como metadados. Exemplo:{'Category':'test'} valor padrão: None
quota	int Especifica o tamanho máximo do compartilhamento em gigabytes. Deve ser maior que 0 e menor ou igual a 5 TB (5120). valor padrão: None
fail_on_exist	bool Especifique se deve gerar uma exceção quando o compartilhamento existir. Falso por padrão. valor padrão: False
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
bool	True se o compartilhamento for criado, False se o compartilhamento já existir.

delete_directory

Exclui o diretório vazio especificado. Observe que o diretório deve estar vazio antes que possa ser excluído. A tentativa de excluir diretórios que não estão vazios falhará.

Se o diretório não existir, a operação falhará no serviço. Por padrão, a exceção é engolida pelo cliente. Para expor a exceção, especifique True para fail_not_exist.

delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str Nome do diretório a ser excluído, incluindo o caminho para o diretório pai.
fail_not_exist	bool Especifique se deve gerar uma exceção quando o diretório não existir. valor padrão: False
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
bool	True se o diretório for excluído, caso contrário, False.

delete_file

Marca o arquivo especificado para exclusão. O arquivo é posteriormente excluído durante a coleta de lixo.

delete_file(share_name, directory_name, file_name, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Marca o compartilhamento especificado para exclusão. Se o compartilhamento não existir, a operação falhará no serviço. Por padrão, a exceção é engolida pelo cliente. Para expor a exceção, especifique True para fail_not_exist.

delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, delete_snapshots=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento a ser excluído.
fail_not_exist	bool Especifique se deve gerar uma exceção quando o compartilhamento não existir. Falso por padrão. valor padrão: False
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. Especifique esse argumento para excluir apenas um instantâneo específico. delete_snapshots deve ser Nenhum se isso for especificado. valor padrão: None
delete_snapshots	DeleteSnapshot Para excluir um compartilhamento que tenha instantâneos, isso deve ser especificado como DeleteSnapshot.Include. valor padrão: None

Retornos

Tipo	Description
bool	True se o compartilhamento for excluído, o compartilhamento False não existirá.

exists

Retorna um booliano que indica se o compartilhamento existe se apenas o nome do compartilhamento for fornecido. Se directory_name for específico, um booliano será retornado indicando se o diretório existe. Se file_name também for especificado, um booliano será retornado indicando se o arquivo existe.

exists(share_name, directory_name=None, file_name=None, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome de um compartilhamento.
directory_name	str O caminho para um diretório. valor padrão: None
file_name	str Nome de um arquivo. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
bool	Um booliano que indica se o recurso existe.

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parâmetros

Nome	Description
retry_context Obrigatório

generate_account_shared_access_signature

Gera uma assinatura de acesso compartilhado para o serviço de arquivo. Use a assinatura retornada com o parâmetro sas_token do FileService.

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

Parâmetros

Nome	Description
resource_types Obrigatório	<xref:ResourceTypes> Especifica os tipos de recursos acessíveis com a SAS da conta.
permission Obrigatório	<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.
expiry Obrigatório	datetime ou str 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.
start	datetime ou str 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. valor padrão: None
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. valor padrão: None
protocol	str Especifica o protocolo permitido para uma solicitação feita. Os valores possíveis são HTTPS e HTTP (https,http) ou somente HTTPS (https). O valor padrão é https,http. Observe que somente HTTP não é um valor permitido. valor padrão: None

Retornos

Tipo	Description
str	Um token sas (Assinatura de Acesso Compartilhado).

generate_file_shared_access_signature

Gera uma assinatura de acesso compartilhado para o arquivo. Use a assinatura retornada com o parâmetro sas_token de FileService.

generate_file_shared_access_signature(share_name, directory_name=None, file_name=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)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento.
directory_name	str Nome do diretório. Tokens SAS não podem ser criados para diretórios, portanto, esse parâmetro só deve estar presente se file_name for fornecido. valor padrão: None
file_name	str Nome do arquivo. valor padrão: None
permission	FilePermissions 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, criação, 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. valor padrão: None
expiry	datetime ou str 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. valor padrão: None
start	datetime ou str 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. valor padrão: None
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_file_service_properties. valor padrão: None
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. valor padrão: None
protocol	str Especifica o protocolo permitido para uma solicitação feita. Os valores possíveis são HTTPS e HTTP (https,http) ou somente HTTPS (https). O valor padrão é https,http. Observe que somente HTTP não é um valor permitido. valor padrão: None
cache_control	str O valor do cabeçalho de resposta para Cache-Control quando o recurso é acessado usando essa assinatura de acesso compartilhado. valor padrão: None
content_disposition	str Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acessado usando essa assinatura de acesso compartilhado. valor padrão: None
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. valor padrão: None
content_language	str Valor do cabeçalho de resposta para Content-Language quando o recurso é acessado usando essa assinatura de acesso compartilhado. valor padrão: None
content_type	str Valor do cabeçalho de resposta para Content-Type quando o recurso é acessado usando essa assinatura de acesso compartilhado. valor padrão: None

Retornos

Tipo	Description
str	Um token sas (Assinatura de Acesso Compartilhado).

Gera uma assinatura de acesso compartilhado para o compartilhamento. Use a assinatura retornada com o parâmetro sas_token de FileService.

generate_share_shared_access_signature(share_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)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento.
permission	SharePermissions 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, criação, gravação, exclusão, lista. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. valor padrão: None
expiry	datetime ou str A hora em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. valor padrão: None
start	datetime ou str A hora em que a assinatura de acesso compartilhado se torna válida. Se for omitido, a hora de início para essa chamada será presumida como a hora na qual o serviço de armazenamento recebe a solicitação. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. valor padrão: None
id	str Um valor exclusivo de até 64 caracteres que se correlaciona a uma política de acesso armazenada. Para criar uma política de acesso armazenada, use set_share_acl. valor padrão: None
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 ao intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 na SAS restringe a solicitação a esses endereços IP. valor padrão: None
protocol	str Especifica o protocolo permitido para uma solicitação feita. Os valores possíveis são HTTPS e HTTP (https,http) ou SOMENTE HTTPS (https). O valor padrão é https,http. Observe que somente HTTP não é um valor permitido. valor padrão: None
cache_control	str Valor do cabeçalho de resposta para Cache-Control quando o recurso é acessado usando essa assinatura de acesso compartilhado. valor padrão: None
content_disposition	str Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acessado usando essa assinatura de acesso compartilhado. valor padrão: None
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. valor padrão: None
content_language	str Valor do cabeçalho de resposta para Content-Language quando o recurso é acessado usando essa assinatura de acesso compartilhado. valor padrão: None
content_type	str Valor do cabeçalho de resposta para Content-Type quando o recurso é acessado usando essa assinatura de acesso compartilhado. valor padrão: None

Retornos

Tipo	Description
str	Um token sas (Assinatura de Acesso Compartilhado).

get_directory_metadata

Retorna todos os metadados definidos pelo usuário para o diretório especificado.

get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
dict(str, str)	Um dicionário que representa o nome dos metadados do diretório, pares de valor.

get_directory_properties

Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o diretório especificado. Os dados retornados não incluem a lista de arquivos do diretório.

get_directory_properties(share_name, directory_name, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para um diretório existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
Directory	para o diretório especificado em um objeto de diretório.

get_file_metadata

Retorna todos os metadados definidos pelo usuário para o arquivo especificado.

get_file_metadata(share_name, directory_name, file_name, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
dict(str, str)	Um dicionário que representa o nome dos metadados do arquivo, pares de valor.

get_file_properties

Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Retorna uma instância de File com FileProperties e um dict de metadados.

get_file_properties(share_name, directory_name, file_name, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
File	um objeto de arquivo, incluindo propriedades e metadados.

get_file_service_properties

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

get_file_service_properties(timeout=None)

Parâmetros

Nome	Description
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
ServiceProperties	As propriedades do serviço de arquivo.

get_file_to_bytes

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

get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
start_range	int Início do intervalo de bytes a ser usado para baixar uma seção do arquivo. 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 arquivo. valor padrão: None
end_range	int Fim do intervalo de bytes a ser usado para baixar uma seção do arquivo. 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 arquivo. valor padrão: None
validate_content	bool Se definido como true, valida um hash MD5 para cada parte recuperada do arquivo. 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. valor padrão: False
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 arquivo, se conhecido. valor padrão: None
max_connections	int Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do arquivo. Se esse for o arquivo 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 valioso se o arquivo estiver sendo modificado simultaneamente para impor a atomicidade ou se muitos arquivos devem estar vazios, pois uma solicitação extra é necessária para arquivos vazios se max_connections for maior que 1. valor padrão: 2
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. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
File	Um Arquivo com propriedades, conteúdo e metadados.

get_file_to_path

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

get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
file_path Obrigatório	str Caminho do arquivo no qual gravar.
open_mode	str Modo a ser usado ao abrir o arquivo. Observe que especificar acrescentar somente open_mode impede o download paralelo. Portanto, max_connections deve ser definido como 1 se esse open_mode for usado. valor padrão: wb
start_range	int Início do intervalo de bytes a ser usado para baixar uma seção do arquivo. 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 arquivo. valor padrão: None
end_range	int Fim do intervalo de bytes a ser usado para baixar uma seção do arquivo. 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 arquivo. valor padrão: None
validate_content	bool Se definido como true, valida um hash MD5 para cada parte recuperada do arquivo. 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. valor padrão: False
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 arquivo, se conhecido. valor padrão: None
max_connections	int Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do arquivo. Se esse for o arquivo 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 valioso se o arquivo estiver sendo modificado simultaneamente para impor a atomicidade ou se muitos arquivos devem estar vazios, pois uma solicitação extra é necessária para arquivos vazios se max_connections for maior que 1. valor padrão: 2
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. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
File	Um Arquivo com propriedades e metadados.

get_file_to_stream

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

get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
stream Obrigatório	IOBase Arquivo/fluxo aberto para gravar.
start_range	int Início do intervalo de bytes a ser usado para baixar uma seção do arquivo. 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 arquivo. valor padrão: None
end_range	int Fim do intervalo de bytes a ser usado para baixar uma seção do arquivo. 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 arquivo. valor padrão: None
validate_content	bool Se definido como true, valida um hash MD5 para cada parte recuperada do arquivo. 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. valor padrão: False
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 arquivo, se conhecido. valor padrão: None
max_connections	int Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do arquivo. Se esse for o arquivo 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 valioso se o arquivo estiver sendo modificado simultaneamente para impor a atomicidade ou se muitos arquivos devem estar vazios, pois uma solicitação extra é necessária para arquivos vazios se max_connections for maior que 1. valor padrão: 2
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. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
File	Um Arquivo com propriedades e metadados.

get_file_to_text

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

get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
encoding	str Codificação do Python a ser usada ao decodificar os dados do arquivo. valor padrão: utf-8
start_range	int Início do intervalo de bytes a ser usado para baixar uma seção do arquivo. 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 arquivo. valor padrão: None
end_range	int Fim do intervalo de bytes a ser usado para baixar uma seção do arquivo. 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 arquivo. valor padrão: None
validate_content	bool Se definido como true, valida um hash MD5 para cada parte recuperada do arquivo. 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. valor padrão: False
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 arquivo, se conhecido. valor padrão: None
max_connections	int Se definido como 2 ou maior, um get inicial será feito para o primeiro eu. MAX_SINGLE_GET_SIZE bytes do arquivo. Se esse for o arquivo 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 valioso se o arquivo estiver sendo modificado simultaneamente para impor a atomicidade ou se muitos arquivos devem estar vazios, pois uma solicitação extra é necessária para arquivos vazios se max_connections for maior que 1. valor padrão: 2
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. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
File	Um Arquivo com propriedades, conteúdo e metadados.

:retorna uma permissão de arquivo (um SDDL portátil) :rtype str

get_permission_for_share(share_name, file_permission_key, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	Nome do compartilhamento.
file_permission_key Obrigatório	Chave da permissão de arquivo a ser recuperada
timeout	O parâmetro timeout é expresso em segundos. valor padrão: None

Obtém as permissões para o compartilhamento especificado.

get_share_acl(share_name, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
dict(str, AccessPolicy)	Um dicionário de políticas de acesso associadas ao compartilhamento.

Retorna todos os metadados definidos pelo usuário para o compartilhamento especificado.

get_share_metadata(share_name, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
dict(str, str)	Um dicionário que representa o nome dos metadados de compartilhamento, pares de valor.

Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o compartilhamento especificado. Os dados retornados não incluem a lista de arquivos ou diretórios dos compartilhamentos.

get_share_properties(share_name, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
Share	Um compartilhamento que expõe propriedades e metadados.

Obtém o tamanho aproximado dos dados armazenados no compartilhamento, arredondados para o gigabyte mais próximo.

Observe que esse valor pode não incluir todos os arquivos recém-criados ou redimensionados recentemente.

get_share_stats(share_name, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
int	o tamanho aproximado dos dados armazenados no compartilhamento.

Obtém o tamanho aproximado dos dados armazenados no compartilhamento em bytes.

Observe que esse valor pode não incluir todos os arquivos recém-criados ou redimensionados recentemente.

get_share_stats_in_bytes(share_name, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
int	o tamanho aproximado dos dados armazenados no compartilhamento.

list_directories_and_files

Retorna um gerador para listar os diretórios e arquivos no compartilhamento especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e interromperá quando todos os diretórios e arquivos forem retornados ou num_results for atingido.

Se num_results for especificado e o compartilhamento tiver mais do que esse número de arquivos e diretórios, 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_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name	str O caminho para o diretório. valor padrão: None
num_results	int Especifica o número máximo de arquivos a serem retornados, incluindo todos os elementos de diretório. 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). valor padrão: None
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. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
prefix	str Liste apenas os arquivos e/ou diretórios com o prefixo fornecido. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

list_handles

Retorna um gerador para listar identificadores abertos em um diretório ou um arquivo no compartilhamento especificado. O gerador seguirá lentamente os tokens de continuação retornados pelo serviço e será interrompido quando todos os identificadores forem retornados ou num_results for atingido.

list_handles(share_name, directory_name=None, file_name=None, recursive=None, max_results=None, marker=None, snapshot=None, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name	str O caminho para o diretório. valor padrão: None
file_name	str Nome do arquivo existente. valor padrão: None
recursive	bool Boolean que especifica se a operação deve ser aplicada ao diretório especificado no URI, seus arquivos, seus subdiretórios e seus arquivos. valor padrão: None
max_results	int Especifica o número máximo de identificadores feitos em arquivos e/ou diretórios a serem retornados. Se a solicitação não especificar max_results ou especificar um valor maior que 5.000, o servidor retornará até 5.000 itens. Definir max_results como um valor menor ou igual a zero resulta em código de resposta de erro 400 (Solicitação Incorreta). valor padrão: None
marker	str Um token de continuação opaco. Esse valor poderá ser recuperado do campo next_marker de um objeto gerador anterior se max_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. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

list_ranges

Recupera os intervalos válidos para um arquivo.

list_ranges(share_name, directory_name, file_name, start_range=None, end_range=None, timeout=None, snapshot=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
start_range	int Especifica o deslocamento inicial de bytes sobre os quais listar intervalos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo. valor padrão: None
end_range	int Especifica o deslocamento final de bytes sobre os quais listar intervalos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
snapshot	str Uma cadeia de caracteres que representa a versão instantâneo, se aplicável. valor padrão: None

Retornos

Tipo	Description
<xref:a> list <xref:of> FileRange	uma lista de intervalos válidos

list_shares

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

Se num_results for especificado e a conta tiver mais do que esse número de compartilhamentos, 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_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)

Parâmetros

Nome	Description
prefix	str Filtra os resultados para retornar apenas compartilhamentos cujos nomes começam com o prefixo especificado. valor padrão: None
num_results	int Especifica o número máximo de compartilhamentos a serem retornados. valor padrão: None
include_metadata	bool Especifica que os metadados de compartilhamento sejam retornados na resposta. valor padrão: False
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. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None
include_snapshots	bool Especifica que os instantâneos de compartilhamento sejam retornados na resposta. valor padrão: False

make_file_url

Cria a URL para acessar um arquivo.

make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo.
protocol	str Protocolo a ser usado: 'http' ou 'https'. Se não for especificado, usará o protocolo especificado quando FileService foi inicializado. valor padrão: None
sas_token	str Token de assinatura de acesso compartilhado criado com generate_shared_access_signature. valor padrão: None

Retornos

Tipo	Description
str	URL de acesso ao arquivo.

resize_file

Redimensiona um arquivo com o tamanho especificado. Se o valor de byte especificado é menor do que o tamanho atual do arquivo, então todos os intervalos acima do valor de byte especificado são limpos.

resize_file(share_name, directory_name, file_name, content_length, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
content_length Obrigatório	int O comprimento para o qual redimensionar o arquivo.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

set_directory_metadata

Define um ou mais pares nome-valor definidos pelo usuário para o diretório especificado. Cada chamada para essa operação substitui todos os metadados existentes anexados ao diretório. Para remover todos os metadados do diretório, chame essa operação sem um ditado de metadados.

set_directory_metadata(share_name, directory_name, metadata=None, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
metadata	dict(str, str)<xref:./> Um ditado que contém pares nome-valor a serem associados ao diretório como metadados. Exemplo: {'category':'test'} valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

set_directory_properties

set_directory_properties(share_name, directory_name, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	Nome do compartilhamento
directory_name Obrigatório	Nome do diretório
file_permission	str Permissão de arquivo, um SDDL portátil valor padrão: None
smb_properties	SMBProperties Define as propriedades de arquivo relacionadas ao SMB
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

set_file_metadata

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

set_file_metadata(share_name, directory_name, file_name, metadata=None, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
metadata	dict(str, str) Ditado que contém pares de nome e valor. Cada chamada para essa operação substitui todos os metadados existentes anexados ao arquivo. Para remover todos os metadados do arquivo, chame esta operação com nenhum cabeçalho dos metadados. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

set_file_properties

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

set_file_properties(share_name, directory_name, file_name, content_settings, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
content_settings Obrigatório	ContentSettings Objeto ContentSettings usado para definir as propriedades do arquivo.
file_permission	str Permissão de arquivo, um SDDL portátil valor padrão: None
smb_properties	SMBProperties Define as propriedades de arquivo relacionadas ao SMB
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

set_file_service_properties

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

set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

Parâmetros

Nome	Description
hour_metrics	<xref: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 arquivos. valor padrão: None
minute_metrics	<xref:Metrics> As configurações de métricas de minuto fornecem estatísticas de solicitação para cada minuto para arquivos. valor padrão: None
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. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

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

Nome	Description
host Obrigatório	str Endereço do proxy. Ex: '192.168.0.100'
port Obrigatório	int Porta do proxy. Ex: 6000
user	str Usuário para autorização de proxy. valor padrão: None
password	str Senha para autorização de proxy. valor padrão: None

Define as permissões para as políticas de acesso armazenadas ou de compartilhamento especificadas que podem ser usadas com assinaturas de acesso compartilhado.

set_share_acl(share_name, signed_identifiers=None, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
signed_identifiers	dict(str, AccessPolicy) Um dicionário de políticas de acesso a serem associadas ao compartilhamento. O dicionário pode conter até 5 elementos. Um dicionário vazio limpará as políticas de acesso definidas no serviço. valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Define um ou mais pares nome-valor definidos pelo usuário para o compartilhamento especificado. Cada chamada para essa operação substitui todos os metadados existentes anexados ao compartilhamento. Para remover todos os metadados do compartilhamento, chame essa operação sem um ditado de metadados.

set_share_metadata(share_name, metadata=None, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
metadata	dict(str, str) Um ditado que contém pares nome-valor a serem associados ao compartilhamento como metadados. Exemplo: {'category':'test'} valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Define as propriedades definidas pelo serviço para o compartilhamento especificado.

set_share_properties(share_name, quota, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
quota Obrigatório	int Especifica o tamanho máximo do compartilhamento em gigabytes. Deve ser maior que 0 e menor ou igual a 5 TB (5120 GB).
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Cria um instantâneo de um compartilhamento existente na conta especificada.

snapshot_share(share_name, metadata=None, quota=None, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str O nome do compartilhamento do qual criar uma instantâneo.
metadata	<xref:<xref:a dict> of <xref:str to str:>> Um ditado com pares de name_value a serem associados ao compartilhamento como metadados. Exemplo:{'Category':'test'} valor padrão: None
quota	int Especifica o tamanho máximo do compartilhamento em gigabytes. Deve ser maior que 0 e menor ou igual a 5 TB (5120). valor padrão: None
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Retornos

Tipo	Description
Share	instantâneo propriedades

update_range

Grava os bytes especificados pelo corpo da solicitação no intervalo especificado.

update_range(share_name, directory_name, file_name, data, start_range, end_range, validate_content=False, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
data Obrigatório	bytes Conteúdo do intervalo.
start_range Obrigatório	int Início do intervalo de bytes a ser usado para atualizar uma seção do arquivo. O intervalo pode ter até 4 MB de tamanho. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo.
end_range Obrigatório	int Fim do intervalo de bytes a ser usado para atualizar uma seção do arquivo. O intervalo pode ter até 4 MB de tamanho. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo.
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 arquivo . valor padrão: False
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

update_range_from_file_url

Grava os bytes de um ponto de extremidade de Arquivo do Azure no intervalo especificado de outro ponto de extremidade de Arquivo do Azure.

update_range_from_file_url(share_name, directory_name, file_name, start_range, end_range, source, source_start_range, timeout=None)

Parâmetros

Nome	Description
share_name Obrigatório	str Nome do compartilhamento existente.
directory_name Obrigatório	str O caminho para o diretório.
file_name Obrigatório	str Nome do arquivo existente.
start_range Obrigatório	int Início do intervalo de bytes a ser usado para atualizar uma seção do arquivo. O intervalo pode ter até 4 MB de tamanho. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo.
end_range Obrigatório	int Fim do intervalo de bytes a ser usado para atualizar uma seção do arquivo. O intervalo pode ter até 4 MB de tamanho. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo.
source Obrigatório	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.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
source_start_range Obrigatório	int Início do intervalo de bytes a ser usado para atualizar uma seção do arquivo. O intervalo pode ter até 4 MB de tamanho. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 baixará os primeiros 512 bytes do arquivo.
timeout	int O parâmetro timeout é expresso em segundos. valor padrão: None

Atributos

protocol

request_session

socket_timeout

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 8388608

MAX_RANGE_SIZE

MAX_RANGE_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432

Compartilhar via

FileService Classe

Construtor

Parâmetros

Variáveis

Métodos

abort_copy_file

Parâmetros

clear_range

Parâmetros

close_handles

Parâmetros

copy_file

Parâmetros

Retornos

create_directory

Parâmetros

Retornos

create_file

Parâmetros

create_file_from_bytes

Parâmetros

create_file_from_path

Parâmetros

create_file_from_stream

Parâmetros

create_file_from_text

Parâmetros

create_permission_for_share

Parâmetros

create_share

Parâmetros

Retornos

delete_directory

Parâmetros

Retornos

delete_file

Parâmetros

delete_share

Parâmetros

Retornos

exists

Parâmetros

Retornos

extract_date_and_request_id

Parâmetros

generate_account_shared_access_signature

Parâmetros

Retornos

generate_file_shared_access_signature

Parâmetros

Retornos

generate_share_shared_access_signature

Parâmetros

Retornos

get_directory_metadata

Parâmetros

Retornos

get_directory_properties

Parâmetros

Retornos

get_file_metadata

Parâmetros

Retornos

get_file_properties

Parâmetros

Retornos

get_file_service_properties

Parâmetros

Retornos

get_file_to_bytes

Parâmetros

Retornos

get_file_to_path

Parâmetros

Retornos

get_file_to_stream

Parâmetros

Retornos

get_file_to_text