FileService Classe

Referência

O protocolo SMB (Server Message Block) é o protocolo de partilha de ficheiros preferido utilizado atualmente no local. O serviço Ficheiro do Microsoft Azure permite que os clientes tirem partido da disponibilidade e escalabilidade do SMB de Infraestrutura como Serviço (IaaS) da Cloud do Azure sem ter de reescrever as aplicações cliente SMB.

O serviço de Ficheiros do Azure também oferece uma alternativa apelativa às soluções tradicionais de Armazenamento Direto Anexado (DAS) e de Rede de Armazenamento (SAN), muitas vezes complexas e dispendiosas 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

Name	Description
account_name	str O nome da conta de armazenamento. Isto é utilizado para autenticar pedidos assinados com uma chave de conta e para construir o ponto final de armazenamento. É necessário, a menos que seja dado um cadeia de ligação. valor predefinido: None
account_key	str A chave da conta de armazenamento. Isto é utilizado para autenticação de chave partilhada. valor predefinido: None
sas_token	str Um token de assinatura de acesso partilhado a utilizar para autenticar pedidos em vez da chave de conta. Se a chave da conta e o token sas forem ambos especificados, a chave de conta será utilizada para assinar. valor predefinido: None
protocol	str O protocolo a utilizar para pedidos. A predefinição é https. valor predefinido: https
endpoint_suffix	str O componente base do anfitrião do URL, menos o nome da conta. É predefinida para o Azure (core.windows.net). Substitua esta opção para utilizar a cloud da China (core.chinacloudapi.cn). valor predefinido: core.windows.net
request_session	<xref:requests.Session> O objeto de sessão a utilizar para pedidos http. valor predefinido: None
connection_string	str Se for especificado, esta ação substituirá todos os outros parâmetros para além da sessão de pedido. Veja http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ o formato cadeia de ligação. valor predefinido: None
socket_timeout	int Se for especificado, isto substituirá o tempo limite do socket predefinido. O tempo limite especificado é em segundos. Veja DEFAULT_SOCKET_TIMEOUT em _constants.py para obter o valor predefinido. valor predefinido: None

Variáveis

Name	Description
MAX_SINGLE_GET_SIZE	int O tamanho do primeiro intervalo é executado por métodos get_file_to_* se max_connections for superior a 1. Serão devolvidos menos dados se o ficheiro for mais pequeno do que este.
MAX_CHUNK_GET_SIZE	int O tamanho do intervalo subsequente é executado por métodos get_file_to_* se max_connections for superior a 1 e o ficheiro for maior do que MAX_SINGLE_GET_SIZE. Serão devolvidos menos dados se o resto do ficheiro for menor do que este. Se estiver definido como superior a 4 MB, content_validation emitirá um erro se estiver ativado. No entanto, se não for desejado content_validation um tamanho superior a 4 MB poderá ser ideal. A definição abaixo de 4 MB não é recomendada.
MAX_RANGE_SIZE	int O tamanho dos intervalos colocados pelos métodos create_file_from_*. Podem ser colocados intervalos mais pequenos se forem fornecidos menos dados. O tamanho máximo do intervalo suportado pelo serviço é de 4 MB.

Métodos

abort_copy_file	Aborta uma operação de copy_file pendente e deixa um ficheiro de destino com comprimento zero e metadados completos.
clear_range	Limpa o intervalo especificado e liberta o espaço utilizado no armazenamento para esse intervalo.
close_handles	Devolve um gerador para fechar identificadores abertos num diretório ou num ficheiro na partilha especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os identificadores tiverem sido fechados. Os valores gerados representam o número de identificadores que foram fechados em cada transação.
copy_file	Copia um ficheiro de forma assíncrona. Esta operação devolve um objeto de propriedades da operação de cópia, incluindo um ID de cópia que pode utilizar para verificar ou abortar a operação de cópia. O Serviço de ficheiros copia os ficheiros numa base de melhor esforço. Se o ficheiro de destino existir, será substituído. Não é possível modificar o ficheiro de destino enquanto a operação de cópia estiver em curso.
create_directory	Cria um novo diretório no diretório de partilha ou principal especificado. Se o diretório com o mesmo nome já existir, a operação falhará no serviço. Por predefinição, a exceção é engolida pelo cliente. Para expor a exceção, especifique Verdadeiro para fail_on_exists.
create_file	Cria um novo ficheiro. Veja create_file_from_* para obter funções de alto nível que processam a criação e carregamento de ficheiros grandes com segmentação automática e notificações de progresso.
create_file_from_bytes	Cria um novo ficheiro a partir de uma matriz de bytes ou atualiza o conteúdo de um ficheiro existente, com segmentação automática e notificações de progresso.
create_file_from_path	Cria um novo ficheiro do Azure a partir de um caminho de ficheiro local ou atualiza o conteúdo de um ficheiro existente, com segmentação automática e notificações de progresso.
create_file_from_stream	Cria um novo ficheiro a partir de um ficheiro/fluxo ou atualiza o conteúdo de um ficheiro existente, com notificações automáticas de segmentação e progresso.
create_file_from_text	Cria um novo ficheiro a partir de str/unicode ou atualiza o conteúdo de um ficheiro existente, com as notificações de segmentação e progresso automáticas.
create_permission_for_share	Crie uma permissão (um descritor de segurança) ao nível da partilha. Esta "permissão" pode ser utilizada para os ficheiros/diretórios na partilha. Se já existir uma "permissão", devolverá a chave da mesma, caso contrário, cria uma nova permissão ao nível da partilha e devolve a sua chave. :devolve uma chave de permissão de ficheiro :rtype str
create_share	Cria uma nova partilha na conta especificada. Se a partilha com o mesmo nome já existir, a operação falhará no serviço. Por predefinição, a exceção é engolida pelo cliente. Para expor a exceção, especifique Verdadeiro para fail_on_exists.
delete_directory	Elimina o diretório vazio especificado. Tenha em atenção que o diretório tem de estar vazio antes de poder ser eliminado. A tentativa de eliminar diretórios que não estejam vazios falhará. Se o diretório não existir, a operação falha no serviço. Por predefinição, a exceção é engolida pelo cliente. Para expor a exceção, especifique Verdadeiro para fail_not_exist.
delete_file	Marca o ficheiro especificado para eliminação. O ficheiro é eliminado mais tarde durante a libertação da memória.
delete_share	Marca a partilha especificada para eliminação. Se a partilha não existir, a operação falha no serviço. Por predefinição, a exceção é engolida pelo cliente. Para expor a exceção, especifique Verdadeiro para fail_not_exist.
exists	Devolve um valor booleano que indica se a partilha existe se for atribuído apenas o nome da partilha. Se directory_name for específico, será devolvido um booleano que indica se o diretório existe. Se file_name também for especificado, será devolvido um booleano que indica se o ficheiro existe.
extract_date_and_request_id
generate_account_shared_access_signature	Gera uma assinatura de acesso partilhado para o serviço de ficheiros. Utilize a assinatura devolvida com o parâmetro sas_token do FileService.
generate_file_shared_access_signature	Gera uma assinatura de acesso partilhado para o ficheiro. Utilize a assinatura devolvida com o parâmetro sas_token de FileService.
generate_share_shared_access_signature	Gera uma assinatura de acesso partilhado para a partilha. Utilize a assinatura devolvida com o parâmetro sas_token de FileService.
get_directory_metadata	Devolve todos os metadados definidos pelo utilizador para o diretório especificado.
get_directory_properties	Devolve todos os metadados definidos pelo utilizador e as propriedades do sistema para o diretório especificado. Os dados devolvidos não incluem a lista de ficheiros do diretório.
get_file_metadata	Devolve todos os metadados definidos pelo utilizador para o ficheiro especificado.
get_file_properties	Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o ficheiro. Devolve uma instância de File com FileProperties e um dict de metadados.
get_file_service_properties	Obtém as propriedades do serviço Ficheiro de uma conta de armazenamento, incluindo o Azure Análise de Armazenamento.
get_file_to_bytes	Transfere um ficheiro como uma matriz de bytes, com segmentação automática e notificações de progresso. Devolve uma instância de File com propriedades, metadados e conteúdo.
get_file_to_path	Transfere um ficheiro para um caminho de ficheiro, com segmentação automática e notificações de progresso. Devolve uma instância de Ficheiro com propriedades e metadados.
get_file_to_stream	Transfere um ficheiro para um fluxo, com segmentação automática e notificações de progresso. Devolve uma instância de File com propriedades e metadados.
get_file_to_text	Transfere um ficheiro como texto unicode, com segmentação automática e notificações de progresso. Devolve uma instância de File com propriedades, metadados e conteúdo.
get_permission_for_share	Crie uma permissão (um descritor de segurança) ao nível da partilha. Esta "permissão" pode ser utilizada para os ficheiros/diretórios na partilha. Se já existir uma "permissão", devolverá a chave da mesma, caso contrário, cria uma nova permissão ao nível da partilha e devolve a respetiva chave. :devolve uma permissão de ficheiro (um SDDL portátil) :rtype str
get_share_acl	Obtém as permissões para a partilha especificada.
get_share_metadata	Devolve todos os metadados definidos pelo utilizador para a partilha especificada.
get_share_properties	Devolve todos os metadados definidos pelo utilizador e as propriedades do sistema para a partilha especificada. Os dados devolvidos não incluem a lista de ficheiros ou diretórios das partilhas.
get_share_stats	Obtém o tamanho aproximado dos dados armazenados na partilha, arredondados para o gigabyte mais próximo. Tenha em atenção que este valor pode não incluir todos os ficheiros criados recentemente ou redimensionados recentemente.
get_share_stats_in_bytes	Obtém o tamanho aproximado dos dados armazenados na partilha em bytes. Tenha em atenção que este valor pode não incluir todos os ficheiros criados recentemente ou redimensionados recentemente.
list_directories_and_files	Devolve um gerador para listar os diretórios e ficheiros na partilha especificada. O gerador seguirá lentamente os tokens de continuação devolvidos pelo serviço e parará quando todos os diretórios e ficheiros tiverem sido devolvidos ou num_results for atingido. Se num_results for especificado e a partilha tiver mais do que esse número de ficheiros e diretórios, o gerador terá um campo de next_marker preenchido assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.
list_handles	Devolve um gerador para listar identificadores abertos num diretório ou num ficheiro na partilha especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os identificadores tiverem sido devolvidos ou num_results for atingido. Se num_results for especificado e a partilha tiver mais do que esse número de ficheiros e diretórios, o gerador terá um campo de next_marker preenchido assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.
list_ranges	Obtém os intervalos válidos de um ficheiro.
list_shares	Devolve um gerador para listar as partilhas na conta especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todas as partilhas tiverem sido devolvidas ou num_results for atingido. Se num_results for especificado e a conta tiver mais do que esse número de partilhas, o gerador terá um campo de next_marker preenchido assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.
make_file_url	Cria o URL para aceder a um ficheiro.
resize_file	Redimensiona um ficheiro para o tamanho especificado. Se o valor de byte especificado for menor do que o tamanho atual do ficheiro, todos os intervalos acima do valor de byte especificado serão limpos.
set_directory_metadata	Define um ou mais pares nome-valor definidos pelo utilizador para o diretório especificado. Cada chamada para esta operação substitui todos os metadados existentes anexados ao diretório. Para remover todos os metadados do diretório, chame esta operação sem dict de metadados.
set_directory_properties
set_file_metadata	Define os metadados definidos pelo utilizador para o ficheiro especificado como um ou mais pares name-value.
set_file_properties	Define as propriedades do sistema no ficheiro. Se uma propriedade estiver definida para o content_settings, todas as propriedades serão substituídas.
set_file_service_properties	Define as propriedades do serviço Ficheiro de uma conta de armazenamento, incluindo o Azure Análise de Armazenamento. Se um elemento (ex HourMetrics) for deixado como Nenhum, as definições existentes no serviço para essa funcionalidade serão preservadas.
set_proxy	Define o anfitrião 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 partilhado ou armazenado especificadas que podem ser utilizadas com Assinaturas de Acesso Partilhado.
set_share_metadata	Define um ou mais pares nome-valor definidos pelo utilizador para a partilha especificada. Cada chamada para esta operação substitui todos os metadados existentes anexados à partilha. Para remover todos os metadados da partilha, chame esta operação sem dict de metadados.
set_share_properties	Define as propriedades definidas pelo serviço para a partilha especificada.
snapshot_share	Cria um instantâneo de uma partilha existente na conta especificada.
update_range	Escreve os bytes especificados pelo corpo do pedido no intervalo especificado.
update_range_from_file_url	Escreve os bytes de um ponto final de Ficheiro do Azure no intervalo especificado de outro ponto final de Ficheiro do Azure.

abort_copy_file

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

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha de destino.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro de destino.
copy_id Necessário	str Identificador de cópia fornecido na copy.id da operação de copy_file original.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

clear_range

Limpa o intervalo especificado e liberta o espaço utilizado no armazenamento para esse intervalo.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
start_range Necessário	int Início do intervalo de bytes a utilizar para limpar uma secção do ficheiro. 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 transferirá os primeiros 512 bytes de ficheiro.
end_range Necessário	int Fim do intervalo de bytes a utilizar para limpar uma secção do ficheiro. 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 transferirá os primeiros 512 bytes de ficheiro.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

close_handles

Devolve um gerador para fechar identificadores abertos num diretório ou num ficheiro na partilha especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os identificadores tiverem sido fechados. 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name	str O caminho para o diretório. valor predefinido: None
file_name	str Nome do ficheiro existente. valor predefinido: None
recursive	bool Valor booleano que especifica se a operação deve aplicar-se ao diretório especificado no URI, aos respetivos ficheiros, aos respetivos subdiretórios e aos respetivos ficheiros. valor predefinido: None
handle_id	str Obrigatório. Especifica o ID do identificador aberto no ficheiro ou diretório a fechar. Astrix ('*') é um caráter universal que especifica todos os identificadores. valor predefinido: None
marker	str Um token de continuação opaco. Este valor pode ser obtido a partir do campo next_marker de um objeto gerador anterior se ainda não tiver terminado de fechar as alças. Se for especificado, este gerador começará a fechar as alças a partir do ponto onde o gerador anterior parou. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

copy_file

Copia um ficheiro de forma assíncrona. Esta operação devolve um objeto de propriedades da operação de cópia, incluindo um ID de cópia que pode utilizar para verificar ou abortar a operação de cópia. O Serviço de ficheiros copia os ficheiros numa base de melhor esforço.

Se o ficheiro de destino existir, será substituído. Não é possível modificar o ficheiro de destino enquanto a operação de cópia estiver em curso.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha de destino. A partilha tem de existir.
directory_name Necessário	str Nome do diretório de destino. O diretório tem de existir.
file_name Necessário	str Nome do ficheiro de destino. Se o ficheiro de destino existir, será substituído. Caso contrário, será criado.
copy_source Necessário	str Um URL com até 2 KB de comprimento que especifica um ficheiro ou blob do Azure. O valor deve ser codificado com URL, tal como apareceria num URI de pedido. Se a origem estiver noutra conta, a origem tem de ser pública ou ter de ser autenticada através de uma assinatura de acesso partilhado. Se a origem for pública, não é necessária autenticação. Exemplos: https://myaccount.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
metadata	dict(str, str)<xref:./> Pares nome-valor associados ao ficheiro como metadados. Se não forem especificados pares nome-valor, a operação copiará os metadados do blob ou ficheiro de origem para o ficheiro de destino. Se for especificado um ou mais pares nome-valor, o ficheiro de destino é criado com os metadados especificados e os metadados não são copiados do blob ou ficheiro de origem. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

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

create_directory

Cria um novo diretório no diretório de partilha ou principal especificado. Se o diretório com o mesmo nome já existir, a operação falhará no serviço. Por predefinição, a exceção é engolida pelo cliente. Para expor a exceção, especifique Verdadeiro 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str Nome do diretório a criar, incluindo o caminho para o diretório principal.
metadata	dict(str, str)<xref::> Um ditado com name_value pares para associar à partilha como metadados. Exemplo:{'Category':'test'} valor predefinido: None
fail_on_exist	bool especificar se pretende gerar uma exceção quando o diretório existe. Falso por predefinição. valor predefinido: False
file_permission	str Permissão de ficheiro, um SDDL portátil valor predefinido: None
smb_properties	SMBProperties Define as propriedades do ficheiro relacionado com o SMB
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

Tipo	Description
bool	Verdadeiro se o diretório for criado, Falso se o diretório já existir.

create_file

Cria um novo ficheiro.

Veja create_file_from_* para obter funções de alto nível que processam a criação e carregamento de ficheiros grandes com segmentação automática e notificações de 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro a criar ou atualizar.
content_length Necessário	int Comprimento do ficheiro em bytes.
content_settings	ContentSettings Objeto ContentSettings utilizado para definir propriedades de ficheiro. valor predefinido: None
metadata	dict(str, str) Pares nome-valor associados ao ficheiro como metadados. valor predefinido: None
file_permission	str Permissão de ficheiro, um SDDL portátil valor predefinido: None
smb_properties	SMBProperties Define as propriedades de ficheiro relacionadas com SMB
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

create_file_from_bytes

Cria um novo ficheiro a partir de uma matriz de bytes ou atualiza o conteúdo de um ficheiro existente, com segmentação automática e notificações de 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro a criar ou atualizar.
file Necessário	str Conteúdo do ficheiro como uma matriz de bytes.
index	int Iniciar índice na matriz de bytes. valor predefinido: 0
count	int Número de bytes a carregar. Defina como Nenhum ou valor negativo para carregar todos os bytes a partir do índice. valor predefinido: None
content_settings	ContentSettings Objeto ContentSettings utilizado para definir propriedades de ficheiro. valor predefinido: None
metadata	dict(str, str) Pares nome-valor associados ao ficheiro como metadados. valor predefinido: None
validate_content	bool Se verdadeiro, calcula um hash MD5 para cada intervalo do ficheiro. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que este hash MD5 não é armazenado com o ficheiro. valor predefinido: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Chamada de retorno para o progresso com a função de assinatura (atual, total) em que atual é o número de bytes transferidos até agora e o total é o tamanho do ficheiro ou Nenhum se o tamanho total for desconhecido. valor predefinido: None
max_connections	int Número máximo de ligações paralelas a utilizar. valor predefinido: 2
file_permission	str Permissão de ficheiro, um SDDL portátil valor predefinido: None
smb_properties	SMBProperties Define as propriedades de ficheiro relacionadas com SMB
timeout	int O parâmetro de tempo limite é expresso em segundos. Este método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente. valor predefinido: None

create_file_from_path

Cria um novo ficheiro do Azure a partir de um caminho de ficheiro local ou atualiza o conteúdo de um ficheiro existente, com segmentação automática e notificações de 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro a criar ou atualizar.
local_file_path Necessário	str Caminho do ficheiro local para carregar como o conteúdo do ficheiro.
content_settings	ContentSettings Objeto ContentSettings utilizado para definir propriedades de ficheiro. valor predefinido: None
metadata	dict(str, str) Pares nome-valor associados ao ficheiro como metadados. valor predefinido: None
validate_content	bool Se verdadeiro, calcula um hash MD5 para cada intervalo do ficheiro. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que este hash MD5 não é armazenado com o ficheiro. valor predefinido: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Chamada de retorno para o progresso com a função de assinatura (atual, total) em que atual é o número de bytes transferidos até agora e o total é o tamanho do ficheiro ou Nenhum se o tamanho total for desconhecido. valor predefinido: None
max_connections	int Número máximo de ligações paralelas a utilizar. valor predefinido: 2
file_permission	str Permissão de ficheiro, um SDDL portátil valor predefinido: None
smb_properties	SMBProperties Define as propriedades de ficheiro relacionadas com SMB
timeout	int O parâmetro de tempo limite é expresso em segundos. Este método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente. valor predefinido: None

create_file_from_stream

Cria um novo ficheiro a partir de um ficheiro/fluxo ou atualiza o conteúdo de um ficheiro existente, com notificações automáticas de segmentação 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro a criar ou atualizar.
stream Necessário	IOBase Ficheiro/fluxo aberto para carregar como o conteúdo do ficheiro.
count Necessário	int Número de bytes a ler a partir do fluxo. Isto é necessário, não é possível criar um ficheiro se a contagem for desconhecida.
content_settings	ContentSettings Objeto ContentSettings utilizado para definir propriedades de ficheiro. valor predefinido: None
metadata	dict(str, str) Pares nome-valor associados ao ficheiro como metadados. valor predefinido: None
validate_content	bool Se verdadeiro, calcula um hash MD5 para cada intervalo do ficheiro. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que este hash MD5 não é armazenado com o ficheiro. valor predefinido: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Chamada de retorno para o progresso com a função de assinatura (atual, total) em que atual é o número de bytes transferidos até agora e o total é o tamanho do ficheiro ou Nenhum se o tamanho total for desconhecido. valor predefinido: None
max_connections	int Número máximo de ligações paralelas a utilizar. Tenha em atenção que o carregamento paralelo requer que o fluxo seja procurado. valor predefinido: 2
file_permission	str Permissão de ficheiro, um SDDL portátil valor predefinido: None
smb_properties	SMBProperties Define as propriedades de ficheiro relacionadas com SMB
timeout	int O parâmetro de tempo limite é expresso em segundos. Este método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente. valor predefinido: None

create_file_from_text

Cria um novo ficheiro a partir de str/unicode ou atualiza o conteúdo de um ficheiro existente, com as notificações de segmentação e progresso automáticas.

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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro a criar ou atualizar.
text Necessário	str Texto para carregar para o ficheiro.
encoding	str Codificação python a utilizar para converter o texto em bytes. valor predefinido: utf-8
content_settings	ContentSettings Objeto ContentSettings utilizado para definir propriedades de ficheiro. valor predefinido: None
metadata	dict(str, str) Pares nome-valor associados ao ficheiro como metadados. valor predefinido: None
validate_content	bool Se verdadeiro, calcula um hash MD5 para cada intervalo do ficheiro. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que este hash MD5 não é armazenado com o ficheiro. valor predefinido: False
file_permission	str Permissão de ficheiro, um SDDL portátil valor predefinido: None
smb_properties	SMBProperties Define as propriedades de ficheiro relacionadas com SMB
timeout	int O parâmetro de tempo limite é expresso em segundos. Este método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente. valor predefinido: None

Crie uma permissão (um descritor de segurança) ao nível da partilha. Esta "permissão" pode ser utilizada para os ficheiros/diretórios na partilha. Se já existir uma "permissão", devolverá a chave da mesma, caso contrário, cria uma nova permissão ao nível da partilha e devolve a sua chave.

:devolve uma chave de permissão de ficheiro :rtype str

create_permission_for_share(share_name, file_permission, timeout=None)

Parâmetros

Name	Description
share_name Necessário	Nome da partilha.
file_permission Necessário	Permissão de ficheiro, um SDDL Portátil
timeout	O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Cria uma nova partilha na conta especificada. Se a partilha com o mesmo nome já existir, a operação falhará no serviço. Por predefinição, a exceção é engolida pelo cliente. Para expor a exceção, especifique Verdadeiro para fail_on_exists.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha a criar.
metadata	dict(str, str) Um ditado com name_value pares para associar à partilha como metadados. Exemplo:{'Categoria':'teste'} valor predefinido: None
quota	int Especifica o tamanho máximo da partilha, em gigabytes. Tem de ser maior que 0 e menor ou igual a 5 TB (5120). valor predefinido: None
fail_on_exist	bool Especifique se pretende lançar uma exceção quando a partilha existe. Falso por predefinição. valor predefinido: False
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

Tipo	Description
bool	Verdadeiro se a partilha for criada, Falso se a partilha já existir.

delete_directory

Elimina o diretório vazio especificado. Tenha em atenção que o diretório tem de estar vazio antes de poder ser eliminado. A tentativa de eliminar diretórios que não estejam vazios falhará.

Se o diretório não existir, a operação falha no serviço. Por predefinição, a exceção é engolida pelo cliente. Para expor a exceção, especifique Verdadeiro para fail_not_exist.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str Nome do diretório a eliminar, incluindo o caminho para o diretório principal.
fail_not_exist	bool Especifique se pretende gerar uma exceção quando o diretório não existe. valor predefinido: False
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

Tipo	Description
bool	Verdadeiro se o diretório for eliminado, Falso caso contrário.

delete_file

Marca o ficheiro especificado para eliminação. O ficheiro é eliminado mais tarde durante a libertação da memória.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Marca a partilha especificada para eliminação. Se a partilha não existir, a operação falha no serviço. Por predefinição, a exceção é engolida pelo cliente. Para expor a exceção, especifique Verdadeiro para fail_not_exist.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha a eliminar.
fail_not_exist	bool Especifique se pretende gerar uma exceção quando a partilha não existe. Falso por predefinição. valor predefinido: False
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. Especifique este argumento para eliminar apenas um instantâneo específico. delete_snapshots tem de ser Nenhum se for especificado. valor predefinido: None
delete_snapshots	DeleteSnapshot Para eliminar uma partilha que tenha instantâneos, tem de ser especificada como DeleteSnapshot.Include. valor predefinido: None

Devoluções

Tipo	Description
bool	Verdadeiro se a partilha for eliminada, a partilha False não existe.

exists

Devolve um valor booleano que indica se a partilha existe se for atribuído apenas o nome da partilha. Se directory_name for específico, será devolvido um booleano que indica se o diretório existe. Se file_name também for especificado, será devolvido um booleano que indica se o ficheiro existe.

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

Parâmetros

Name	Description
share_name Necessário	str Nome de uma partilha.
directory_name	str O caminho para um diretório. valor predefinido: None
file_name	str Nome de um ficheiro. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

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

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parâmetros

Name	Description
retry_context Necessário

generate_account_shared_access_signature

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

Name	Description
resource_types Necessário	<xref:ResourceTypes> Especifica os tipos de recursos que estão acessíveis com a SAS da conta.
permission Necessário	<xref:AccountPermissions> As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada.
expiry Necessário	datetime ou str O momento em que a assinatura de acesso partilhado se torna inválida. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.
start	datetime ou str O momento em que a assinatura de acesso partilhado se torna válida. Se for omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. valor predefinido: None
ip	str Especifica um endereço IP ou um intervalo de endereços IP a partir do qual aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 no SAS restringe o pedido a esses endereços IP. valor predefinido: None
protocol	str Especifica o protocolo permitido para um pedido feito. Os valores possíveis são https e HTTP (https,http) ou apenas HTTPS (https). O valor predefinido é https,http. Tenha em atenção que HTTP apenas não é um valor permitido. valor predefinido: None

Devoluções

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

generate_file_shared_access_signature

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

Name	Description
share_name Necessário	str Nome da partilha.
directory_name	str Nome do diretório. Não é possível criar tokens de SAS para diretórios, pelo que este parâmetro só deve estar presente se file_name for fornecido. valor predefinido: None
file_name	str Nome do ficheiro. valor predefinido: None
permission	FilePermissions As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. As permissões têm de ser ordenadas como leitura, criação, escrita, eliminação, lista. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. valor predefinido: None
expiry	datetime ou str O momento em que a assinatura de acesso partilhado se torna inválida. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. valor predefinido: None
start	datetime ou str O momento em que a assinatura de acesso partilhado se torna válida. Se for omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. valor predefinido: None
id	str Um valor exclusivo com até 64 carateres de comprimento que se correlaciona com uma política de acesso armazenada. Para criar uma política de acesso armazenada, utilize set_file_service_properties. valor predefinido: None
ip	str Especifica um endereço IP ou um intervalo de endereços IP a partir do qual aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 no SAS restringe o pedido a esses endereços IP. valor predefinido: None
protocol	str Especifica o protocolo permitido para um pedido feito. Os valores possíveis são https e HTTP (https,http) ou apenas HTTPS (https). O valor predefinido é https,http. Tenha em atenção que HTTP apenas não é um valor permitido. valor predefinido: None
cache_control	str Valor do cabeçalho de resposta para Cache-Control quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None
content_disposition	str Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None
content_encoding	str Valor do cabeçalho de resposta para Content-Encoding quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None
content_language	str Valor do cabeçalho de resposta para Content-Language quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None
content_type	str Valor do cabeçalho de resposta para Content-Type quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None

Devoluções

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

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

Name	Description
share_name Necessário	str Nome da partilha.
permission	SharePermissions As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. As permissões têm de ser ordenadas como leitura, criação, escrita, eliminação, lista. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. valor predefinido: None
expiry	datetime ou str O momento em que a assinatura de acesso partilhado se torna inválida. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. valor predefinido: None
start	datetime ou str O momento em que a assinatura de acesso partilhado se torna válida. Se for omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. valor predefinido: None
id	str Um valor exclusivo com até 64 carateres de comprimento que se correlaciona com uma política de acesso armazenada. Para criar uma política de acesso armazenada, utilize set_share_acl. valor predefinido: None
ip	str Especifica um endereço IP ou um intervalo de endereços IP a partir do qual aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 no SAS restringe o pedido a esses endereços IP. valor predefinido: None
protocol	str Especifica o protocolo permitido para um pedido feito. Os valores possíveis são https e HTTP (https,http) ou apenas HTTPS (https). O valor predefinido é https,http. Tenha em atenção que HTTP apenas não é um valor permitido. valor predefinido: None
cache_control	str Valor do cabeçalho de resposta para Cache-Control quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None
content_disposition	str Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None
content_encoding	str Valor do cabeçalho de resposta para Content-Encoding quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None
content_language	str Valor do cabeçalho de resposta para Content-Language quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None
content_type	str Valor do cabeçalho de resposta para Content-Type quando o recurso é acedido com esta assinatura de acesso partilhado. valor predefinido: None

Devoluções

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

get_directory_metadata

Devolve todos os metadados definidos pelo utilizador para o diretório especificado.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

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

get_directory_properties

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

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

Parâmetros

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

Devoluções

Tipo	Description
Directory	propriedades do diretório especificado num objeto de diretório.

get_file_metadata

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

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

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

get_file_properties

Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o ficheiro. Devolve 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

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

get_file_service_properties

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

get_file_service_properties(timeout=None)

Parâmetros

Name	Description
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

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

get_file_to_bytes

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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
start_range	int Início do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Se não for dada nenhuma end_range, todos os bytes após a start_range serão transferidos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
end_range	int Fim do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Se end_range for dada, start_range tem de ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
validate_content	bool Se for definido como verdadeiro, valida um hash MD5 para cada parte recuperada do ficheiro. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https como https (a predefinição) já for validada. Tenha em atenção que o serviço só devolverá MD5s transacionais para segmentos de 4 MB ou menos, pelo que o primeiro pedido get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como superior a 4 MB, será gerado um erro. Uma vez que a computação do MD5 demora tempo de processamento e mais pedidos terão de ser feitos devido ao tamanho reduzido dos segmentos, poderá haver algum aumento na latência. valor predefinido: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Chamada de retorno para o progresso com a função signature (atual, total) em que atual é o número de bytes transferidos até agora e o total é o tamanho do ficheiro, se conhecido. valor predefinido: None
max_connections	int Se estiver definido como 2 ou superior, será feita uma obtenção inicial para o primeiro self. MAX_SINGLE_GET_SIZE bytes do ficheiro. Se este for o ficheiro completo, o método será devolvido neste momento. Se não estiver, transferirá os dados restantes paralelos com o número de threads iguais a max_connections. Cada segmento terá um tamanho próprio. MAX_CHUNK_GET_SIZE. Se estiver definido como 1, será feito um único pedido get grande. Geralmente, isto não é recomendado, mas está disponível se forem utilizados muito poucos threads, os pedidos de rede são muito dispendiosos ou um fluxo não pesquisável impede a transferência paralela. Isto também pode ser útil se o ficheiro estiver a ser modificado simultaneamente para impor a atomicidade ou se se espera que muitos ficheiros estejam vazios, uma vez que é necessário um pedido adicional para ficheiros vazios se max_connections for superior a 1. valor predefinido: 2
timeout	int O parâmetro de tempo limite é expresso em segundos. Este método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

Tipo	Description
File	Um Ficheiro com propriedades, conteúdos e metadados.

get_file_to_path

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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
file_path Necessário	str Caminho do ficheiro para o qual escrever.
open_mode	str Modo a utilizar ao abrir o ficheiro. Tenha em atenção que especificar acrescentar apenas open_mode impede a transferência paralela. Portanto, max_connections tem de ser definido como 1 se este open_mode for utilizado. valor predefinido: wb
start_range	int Início do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Se não for dada nenhuma end_range, todos os bytes após a start_range serão transferidos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
end_range	int Fim do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Se end_range for dada, start_range tem de ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
validate_content	bool Se for definido como verdadeiro, valida um hash MD5 para cada parte recuperada do ficheiro. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https como https (a predefinição) já for validada. Tenha em atenção que o serviço só devolverá MD5s transacionais para segmentos de 4 MB ou menos, pelo que o primeiro pedido get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como superior a 4 MB, será gerado um erro. Uma vez que a computação do MD5 demora tempo de processamento e mais pedidos terão de ser feitos devido ao tamanho reduzido dos segmentos, poderá haver algum aumento na latência. valor predefinido: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Chamada de retorno para o progresso com a função signature (atual, total) em que atual é o número de bytes transferidos até agora e o total é o tamanho do ficheiro, se conhecido. valor predefinido: None
max_connections	int Se estiver definido como 2 ou superior, será feita uma obtenção inicial para o primeiro self. MAX_SINGLE_GET_SIZE bytes do ficheiro. Se este for o ficheiro completo, o método será devolvido neste momento. Se não estiver, transferirá os dados restantes paralelos com o número de threads iguais a max_connections. Cada segmento terá um tamanho próprio. MAX_CHUNK_GET_SIZE. Se estiver definido como 1, será feito um único pedido get grande. Geralmente, isto não é recomendado, mas está disponível se forem utilizados muito poucos threads, os pedidos de rede são muito dispendiosos ou um fluxo não pesquisável impede a transferência paralela. Isto também pode ser útil se o ficheiro estiver a ser modificado simultaneamente para impor a atomicidade ou se se espera que muitos ficheiros estejam vazios, uma vez que é necessário um pedido adicional para ficheiros vazios se max_connections for superior a 1. valor predefinido: 2
timeout	int O parâmetro de tempo limite é expresso em segundos. Este método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

Tipo	Description
File	Um Ficheiro com propriedades e metadados.

get_file_to_stream

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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
stream Necessário	IOBase Ficheiro/fluxo aberto para escrever.
start_range	int Início do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Se não for dada nenhuma end_range, todos os bytes após a start_range serão transferidos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
end_range	int Fim do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Se end_range for dada, start_range tem de ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
validate_content	bool Se for definido como verdadeiro, valida um hash MD5 para cada parte recuperada do ficheiro. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https como https (a predefinição) já for validada. Tenha em atenção que o serviço só devolverá MD5s transacionais para segmentos de 4 MB ou menos, pelo que o primeiro pedido get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como superior a 4 MB, será gerado um erro. Uma vez que a computação do MD5 demora tempo de processamento e mais pedidos terão de ser feitos devido ao tamanho reduzido dos segmentos, poderá haver algum aumento na latência. valor predefinido: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Chamada de retorno para o progresso com a função signature (atual, total) em que atual é o número de bytes transferidos até agora e o total é o tamanho do ficheiro, se conhecido. valor predefinido: None
max_connections	int Se estiver definido como 2 ou superior, será feita uma obtenção inicial para o primeiro self. MAX_SINGLE_GET_SIZE bytes do ficheiro. Se este for o ficheiro completo, o método será devolvido neste momento. Se não estiver, transferirá os dados restantes paralelos com o número de threads iguais a max_connections. Cada segmento terá um tamanho próprio. MAX_CHUNK_GET_SIZE. Se estiver definido como 1, será feito um único pedido get grande. Geralmente, isto não é recomendado, mas está disponível se forem utilizados muito poucos threads, os pedidos de rede são muito dispendiosos ou um fluxo não pesquisável impede a transferência paralela. Isto também pode ser útil se o ficheiro estiver a ser modificado simultaneamente para impor a atomicidade ou se se espera que muitos ficheiros estejam vazios, uma vez que é necessário um pedido adicional para ficheiros vazios se max_connections for superior a 1. valor predefinido: 2
timeout	int O parâmetro de tempo limite é expresso em segundos. Este método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

Tipo	Description
File	Um Ficheiro com propriedades e metadados.

get_file_to_text

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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
encoding	str Codificação Python a utilizar ao descodificar os dados de ficheiro. valor predefinido: utf-8
start_range	int Início do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Se não for dada nenhuma end_range, todos os bytes após a start_range serão transferidos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
end_range	int Fim do intervalo de bytes a utilizar para transferir uma secção do ficheiro. Se end_range for dada, start_range tem de ser fornecido. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
validate_content	bool Se for definido como verdadeiro, valida um hash MD5 para cada parte recuperada do ficheiro. Isto é importante para detetar bitflips no fio se a utilização de http em vez de https como https (a predefinição) já for validada. Tenha em atenção que o serviço só devolverá MD5s transacionais para segmentos de 4 MB ou menos, pelo que o primeiro pedido get será de tamanho próprio. MAX_CHUNK_GET_SIZE em vez de si mesmo. MAX_SINGLE_GET_SIZE. Se eu mesmo. MAX_CHUNK_GET_SIZE foi definido como superior a 4 MB, será gerado um erro. Uma vez que a computação do MD5 demora tempo de processamento e mais pedidos terão de ser feitos devido ao tamanho reduzido dos segmentos, poderá haver algum aumento na latência. valor predefinido: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Chamada de retorno para o progresso com a função signature (atual, total) em que atual é o número de bytes transferidos até agora e o total é o tamanho do ficheiro, se conhecido. valor predefinido: None
max_connections	int Se estiver definido como 2 ou superior, será feita uma obtenção inicial para o primeiro self. MAX_SINGLE_GET_SIZE bytes do ficheiro. Se este for o ficheiro completo, o método será devolvido neste momento. Se não estiver, transferirá os dados restantes paralelos com o número de threads iguais a max_connections. Cada segmento terá um tamanho próprio. MAX_CHUNK_GET_SIZE. Se estiver definido como 1, será feito um único pedido get grande. Geralmente, isto não é recomendado, mas está disponível se forem utilizados muito poucos threads, os pedidos de rede são muito dispendiosos ou um fluxo não pesquisável impede a transferência paralela. Isto também pode ser útil se o ficheiro estiver a ser modificado simultaneamente para impor a atomicidade ou se se espera que muitos ficheiros estejam vazios, uma vez que é necessário um pedido adicional para ficheiros vazios se max_connections for superior a 1. valor predefinido: 2
timeout	int O parâmetro de tempo limite é expresso em segundos. Este método pode fazer várias chamadas para o serviço do Azure e o tempo limite será aplicado a cada chamada individualmente. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

Tipo	Description
File	Um Ficheiro com propriedades, conteúdos e metadados.

:devolve uma permissão de ficheiro (um SDDL portátil) :rtype str

get_permission_for_share(share_name, file_permission_key, timeout=None)

Parâmetros

Name	Description
share_name Necessário	Nome da partilha.
file_permission_key Necessário	Chave da permissão de ficheiro a obter
timeout	O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Obtém as permissões para a partilha especificada.

get_share_acl(share_name, timeout=None)

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

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

Devolve todos os metadados definidos pelo utilizador para a partilha especificada.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

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

Devolve todos os metadados definidos pelo utilizador e as propriedades do sistema para a partilha especificada. Os dados devolvidos não incluem a lista de ficheiros ou diretórios das partilhas.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

Tipo	Description
Share	Uma Partilha que expõe propriedades e metadados.

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

Tenha em atenção que este valor pode não incluir todos os ficheiros criados recentemente ou redimensionados recentemente.

get_share_stats(share_name, timeout=None)

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

Tipo	Description
int	o tamanho aproximado dos dados armazenados na partilha.

Obtém o tamanho aproximado dos dados armazenados na partilha em bytes.

Tenha em atenção que este valor pode não incluir todos os ficheiros criados recentemente ou redimensionados recentemente.

get_share_stats_in_bytes(share_name, timeout=None)

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

Tipo	Description
int	o tamanho aproximado dos dados armazenados na partilha.

list_directories_and_files

Devolve um gerador para listar os diretórios e ficheiros na partilha especificada. O gerador seguirá lentamente os tokens de continuação devolvidos pelo serviço e parará quando todos os diretórios e ficheiros tiverem sido devolvidos ou num_results for atingido.

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

list_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name	str O caminho para o diretório. valor predefinido: None
num_results	int Especifica o número máximo de ficheiros a devolver, incluindo todos os elementos do diretório. Se o pedido não especificar num_results ou especificar um valor superior a 5000, o servidor devolverá até 5000 itens. Definir num_results para um valor menor ou igual a zero resulta no código de resposta de erro 400 (Pedido Incorreto). valor predefinido: None
marker	str Um token de continuação opaco. Este valor pode ser obtido a partir do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver concluído a enumeração de resultados. Se for especificado, este gerador começará a devolver resultados do ponto em que o gerador anterior parou. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
prefix	str Liste apenas os ficheiros e/ou diretórios com o prefixo especificado. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

list_handles

Devolve um gerador para listar identificadores abertos num diretório ou num ficheiro na partilha especificada. O gerador seguirá preguiçosamente os tokens de continuação devolvidos pelo serviço e parará quando todos os identificadores tiverem sido devolvidos 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name	str O caminho para o diretório. valor predefinido: None
file_name	str Nome do ficheiro existente. valor predefinido: None
recursive	bool Valor booleano que especifica se a operação deve aplicar-se ao diretório especificado no URI, aos respetivos ficheiros, aos respetivos subdiretórios e aos respetivos ficheiros. valor predefinido: None
max_results	int Especifica o número máximo de identificadores utilizados em ficheiros e/ou diretórios a devolver. Se o pedido não especificar max_results ou especificar um valor superior a 5000, o servidor devolverá até 5000 itens. Definir max_results para um valor menor ou igual a zero resulta no código de resposta de erro 400 (Pedido Incorreto). valor predefinido: None
marker	str Um token de continuação opaco. Este valor pode ser obtido a partir do campo next_marker de um objeto gerador anterior se max_results tiver sido especificado e esse gerador tiver concluído a enumeração de resultados. Se for especificado, este gerador começará a devolver resultados do ponto em que o gerador anterior parou. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

list_ranges

Obtém os intervalos válidos de um ficheiro.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
start_range	int Especifica o desvio inicial de bytes sobre os quais pretende listar intervalos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
end_range	int Especifica o desvio final de bytes para listar intervalos. Os parâmetros start_range e end_range são inclusivos. Por exemplo: start_range=0, end_range=511 transferirá os primeiros 512 bytes de ficheiro. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
snapshot	str Uma cadeia que representa a versão do instantâneo, se aplicável. valor predefinido: None

Devoluções

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

list_shares

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

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

list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)

Parâmetros

Name	Description
prefix	str Filtra os resultados para devolver apenas as partilhas cujos nomes começam com o prefixo especificado. valor predefinido: None
num_results	int Especifica o número máximo de partilhas a devolver. valor predefinido: None
include_metadata	bool Especifica que os metadados de partilha são devolvidos na resposta. valor predefinido: False
marker	str Um token de continuação opaco. Este valor pode ser obtido a partir do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver concluído a enumeração de resultados. Se for especificado, este gerador começará a devolver resultados do ponto em que o gerador anterior parou. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None
include_snapshots	bool Especifica que os instantâneos de partilha são devolvidos na resposta. valor predefinido: False

make_file_url

Cria o URL para aceder a um ficheiro.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro.
protocol	str Protocolo a utilizar: "http" ou "https". Se não for especificado, utiliza o protocolo especificado quando FileService foi inicializado. valor predefinido: None
sas_token	str Token de assinatura de acesso partilhado criado com generate_shared_access_signature. valor predefinido: None

Devoluções

Tipo	Description
str	URL de acesso a ficheiros.

resize_file

Redimensiona um ficheiro para o tamanho especificado. Se o valor de byte especificado for menor do que o tamanho atual do ficheiro, todos os intervalos acima do valor de byte especificado serão limpos.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
content_length Necessário	int O comprimento para onde redimensionar o ficheiro.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

set_directory_metadata

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

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
metadata	dict(str, str)<xref:./> Um ditado que contém pares nome-valor para associar ao diretório como metadados. Exemplo: {'category':'test'} valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: 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

Name	Description
share_name Necessário	Nome da partilha
directory_name Necessário	Nome do diretório
file_permission	str Permissão de ficheiro, um SDDL portátil valor predefinido: None
smb_properties	SMBProperties Define as propriedades de ficheiro relacionadas com SMB
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

set_file_metadata

Define os metadados definidos pelo utilizador para o ficheiro especificado como um ou mais pares name-value.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
metadata	dict(str, str) Dict contendo pares de nomes e valores. Cada chamada para esta operação substitui todos os metadados existentes anexados ao ficheiro. Para remover todos os metadados do ficheiro, chame esta operação sem cabeçalhos de metadados. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

set_file_properties

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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
content_settings Necessário	ContentSettings Objeto ContentSettings utilizado para definir as propriedades do ficheiro.
file_permission	str Permissão de ficheiro, um SDDL portátil valor predefinido: None
smb_properties	SMBProperties Define as propriedades de ficheiro relacionadas com SMB
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

set_file_service_properties

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

Name	Description
hour_metrics	<xref:Metrics> As definições de métricas de hora fornecem um resumo das estatísticas de pedido agrupadas pela API em agregados por hora para ficheiros. valor predefinido: None
minute_metrics	<xref:Metrics> As definições de métricas de minutos fornecem estatísticas de pedidos para cada minuto para ficheiros. valor predefinido: None
cors	list(CorsRule) Pode incluir até cinco elementos CorsRule na lista. Se for especificada uma lista vazia, todas as regras CORS serão eliminadas e o CORS será desativado para o serviço. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

set_proxy

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

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

Parâmetros

Name	Description
host Necessário	str Endereço do proxy. Ex: '192.168.0.100'
port Necessário	int Porta do proxy. Ex: 6000
user	str Utilizador para autorização de proxy. valor predefinido: None
password	str Palavra-passe para autorização de proxy. valor predefinido: None

Define as permissões para as políticas de acesso partilhado ou armazenado especificadas que podem ser utilizadas com Assinaturas de Acesso Partilhado.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
signed_identifiers	dict(str, AccessPolicy) Um dicionário de políticas de acesso a associar à partilha. O dicionário pode conter até 5 elementos. Um dicionário vazio limpará as políticas de acesso definidas no serviço. valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Define um ou mais pares nome-valor definidos pelo utilizador para a partilha especificada. Cada chamada para esta operação substitui todos os metadados existentes anexados à partilha. Para remover todos os metadados da partilha, chame esta operação sem dict de metadados.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
metadata	dict(str, str) Um ditado que contém pares nome-valor para associar à partilha como metadados. Exemplo: {'category':'test'} valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Define as propriedades definidas pelo serviço para a partilha especificada.

set_share_properties(share_name, quota, timeout=None)

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
quota Necessário	int Especifica o tamanho máximo da partilha, em gigabytes. Tem de ser maior que 0 e inferior ou igual a 5 TB (5120 GB).
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Cria um instantâneo de uma partilha existente na conta especificada.

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

Parâmetros

Name	Description
share_name Necessário	str O nome da partilha para criar um instantâneo de.
metadata	<xref:<xref:a dict> of <xref:str to str:>> Um ditado com name_value pares para associar à partilha como metadados. Exemplo:{'Categoria':'teste'} valor predefinido: None
quota	int Especifica o tamanho máximo da partilha, em gigabytes. Tem de ser maior que 0 e menor ou igual a 5 TB (5120). valor predefinido: None
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

Devoluções

Tipo	Description
Share	propriedades do instantâneo

update_range

Escreve os bytes especificados pelo corpo do pedido no intervalo especificado.

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

Parâmetros

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
data Necessário	bytes Conteúdo do intervalo.
start_range Necessário	int Início do intervalo de bytes a utilizar para atualizar uma secção do ficheiro. 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 transferirá os primeiros 512 bytes de ficheiro.
end_range Necessário	int Fim do intervalo de bytes a utilizar para atualizar uma secção do ficheiro. 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 transferirá os primeiros 512 bytes de ficheiro.
validate_content	bool Se for verdadeiro, calcula um hash MD5 do conteúdo da página. O serviço de armazenamento compara o hash do conteúdo que chegou ao hash que foi enviado. Isto é essencialmente importante para detetar bitflips no fio se utilizar http em vez de https como https (a predefinição) já irá validar. Tenha em atenção que este hash MD5 não é armazenado com o ficheiro. valor predefinido: False
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: None

update_range_from_file_url

Escreve os bytes de um ponto final de Ficheiro do Azure no intervalo especificado de outro ponto final de Ficheiro 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

Name	Description
share_name Necessário	str Nome da partilha existente.
directory_name Necessário	str O caminho para o diretório.
file_name Necessário	str Nome do ficheiro existente.
start_range Necessário	int Início do intervalo de bytes a utilizar para atualizar uma secção do ficheiro. 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 transferirá os primeiros 512 bytes de ficheiro.
end_range Necessário	int Fim do intervalo de bytes a utilizar para atualizar uma secção do ficheiro. 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 transferirá os primeiros 512 bytes de ficheiro.
source Necessário	str Um URL com até 2 KB de comprimento que especifica um ficheiro ou blob do Azure. O valor deve ser codificado por URL, uma vez que apareceria num URI de pedido. Se a origem estiver noutra conta, a origem tem de ser pública ou tem de ser autenticada através de uma assinatura de acesso partilhado. Se a origem for pública, não é necessária autenticação. Exemplos: https://myaccount.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
source_start_range Necessário	int Início do intervalo de bytes a utilizar para atualizar uma secção do ficheiro. 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 transferirá os primeiros 512 bytes de ficheiro.
timeout	int O parâmetro de tempo limite é expresso em segundos. valor predefinido: 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

Partilhar 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

Devoluções

create_directory

Parâmetros

Devoluções

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

Devoluções

delete_directory

Parâmetros

Devoluções

delete_file

Parâmetros

delete_share

Parâmetros

Devoluções

exists

Parâmetros

Devoluções

extract_date_and_request_id

Parâmetros

generate_account_shared_access_signature

Parâmetros

Devoluções

generate_file_shared_access_signature

Parâmetros

Devoluções

generate_share_shared_access_signature

Parâmetros

Devoluções

get_directory_metadata

Parâmetros

Devoluções

get_directory_properties

Parâmetros

Devoluções

get_file_metadata

Parâmetros

Devoluções

get_file_properties

Parâmetros

Devoluções

get_file_service_properties

Parâmetros

Devoluções

get_file_to_bytes

Parâmetros

Devoluções

get_file_to_path

Parâmetros

Devoluções

get_file_to_stream

Parâmetros

Devoluções

get_file_to_text