FileService Klasa

Protokół bloku komunikatów serwera (SMB) jest obecnie preferowanym protokołem udziału plików używanym lokalnie. Usługa Plików Platformy Microsoft Azure umożliwia klientom korzystanie z dostępności i skalowalności protokołu SMB infrastruktury chmurowej platformy Azure (IaaS) bez konieczności ponownego pisania aplikacji klienckich SMB.

Usługa Plików platformy Azure oferuje również atrakcyjną alternatywę dla tradycyjnych rozwiązań magazynu dołączonego bezpośrednio (DAS) i sieci SAN (Storage Area Network), które często są złożone i kosztowne w przypadku instalowania, konfigurowania i obsługi.

Dziedziczenie
FileService

Konstruktor

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)

Parametry

account_name
str
wartość domyślna: None

Nazwa konta magazynu. Służy to do uwierzytelniania żądań podpisanych przy użyciu klucza konta i konstruowania punktu końcowego magazynu. Jest to wymagane, chyba że zostanie podana parametry połączenia.

account_key
str
wartość domyślna: None

Klucz konta magazynu. Jest to używane do uwierzytelniania za pomocą klucza współużytkowanego.

sas_token
str
wartość domyślna: None

Token sygnatury dostępu współdzielonego używany do uwierzytelniania żądań zamiast klucza konta. Jeśli określono zarówno klucz konta, jak i token sas, klucz konta zostanie użyty do podpisania.

protocol
str
wartość domyślna: https

Protokół do użycia dla żądań. Wartość domyślna to https.

endpoint_suffix
str
wartość domyślna: core.windows.net

Składnik podstawowy hosta adresu URL, minus nazwa konta. Wartość domyślna to Azure (core.windows.net). Przesłoń tę metodę do korzystania z chmury w Chinach (core.chinacloudapi.cn).

request_session
<xref:requests.Session>
wartość domyślna: None

Obiekt sesji do użycia dla żądań HTTP.

connection_string
str
wartość domyślna: None

Jeśli zostanie określony, spowoduje to zastąpienie wszystkich pozostałych parametrów oprócz sesji żądania. Zobaczhttp://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/, aby zapoznać się z formatem parametry połączenia.

socket_timeout
int
wartość domyślna: None

Jeśli zostanie określony, spowoduje to zastąpienie domyślnego limitu czasu gniazda. Określony limit czasu wynosi w sekundach. Aby uzyskać wartość domyślną, zobacz DEFAULT_SOCKET_TIMEOUT w _constants.py.

Zmienne

MAX_SINGLE_GET_SIZE
int

Rozmiar pierwszego zakresu wykonywanego przez metody get_file_to_*, jeśli max_connections jest większy niż 1. Mniej danych zostanie zwróconych, jeśli plik jest mniejszy niż ten.

MAX_CHUNK_GET_SIZE
int

Rozmiar kolejnego zakresu jest wykonywany przez metody get_file_to_*, jeśli max_connections jest większy niż 1, a plik jest większy niż MAX_SINGLE_GET_SIZE. Mniej danych zostanie zwróconych, jeśli pozostała część pliku jest mniejsza niż ta. Jeśli ta wartość jest ustawiona na większą niż 4 MB, content_validation zgłosi błąd, jeśli jest włączona. Jeśli jednak content_validation nie jest pożądane, rozmiar większy niż 4 MB może być optymalny. Ustawienie tego poniżej 4 MB nie jest zalecane.

MAX_RANGE_SIZE
int

Rozmiar zakresów umieszczanych przez metody create_file_from_*. Mniejsze zakresy można umieścić, jeśli nie podano mniejszej ilości danych. Maksymalny rozmiar zakresu obsługiwanego przez usługę to 4 MB.

Metody

abort_copy_file

Przerywa oczekującą operację copy_file i pozostawia plik docelowy o zerowej długości i pełnych metadanych.

clear_range

Czyści określony zakres i zwalnia miejsce używane w magazynie dla tego zakresu.

close_handles

Zwraca generator, aby zamknąć otwarte dojścia w katalogu lub pliku w ramach określonego udziału. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po zamknięciu wszystkich dojść. Wartości zwracane reprezentują liczbę dojść, które zostały zamknięte w każdej transakcji.

copy_file

Kopiuje plik asynchronicznie. Ta operacja zwraca obiekt właściwości operacji kopiowania, w tym identyfikator kopii, którego można użyć do sprawdzenia lub przerwania operacji kopiowania. Usługa plików kopiuje pliki w sposób optymalny.

Jeśli plik docelowy istnieje, zostanie zastąpiony. Nie można zmodyfikować pliku docelowego, gdy operacja kopiowania jest w toku.

create_directory

Tworzy nowy katalog w określonym udziale lub katalogu nadrzędnym. Jeśli katalog o tej samej nazwie już istnieje, operacja kończy się niepowodzeniem w usłudze. Domyślnie wyjątek jest połykany przez klienta. Aby uwidocznić wyjątek, określ wartość True dla fail_on_exists.

create_file

Tworzy nowy plik.

Zobacz create_file_from_* dla funkcji wysokiego poziomu, które obsługują tworzenie i przekazywanie dużych plików z automatycznymi powiadomieniami o fragmentach i postępach.

create_file_from_bytes

Tworzy nowy plik na podstawie tablicy bajtów lub aktualizuje zawartość istniejącego pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie.

create_file_from_path

Tworzy nowy plik platformy Azure na podstawie lokalnej ścieżki pliku lub aktualizuje zawartość istniejącego pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie.

create_file_from_stream

Tworzy nowy plik na podstawie pliku/strumienia lub aktualizuje zawartość istniejącego pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie.

create_file_from_text

Tworzy nowy plik na podstawie ciągu/unicode lub aktualizuje zawartość istniejącego pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie.

create_permission_for_share

Utwórz uprawnienie (deskryptor zabezpieczeń) na poziomie udziału. Tego uprawnienia można użyć dla plików/katalogów w udziale. Jeśli "uprawnienie" już istnieje, zwraca klucz, w przeciwnym razie tworzy nowe uprawnienie na poziomie udziału i zwraca swój klucz.

:zwraca klucz uprawnień pliku :rtype str

create_share

Tworzy nowy udział w ramach określonego konta. Jeśli udział o tej samej nazwie już istnieje, operacja kończy się niepowodzeniem w usłudze. Domyślnie wyjątek jest połykany przez klienta. Aby uwidocznić wyjątek, określ wartość True dla fail_on_exists.

delete_directory

Usuwa określony pusty katalog. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć. Próba usunięcia katalogów, które nie są puste, zakończy się niepowodzeniem.

Jeśli katalog nie istnieje, operacja kończy się niepowodzeniem w usłudze. Domyślnie wyjątek jest połykany przez klienta. Aby uwidocznić wyjątek, określ wartość True dla fail_not_exist.

delete_file

Oznacza określony plik do usunięcia. Plik zostanie później usunięty podczas odzyskiwania pamięci.

delete_share

Oznacza określony udział do usunięcia. Jeśli udział nie istnieje, operacja kończy się niepowodzeniem w usłudze. Domyślnie wyjątek jest połykany przez klienta. Aby uwidocznić wyjątek, określ wartość True dla fail_not_exist.

exists

Zwraca wartość logiczną wskazującą, czy udział istnieje, jeśli podano tylko nazwę udziału. Jeśli directory_name zostanie określona wartość logiczna, zostanie zwrócona informacja o tym, czy katalog istnieje. Jeśli file_name zostanie również określony, zostanie zwrócony wartość logiczna wskazująca, czy plik istnieje.

extract_date_and_request_id
generate_account_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla usługi plików. Użyj zwróconego podpisu z parametrem sas_token usługi FileService.

generate_file_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla pliku. Użyj zwróconego podpisu z parametrem sas_token FileService.

generate_share_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla udziału. Użyj zwróconego podpisu z parametrem sas_token FileService.

get_directory_metadata

Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego katalogu.

get_directory_properties

Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego katalogu. Zwrócone dane nie zawierają listy plików katalogu.

get_file_metadata

Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego pliku.

get_file_properties

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla pliku. Zwraca wystąpienie elementu File z elementem FileProperties i dykt metadanych.

get_file_service_properties

Pobiera właściwości usługi plików konta magazynu, w tym usługę Azure analityka magazynu.

get_file_to_bytes

Pobiera plik jako tablicę bajtów z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie właściwości File , metadanych i zawartości.

get_file_to_path

Pobiera plik do ścieżki pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie pliku z właściwościami i metadanymi.

get_file_to_stream

Pobiera plik do strumienia z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu File z właściwościami i metadanymi.

get_file_to_text

Pobiera plik jako tekst Unicode z automatycznym fragmentowaniem i powiadomieniami o postępie. Zwraca wystąpienie obiektu File z właściwościami, metadanymi i zawartością.

get_permission_for_share

Utwórz uprawnienie (deskryptor zabezpieczeń) na poziomie udziału. Tego uprawnienia można użyć dla plików/katalogów w udziale. Jeśli "uprawnienie" już istnieje, zwraca klucz, w przeciwnym razie tworzy nowe uprawnienie na poziomie udziału i zwraca swój klucz.

:zwraca uprawnienie do pliku (przenośne sdDL) :rtype str

get_share_acl

Pobiera uprawnienia dla określonego udziału.

get_share_metadata

Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego udziału.

get_share_properties

Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego udziału. Zwrócone dane nie zawierają listy udziałów plików ani katalogów.

get_share_stats

Pobiera przybliżony rozmiar danych przechowywanych w udziale zaokrąglony w górę do najbliższego gigabajta.

Pamiętaj, że ta wartość może nie zawierać wszystkich ostatnio utworzonych lub ostatnio ponownie rozmiarów plików.

get_share_stats_in_bytes

Pobiera przybliżony rozmiar danych przechowywanych w udziale w bajtach.

Pamiętaj, że ta wartość może nie zawierać wszystkich ostatnio utworzonych lub ostatnio ponownie rozmiarów plików.

list_directories_and_files

Zwraca generator, aby wyświetlić listę katalogów i plików w określonym udziale. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po powrocie wszystkich katalogów i plików lub osiągnięciu num_results.

Jeśli określono num_results i udział ma więcej niż określoną liczbę plików i katalogów, generator będzie miał wypełnione pole next_marker po zakończeniu. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

list_handles

Zwraca generator, aby wyświetlić listę otwartych dojść w katalogu lub pliku w określonym udziale. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się, gdy wszystkie dojścia zostały zwrócone lub num_results zostanie osiągnięty.

Jeśli określono num_results i udział ma więcej niż określoną liczbę plików i katalogów, generator będzie miał wypełnione pole next_marker po zakończeniu. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

list_ranges

Pobiera prawidłowe zakresy dla pliku.

list_shares

Zwraca generator, aby wyświetlić listę udziałów w ramach określonego konta. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się, gdy wszystkie udziały zostały zwrócone lub num_results zostanie osiągnięty.

Jeśli określono num_results i konto ma więcej niż określoną liczbę udziałów, generator będzie miał wypełnione pole next_marker po jego zakończeniu. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

make_file_url

Tworzy adres URL w celu uzyskania dostępu do pliku.

resize_file

Zmienia rozmiar pliku na określony rozmiar. Jeśli określona wartość bajtu jest mniejsza niż bieżący rozmiar pliku, wszystkie zakresy powyżej określonej wartości bajtu zostaną wyczyszczone.

set_directory_metadata

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego katalogu. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do katalogu. Aby usunąć wszystkie metadane z katalogu, wywołaj tę operację bez dyktowania metadanych.

set_directory_properties
set_file_metadata

Ustawia metadane zdefiniowane przez użytkownika dla określonego pliku jako co najmniej jedną parę name-value.

set_file_properties

Ustawia właściwości systemu w pliku. Jeśli dla content_settings ustawiono jedną właściwość, wszystkie właściwości zostaną zastąpione.

set_file_service_properties

Ustawia właściwości usługi plików konta magazynu, w tym usługę Azure analityka magazynu. Jeśli element (ex HourMetrics) jest pozostawiony jako Brak, istniejące ustawienia w usłudze dla tej funkcji są zachowywane.

set_proxy

Ustawia hosta i port serwera proxy dla tunelowania HTTP CONNECT.

set_share_acl

Ustawia uprawnienia dla określonego udziału lub przechowywanych zasad dostępu, które mogą być używane z sygnaturami dostępu współdzielonego.

set_share_metadata

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego udziału. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do udziału. Aby usunąć wszystkie metadane z udziału, wywołaj tę operację bez dyktowania metadanych.

set_share_properties

Ustawia właściwości zdefiniowane przez usługę dla określonego udziału.

snapshot_share

Tworzy migawkę istniejącego udziału na określonym koncie.

update_range

Zapisuje bajty określone przez treść żądania do określonego zakresu.

update_range_from_file_url

Zapisuje bajty z jednego punktu końcowego usługi Azure File do określonego zakresu innego punktu końcowego usługi Azure File.

abort_copy_file

Przerywa oczekującą operację copy_file i pozostawia plik docelowy o zerowej długości i pełnych metadanych.

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

Parametry

share_name
str
Wymagane

Nazwa udziału docelowego.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa pliku docelowego.

copy_id
str
Wymagane

Skopiuj identyfikator podany w copy.id oryginalnej operacji copy_file.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

clear_range

Czyści określony zakres i zwalnia miejsce używane w magazynie dla tego zakresu.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

start_range
int
Wymagane

Początek zakresu bajtów do użycia do wyczyszczenia sekcji pliku. Zakres może mieć rozmiar do 4 MB. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

end_range
int
Wymagane

Koniec zakresu bajtów do użycia do wyczyszczenia sekcji pliku. Zakres może mieć rozmiar do 4 MB. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

close_handles

Zwraca generator, aby zamknąć otwarte dojścia w katalogu lub pliku w ramach określonego udziału. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po zamknięciu wszystkich dojść. Wartości zwracane reprezentują liczbę dojść, które zostały zamknięte w każdej transakcji.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
wartość domyślna: None

Ścieżka do katalogu.

file_name
str
wartość domyślna: None

Nazwa istniejącego pliku.

recursive
bool
wartość domyślna: None

Wartość logiczna określająca, czy operacja powinna mieć zastosowanie do katalogu określonego w identyfikatorze URI, jego plikach, jego podkatalogach i plikach.

handle_id
str
wartość domyślna: None

Wymagane. Określa identyfikator dojścia otwarty w pliku lub katalogu do zamknięcia. Astrix ('*') to symbol wieloznaczny, który określa wszystkie dojścia.

marker
str
wartość domyślna: None

Nieprzezroczysty token kontynuacji. Tę wartość można pobrać z pola next_marker poprzedniego obiektu generatora, jeśli nie zakończyła zamykania dojść. Jeśli zostanie określony, ten generator rozpocznie zamykanie dojść od punktu, w którym poprzedni generator zatrzymał.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

copy_file

Kopiuje plik asynchronicznie. Ta operacja zwraca obiekt właściwości operacji kopiowania, w tym identyfikator kopii, którego można użyć do sprawdzenia lub przerwania operacji kopiowania. Usługa plików kopiuje pliki w sposób optymalny.

Jeśli plik docelowy istnieje, zostanie zastąpiony. Nie można zmodyfikować pliku docelowego, gdy operacja kopiowania jest w toku.

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

Parametry

share_name
str
Wymagane

Nazwa udziału docelowego. Udział musi istnieć.

directory_name
str
Wymagane

Nazwa katalogu docelowego. Ten katalog musi istnieć.

file_name
str
Wymagane

Nazwa pliku docelowego. Jeśli plik docelowy istnieje, zostanie zastąpiony. W przeciwnym razie zostanie utworzony.

copy_source
str
Wymagane

Adres URL o długości do 2 KB określający plik lub obiekt blob platformy Azure. Wartość powinna być zakodowana w adresie URL, tak jak byłaby wyświetlana w identyfikatorze URI żądania. Jeśli źródło znajduje się na innym koncie, źródło musi być publiczne lub musi być uwierzytelnione za pośrednictwem sygnatury dostępu współdzielonego. Jeśli źródło jest publiczne, nie jest wymagane uwierzytelnianie. Przykłady: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken

metadata
dict(str, str)<xref:./>
wartość domyślna: None

Pary nazwa-wartość skojarzone z plikiem jako metadane. Jeśli nie określono żadnych par nazwa-wartość, operacja skopiuje metadane ze źródłowego obiektu blob lub pliku do pliku docelowego. Jeśli określono co najmniej jedną parę nazwa-wartość, plik docelowy jest tworzony z określonymi metadanymi, a metadane nie są kopiowane ze źródłowego obiektu blob lub pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Właściwości operacji kopiowania, takie jak stan, źródło i identyfikator.

Typ zwracany

create_directory

Tworzy nowy katalog w określonym udziale lub katalogu nadrzędnym. Jeśli katalog o tej samej nazwie już istnieje, operacja kończy się niepowodzeniem w usłudze. Domyślnie wyjątek jest połykany przez klienta. Aby uwidocznić wyjątek, określ wartość True dla 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>)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Nazwa katalogu do utworzenia, w tym ścieżka do katalogu nadrzędnego.

metadata
dict(str, str)<xref::>
wartość domyślna: None

Dykt z name_value parami do skojarzenia z udziałem jako metadanymi. Przykład:{'Category':'test'}

fail_on_exist
bool
wartość domyślna: False

określ, czy zgłaszać wyjątek, gdy katalog istnieje. Wartość false domyślnie.

file_permission
str
wartość domyślna: None

Uprawnienie do pliku, przenośne sdDL

smb_properties
SMBProperties

Ustawia właściwości pliku powiązanego z protokołem SMB

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Wartość True, jeśli katalog został utworzony, fałsz, jeśli katalog już istnieje.

Typ zwracany

create_file

Tworzy nowy plik.

Zobacz create_file_from_* dla funkcji wysokiego poziomu, które obsługują tworzenie i przekazywanie dużych plików z automatycznymi powiadomieniami o fragmentach i postępach.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa pliku do utworzenia lub zaktualizowania.

content_length
int
Wymagane

Długość pliku w bajtach.

content_settings
ContentSettings
wartość domyślna: None

Obiekt ContentSettings używany do ustawiania właściwości pliku.

metadata
dict(str, str)
wartość domyślna: None

Pary nazwa-wartość skojarzone z plikiem jako metadane.

file_permission
str
wartość domyślna: None

Uprawnienie do pliku, przenośne sdDL

smb_properties
SMBProperties

Ustawia właściwości pliku powiązanego z protokołem SMB

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

create_file_from_bytes

Tworzy nowy plik na podstawie tablicy bajtów lub aktualizuje zawartość istniejącego pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa pliku do utworzenia lub zaktualizowania.

file
str
Wymagane

Zawartość pliku jako tablica bajtów.

index
int
wartość domyślna: 0

Rozpocznij indeks w tablicy bajtów.

count
int
wartość domyślna: None

Liczba bajtów do przekazania. Ustaw wartość Brak lub wartość ujemną, aby przekazać wszystkie bajty rozpoczynające się od indeksu.

content_settings
ContentSettings
wartość domyślna: None

Obiekt ContentSettings używany do ustawiania właściwości pliku.

metadata
dict(str, str)
wartość domyślna: None

Pary nazwa-wartość skojarzone z plikiem jako metadane.

validate_content
bool
wartość domyślna: False

Jeśli wartość true, oblicza skrót MD5 dla każdego zakresu pliku. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w pliku .

progress_callback
<xref:func>(<xref:current>, <xref:total>)
wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją podpisu (bieżąca, całkowita), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar jest rozmiarem pliku lub Brak, jeśli całkowity rozmiar jest nieznany.

max_connections
int
wartość domyślna: 2

Maksymalna liczba połączeń równoległych do użycia.

file_permission
str
wartość domyślna: None

Uprawnienie do pliku, przenośne sdDL

smb_properties
SMBProperties

Ustawia właściwości pliku powiązanego z protokołem SMB

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

create_file_from_path

Tworzy nowy plik platformy Azure na podstawie lokalnej ścieżki pliku lub aktualizuje zawartość istniejącego pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie.

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)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa pliku do utworzenia lub zaktualizowania.

local_file_path
str
Wymagane

Ścieżka pliku lokalnego do przekazania jako zawartości pliku.

content_settings
ContentSettings
wartość domyślna: None

Obiekt ContentSettings używany do ustawiania właściwości pliku.

metadata
dict(str, str)
wartość domyślna: None

Pary nazwa-wartość skojarzone z plikiem jako metadane.

validate_content
bool
wartość domyślna: False

Jeśli wartość true, oblicza skrót MD5 dla każdego zakresu pliku. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w pliku .

progress_callback
<xref:func>(<xref:current>, <xref:total>)
wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją podpisu (bieżąca, całkowita), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar jest rozmiarem pliku lub Brak, jeśli całkowity rozmiar jest nieznany.

max_connections
int
wartość domyślna: 2

Maksymalna liczba połączeń równoległych do użycia.

file_permission
str
wartość domyślna: None

Uprawnienie do pliku, przenośne sdDL

smb_properties
SMBProperties

Ustawia właściwości pliku powiązanego z protokołem SMB

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

create_file_from_stream

Tworzy nowy plik na podstawie pliku/strumienia lub aktualizuje zawartość istniejącego pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa pliku do utworzenia lub zaktualizowania.

stream
IOBase
Wymagane

Otwórz plik/strumień, aby przekazać go jako zawartość pliku.

count
int
Wymagane

Liczba bajtów do odczytania ze strumienia. Jest to wymagane. Nie można utworzyć pliku, jeśli liczba jest nieznana.

content_settings
ContentSettings
wartość domyślna: None

Obiekt ContentSettings używany do ustawiania właściwości pliku.

metadata
dict(str, str)
wartość domyślna: None

Pary nazwa-wartość skojarzone z plikiem jako metadane.

validate_content
bool
wartość domyślna: False

Jeśli wartość true, oblicza skrót MD5 dla każdego zakresu pliku. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w pliku .

progress_callback
<xref:func>(<xref:current>, <xref:total>)
wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją podpisu (bieżąca, całkowita), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar jest rozmiarem pliku lub Brak, jeśli całkowity rozmiar jest nieznany.

max_connections
int
wartość domyślna: 2

Maksymalna liczba połączeń równoległych do użycia. Należy pamiętać, że przekazywanie równoległe wymaga wyszukiwania strumienia.

file_permission
str
wartość domyślna: None

Uprawnienie do pliku, przenośne sdDL

smb_properties
SMBProperties

Ustawia właściwości pliku powiązanego z protokołem SMB

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

create_file_from_text

Tworzy nowy plik na podstawie ciągu/unicode lub aktualizuje zawartość istniejącego pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa pliku do utworzenia lub zaktualizowania.

text
str
Wymagane

Tekst do przekazania do pliku.

encoding
str
wartość domyślna: utf-8

Kodowanie języka Python używane do konwertowania tekstu na bajty.

content_settings
ContentSettings
wartość domyślna: None

Obiekt ContentSettings używany do ustawiania właściwości pliku.

metadata
dict(str, str)
wartość domyślna: None

Pary nazwa-wartość skojarzone z plikiem jako metadane.

validate_content
bool
wartość domyślna: False

Jeśli wartość true, oblicza skrót MD5 dla każdego zakresu pliku. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w pliku .

file_permission
str
wartość domyślna: None

Uprawnienie do pliku, przenośne sdDL

smb_properties
SMBProperties

Ustawia właściwości pliku powiązanego z protokołem SMB

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

create_permission_for_share

Utwórz uprawnienie (deskryptor zabezpieczeń) na poziomie udziału. Tego uprawnienia można użyć dla plików/katalogów w udziale. Jeśli "uprawnienie" już istnieje, zwraca klucz, w przeciwnym razie tworzy nowe uprawnienie na poziomie udziału i zwraca swój klucz.

:zwraca klucz uprawnień pliku :rtype str

create_permission_for_share(share_name, file_permission, timeout=None)

Parametry

share_name
Wymagane

Nazwa udziału.

file_permission
Wymagane

Uprawnienie do pliku, przenośne sdDL

timeout
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

create_share

Tworzy nowy udział w ramach określonego konta. Jeśli udział o tej samej nazwie już istnieje, operacja kończy się niepowodzeniem w usłudze. Domyślnie wyjątek jest połykany przez klienta. Aby uwidocznić wyjątek, określ wartość True dla fail_on_exists.

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

Parametry

share_name
str
Wymagane

Nazwa udziału do utworzenia.

metadata
dict(str, str)
wartość domyślna: None

Dykt z name_value parami do skojarzenia z udziałem jako metadanymi. Przykład:{'Category':'test'}

quota
int
wartość domyślna: None

Określa maksymalny rozmiar udziału w gigabajtach. Musi być większa niż 0 i mniejsza lub równa 5 TB (5120).

fail_on_exist
bool
wartość domyślna: False

Określ, czy zgłaszać wyjątek, gdy udział istnieje. Wartość false domyślnie.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Wartość True, jeśli udział został utworzony, wartość False, jeśli udział już istnieje.

Typ zwracany

delete_directory

Usuwa określony pusty katalog. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć. Próba usunięcia katalogów, które nie są puste, zakończy się niepowodzeniem.

Jeśli katalog nie istnieje, operacja kończy się niepowodzeniem w usłudze. Domyślnie wyjątek jest połykany przez klienta. Aby uwidocznić wyjątek, określ wartość True dla fail_not_exist.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Nazwa katalogu do usunięcia, w tym ścieżka do katalogu nadrzędnego.

fail_not_exist
bool
wartość domyślna: False

Określ, czy zgłosić wyjątek, gdy katalog nie istnieje.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Prawda, jeśli katalog został usunięty, w przeciwnym razie fałsz.

Typ zwracany

delete_file

Oznacza określony plik do usunięcia. Plik zostanie później usunięty podczas odzyskiwania pamięci.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

delete_share

Oznacza określony udział do usunięcia. Jeśli udział nie istnieje, operacja kończy się niepowodzeniem w usłudze. Domyślnie wyjątek jest połykany przez klienta. Aby uwidocznić wyjątek, określ wartość True dla fail_not_exist.

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

Parametry

share_name
str
Wymagane

Nazwa udziału do usunięcia.

fail_not_exist
bool
wartość domyślna: False

Określ, czy zgłaszać wyjątek, gdy udział nie istnieje. Domyślnie fałsz.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie. Określ ten argument, aby usunąć tylko określoną migawkę. delete_snapshots musi mieć wartość Brak, jeśli zostanie określona.

delete_snapshots
DeleteSnapshot
wartość domyślna: None

Aby usunąć udział z migawkami, należy określić go jako DeleteSnapshot.Include.

Zwraca

Prawda, jeśli udział został usunięty, udział fałszu nie istnieje.

Typ zwracany

exists

Zwraca wartość logiczną wskazującą, czy udział istnieje, jeśli podano tylko nazwę udziału. Jeśli directory_name zostanie określona wartość logiczna, zostanie zwrócona informacja o tym, czy katalog istnieje. Jeśli file_name zostanie również określony, zostanie zwrócony wartość logiczna wskazująca, czy plik istnieje.

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

Parametry

share_name
str
Wymagane

Nazwa udziału.

directory_name
str
wartość domyślna: None

Ścieżka do katalogu.

file_name
str
wartość domyślna: None

Nazwa pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Wartość logiczna wskazująca, czy zasób istnieje.

Typ zwracany

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parametry

retry_context
Wymagane

generate_account_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla usługi plików. Użyj zwróconego podpisu z parametrem sas_token usługi FileService.

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

Parametry

resource_types
<xref:ResourceTypes>
Wymagane

Określa typy zasobów, które są dostępne dla sygnatury dostępu współdzielonego konta.

permission
<xref:AccountPermissions>
Wymagane

Uprawnienia skojarzone z sygnaturą dostępu współdzielonego. Użytkownik jest ograniczony do operacji dozwolonych przez uprawnienia. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zasadach dostępu przechowywanych.

expiry
datetime lub str
Wymagane

Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zasadach dostępu przechowywanych. Platforma Azure zawsze konwertuje wartości na utc. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start
datetime lub str
wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa. Jeśli pominięto, zakłada się, że godzina rozpoczęcia tego wywołania będzie czasem odebrania żądania przez usługę magazynu. Platforma Azure zawsze konwertuje wartości na utc. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

ip
str
wartość domyślna: None

Określa adres IP lub zakres adresów IP, z których mają być akceptowane żądania. Jeśli adres IP, z którego pochodzi żądanie, nie jest zgodny z adresem IP lub zakresem adresów określonym w tokenie SAS, żądanie nie jest uwierzytelniane. Na przykład określenie sip=168.1.5.65 lub sip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol
str
wartość domyślna: None

Określa protokół dozwolony dla złożonego żądania. Możliwe wartości to zarówno HTTPS, jak i HTTP (https,http) lub TYLKO HTTPS (https). Wartość domyślna to https,http. Należy pamiętać, że tylko protokół HTTP nie jest dozwoloną wartością.

Zwraca

Token sygnatury dostępu współdzielonego (sas).

Typ zwracany

str

generate_file_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla pliku. Użyj zwróconego podpisu z parametrem sas_token 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)

Parametry

share_name
str
Wymagane

Nazwa udziału.

directory_name
str
wartość domyślna: None

Nazwa katalogu. Nie można utworzyć tokenów sygnatury dostępu współdzielonego dla katalogów, dlatego ten parametr powinien być obecny tylko wtedy, gdy podano file_name.

file_name
str
wartość domyślna: None

Nazwa pliku.

permission
FilePermissions
wartość domyślna: None

Uprawnienia skojarzone z sygnaturą dostępu współdzielonego. Użytkownik jest ograniczony do operacji dozwolonych przez uprawnienia. Uprawnienia muszą być uporządkowane do odczytu, tworzenia, zapisu, usuwania, listy. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zasadach dostępu przechowywanych.

expiry
datetime lub str
wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zasadach dostępu przechowywanych. Platforma Azure zawsze konwertuje wartości na utc. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start
datetime lub str
wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa. Jeśli pominięto, zakłada się, że godzina rozpoczęcia tego wywołania będzie czasem odebrania żądania przez usługę magazynu. Platforma Azure zawsze konwertuje wartości na utc. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

id
str
wartość domyślna: None

Unikatowa wartość o długości do 64 znaków, która jest skorelowana z przechowywanymi zasadami dostępu. Aby utworzyć przechowywane zasady dostępu, użyj set_file_service_properties.

ip
str
wartość domyślna: None

Określa adres IP lub zakres adresów IP, z których mają być akceptowane żądania. Jeśli adres IP, z którego pochodzi żądanie, nie jest zgodny z adresem IP lub zakresem adresów określonym w tokenie SAS, żądanie nie jest uwierzytelniane. Na przykład określenie sip=168.1.5.65 lub sip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol
str
wartość domyślna: None

Określa protokół dozwolony dla złożonego żądania. Możliwe wartości to zarówno HTTPS, jak i HTTP (https,http) lub TYLKO HTTPS (https). Wartość domyślna to https,http. Należy pamiętać, że tylko protokół HTTP nie jest dozwoloną wartością.

cache_control
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla Cache-Control, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_disposition
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla usługi Content-Disposition, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_encoding
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla kodowania zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_language
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla języka zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_type
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla typu zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

Zwraca

Token sygnatury dostępu współdzielonego (sas).

Typ zwracany

str

generate_share_shared_access_signature

Generuje sygnaturę dostępu współdzielonego dla udziału. Użyj zwróconego podpisu z parametrem sas_token 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)

Parametry

share_name
str
Wymagane

Nazwa udziału.

permission
SharePermissions
wartość domyślna: None

Uprawnienia skojarzone z sygnaturą dostępu współdzielonego. Użytkownik jest ograniczony do operacji dozwolonych przez uprawnienia. Uprawnienia muszą być uporządkowane do odczytu, tworzenia, zapisu, usuwania, listy. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zasadach dostępu przechowywanych.

expiry
datetime lub str
wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wymagane, chyba że podano identyfikator odwołujące się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zasadach dostępu przechowywanych. Platforma Azure zawsze konwertuje wartości na utc. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start
datetime lub str
wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa. Jeśli pominięto, zakłada się, że godzina rozpoczęcia tego wywołania będzie czasem odebrania żądania przez usługę magazynu. Platforma Azure zawsze konwertuje wartości na utc. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

id
str
wartość domyślna: None

Unikatowa wartość o długości do 64 znaków, która jest skorelowana z przechowywanymi zasadami dostępu. Aby utworzyć przechowywane zasady dostępu, użyj polecenia set_share_acl.

ip
str
wartość domyślna: None

Określa adres IP lub zakres adresów IP, z których mają być akceptowane żądania. Jeśli adres IP, z którego pochodzi żądanie, nie jest zgodny z adresem IP lub zakresem adresów określonym w tokenie SAS, żądanie nie jest uwierzytelniane. Na przykład określenie sip=168.1.5.65 lub sip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol
str
wartość domyślna: None

Określa protokół dozwolony dla złożonego żądania. Możliwe wartości to zarówno HTTPS, jak i HTTP (https,http) lub TYLKO HTTPS (https). Wartość domyślna to https,http. Należy pamiętać, że tylko protokół HTTP nie jest dozwoloną wartością.

cache_control
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla Cache-Control, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_disposition
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla usługi Content-Disposition, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_encoding
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla kodowania zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_language
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla języka zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_type
str
wartość domyślna: None

Wartość nagłówka odpowiedzi dla typu zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

Zwraca

Token sygnatury dostępu współdzielonego (sas).

Typ zwracany

str

get_directory_metadata

Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego katalogu.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Słownik reprezentujący nazwę metadanych katalogu, pary wartości.

Typ zwracany

get_directory_properties

Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego katalogu. Zwrócone dane nie zawierają listy plików katalogu.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do istniejącego katalogu.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

właściwości określonego katalogu w obiekcie katalogu.

Typ zwracany

get_file_metadata

Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego pliku.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Słownik reprezentujący nazwę metadanych pliku, pary wartości.

Typ zwracany

get_file_properties

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla pliku. Zwraca wystąpienie elementu File z elementem FileProperties i dykt metadanych.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

obiekt pliku zawierający właściwości i metadane.

Typ zwracany

get_file_service_properties

Pobiera właściwości usługi plików konta magazynu, w tym usługę Azure analityka magazynu.

get_file_service_properties(timeout=None)

Parametry

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Właściwości usługi plików.

Typ zwracany

get_file_to_bytes

Pobiera plik jako tablicę bajtów z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie właściwości File , metadanych i zawartości.

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)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

start_range
int
wartość domyślna: None

Początek zakresu bajtów do użycia do pobrania sekcji pliku. Jeśli nie zostanie podana żadna end_range, wszystkie bajty po start_range zostaną pobrane. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

end_range
int
wartość domyślna: None

Koniec zakresu bajtów do użycia do pobierania sekcji pliku. W przypadku podania end_range należy podać start_range. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

validate_content
bool
wartość domyślna: False

Jeśli ustawiono wartość true, sprawdza wartość skrótu MD5 dla każdej pobranej części pliku. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https jako https (wartość domyślna) będzie już weryfikowane. Należy pamiętać, że usługa zwróci tylko transakcyjne md5 dla fragmentów 4 MB lub mniej, więc pierwsze żądanie pobierania będzie mieć rozmiar samodzielnie. MAX_CHUNK_GET_SIZE zamiast siebie. MAX_SINGLE_GET_SIZE. Jeśli samodzielnie. MAX_CHUNK_GET_SIZE ustawiono wartość większą niż 4 MB, zostanie zgłoszony błąd. Ponieważ przetwarzanie rozwiązania MD5 zajmuje czas przetwarzania, a konieczne będzie wykonanie większej liczby żądań ze względu na zmniejszony rozmiar fragmentu, może wystąpić pewien wzrost opóźnienia.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją podpisu (bieżąca, całkowita), gdzie bieżąca jest liczba bajtów przeniesionych do tej pory, a łączna jest rozmiarem pliku, jeśli jest znany.

max_connections
int
wartość domyślna: 2

Jeśli ustawiono wartość 2 lub większą, początkowe pobranie zostanie wykonane dla pierwszego siebie. MAX_SINGLE_GET_SIZE bajty pliku. Jeśli jest to cały plik, metoda zwraca się w tym momencie. Jeśli tak nie jest, pobierze pozostałe dane równoległe przy użyciu liczby wątków równych max_connections. Każdy fragment będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE. Jeśli ustawiono wartość 1, zostanie wykonane jedno duże żądanie get. Nie jest to ogólnie zalecane, ale dostępne, jeśli należy używać bardzo kilku wątków, żądania sieciowe są bardzo kosztowne lub strumień niemożliwy do wyszukiwania uniemożliwia równoległe pobieranie. Może to być również cenne, jeśli plik jest współbieżnie modyfikowany w celu wymuszania niepodzielności lub jeśli wiele plików ma być pustych, ponieważ dodatkowe żądanie jest wymagane dla pustych plików, jeśli max_connections jest większa niż 1.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania indywidualnie.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Plik z właściwościami, zawartością i metadanymi.

Typ zwracany

get_file_to_path

Pobiera plik do ścieżki pliku z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie pliku z właściwościami i metadanymi.

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)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

file_path
str
Wymagane

Ścieżka pliku do zapisu.

open_mode
str
wartość domyślna: wb

Tryb do użycia podczas otwierania pliku. Należy pamiętać, że określanie dołączania tylko open_mode uniemożliwia pobieranie równoległe. Dlatego max_connections musi być ustawiona na 1, jeśli jest używana ta open_mode.

start_range
int
wartość domyślna: None

Początek zakresu bajtów do użycia do pobrania sekcji pliku. Jeśli nie zostanie podana żadna end_range, wszystkie bajty po start_range zostaną pobrane. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

end_range
int
wartość domyślna: None

Koniec zakresu bajtów, który ma być używany do pobierania sekcji pliku. W przypadku podania end_range należy podać start_range. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

validate_content
bool
wartość domyślna: False

Jeśli jest ustawiona wartość true, sprawdza poprawność skrótu MD5 dla każdej pobranej części pliku. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że usługa zwróci tylko transakcyjne md5 dla fragmentów 4 MB lub mniej, więc pierwsze żądanie get będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE zamiast siebie. MAX_SINGLE_GET_SIZE. Jeśli samodzielnie. MAX_CHUNK_GET_SIZE został ustawiony na większy niż 4 MB, zostanie zgłoszony błąd. Ponieważ przetwarzanie md5 zajmuje czas przetwarzania, a konieczne będzie wykonanie większej liczby żądań ze względu na zmniejszony rozmiar fragmentu, może wystąpić pewien wzrost opóźnienia.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją podpisu (bieżąca, całkowita), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar pliku, jeśli jest znany.

max_connections
int
wartość domyślna: 2

Jeśli ustawiono wartość 2 lub większą, początkowe polecenie get zostanie wykonane dla pierwszego siebie. MAX_SINGLE_GET_SIZE bajty pliku. Jeśli jest to cały plik, metoda zwraca w tym momencie. Jeśli tak nie jest, pobierze pozostałe dane równoległe przy użyciu liczby wątków równych max_connections. Każdy fragment będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE. W przypadku ustawienia wartości 1 zostanie wykonane pojedyncze duże żądanie get. Nie jest to zwykle zalecane, ale jest dostępne, jeśli należy używać bardzo niewielu wątków, żądania sieciowe są bardzo kosztowne lub strumień nienależący do wyszukiwania uniemożliwia pobieranie równoległe. Może to być również przydatne, jeśli plik jest jednocześnie modyfikowany w celu wymuszania niepodzielności lub jeśli wiele plików ma być pustych, ponieważ dodatkowe żądanie jest wymagane dla pustych plików, jeśli max_connections jest większa niż 1.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Plik z właściwościami i metadanymi.

Typ zwracany

get_file_to_stream

Pobiera plik do strumienia z automatycznymi powiadomieniami o fragmentowaniu i postępie. Zwraca wystąpienie obiektu File z właściwościami i metadanymi.

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)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

stream
IOBase
Wymagane

Otwarty plik/strumień do zapisu.

start_range
int
wartość domyślna: None

Początek zakresu bajtów, który ma być używany do pobierania sekcji pliku. Jeśli nie zostanie podana żadna end_range, wszystkie bajty po start_range zostaną pobrane. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

end_range
int
wartość domyślna: None

Koniec zakresu bajtów, który ma być używany do pobierania sekcji pliku. W przypadku podania end_range należy podać start_range. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

validate_content
bool
wartość domyślna: False

Jeśli jest ustawiona wartość true, sprawdza poprawność skrótu MD5 dla każdej pobranej części pliku. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że usługa zwróci tylko transakcyjne md5 dla fragmentów 4 MB lub mniej, więc pierwsze żądanie get będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE zamiast siebie. MAX_SINGLE_GET_SIZE. Jeśli samodzielnie. MAX_CHUNK_GET_SIZE został ustawiony na większy niż 4 MB, zostanie zgłoszony błąd. Ponieważ przetwarzanie md5 zajmuje czas przetwarzania, a konieczne będzie wykonanie większej liczby żądań ze względu na zmniejszony rozmiar fragmentu, może wystąpić pewien wzrost opóźnienia.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją podpisu (bieżąca, całkowita), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar pliku, jeśli jest znany.

max_connections
int
wartość domyślna: 2

Jeśli ustawiono wartość 2 lub większą, początkowe polecenie get zostanie wykonane dla pierwszego siebie. MAX_SINGLE_GET_SIZE bajty pliku. Jeśli jest to cały plik, metoda zwraca w tym momencie. Jeśli tak nie jest, pobierze pozostałe dane równoległe przy użyciu liczby wątków równych max_connections. Każdy fragment będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE. W przypadku ustawienia wartości 1 zostanie wykonane pojedyncze duże żądanie get. Nie jest to zwykle zalecane, ale jest dostępne, jeśli należy używać bardzo niewielu wątków, żądania sieciowe są bardzo kosztowne lub strumień nienależący do wyszukiwania uniemożliwia pobieranie równoległe. Może to być również przydatne, jeśli plik jest jednocześnie modyfikowany w celu wymuszania niepodzielności lub jeśli wiele plików ma być pustych, ponieważ dodatkowe żądanie jest wymagane dla pustych plików, jeśli max_connections jest większa niż 1.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Plik z właściwościami i metadanymi.

Typ zwracany

get_file_to_text

Pobiera plik jako tekst Unicode z automatycznym fragmentowaniem i powiadomieniami o postępie. Zwraca wystąpienie obiektu File z właściwościami, metadanymi i zawartością.

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)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

encoding
str
wartość domyślna: utf-8

Kodowanie języka Python do użycia podczas dekodowania danych pliku.

start_range
int
wartość domyślna: None

Początek zakresu bajtów, który ma być używany do pobierania sekcji pliku. Jeśli nie zostanie podana żadna end_range, wszystkie bajty po start_range zostaną pobrane. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

end_range
int
wartość domyślna: None

Koniec zakresu bajtów, który ma być używany do pobierania sekcji pliku. W przypadku podania end_range należy podać start_range. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

validate_content
bool
wartość domyślna: False

Jeśli jest ustawiona wartość true, sprawdza poprawność skrótu MD5 dla każdej pobranej części pliku. Jest to przydatne przede wszystkim w przypadku wykrywania bitflips w sieci, jeśli użycie protokołu HTTP zamiast https jako https (ustawienie domyślne) zostanie już zweryfikowane. Należy pamiętać, że usługa zwróci tylko transakcyjne md5 dla fragmentów 4 MB lub mniej, więc pierwsze żądanie get będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE zamiast siebie. MAX_SINGLE_GET_SIZE. Jeśli samodzielnie. MAX_CHUNK_GET_SIZE został ustawiony na większy niż 4 MB, zostanie zgłoszony błąd. Ponieważ przetwarzanie md5 zajmuje czas przetwarzania, a konieczne będzie wykonanie większej liczby żądań ze względu na zmniejszony rozmiar fragmentu, może wystąpić pewien wzrost opóźnienia.

progress_callback
<xref:func>(<xref:current>, <xref:total>)
wartość domyślna: None

Wywołanie zwrotne dla postępu z funkcją podpisu (bieżąca, całkowita), gdzie bieżąca jest liczba bajtów przesłanych do tej pory, a łączny rozmiar pliku, jeśli jest znany.

max_connections
int
wartość domyślna: 2

Jeśli ustawiono wartość 2 lub większą, początkowe polecenie get zostanie wykonane dla pierwszego siebie. MAX_SINGLE_GET_SIZE bajty pliku. Jeśli jest to cały plik, metoda zwraca w tym momencie. Jeśli tak nie jest, pobierze pozostałe dane równoległe przy użyciu liczby wątków równych max_connections. Każdy fragment będzie mieć rozmiar własny. MAX_CHUNK_GET_SIZE. W przypadku ustawienia wartości 1 zostanie wykonane pojedyncze duże żądanie get. Nie jest to zwykle zalecane, ale jest dostępne, jeśli należy używać bardzo niewielu wątków, żądania sieciowe są bardzo kosztowne lub strumień nienależący do wyszukiwania uniemożliwia pobieranie równoległe. Może to być również przydatne, jeśli plik jest jednocześnie modyfikowany w celu wymuszania niepodzielności lub jeśli wiele plików ma być pustych, ponieważ dodatkowe żądanie jest wymagane dla pustych plików, jeśli max_connections jest większa niż 1.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach. Ta metoda może wykonywać wiele wywołań do usługi platformy Azure, a limit czasu będzie stosowany do każdego wywołania osobno.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Plik z właściwościami, zawartością i metadanymi.

Typ zwracany

get_permission_for_share

Utwórz uprawnienie (deskryptor zabezpieczeń) na poziomie udziału. Tego uprawnienia można użyć dla plików/katalogów w udziale. Jeśli "uprawnienie" już istnieje, zwraca klucz, w przeciwnym razie tworzy nowe uprawnienie na poziomie udziału i zwraca swój klucz.

:zwraca uprawnienie do pliku (przenośne sdDL) :rtype str

get_permission_for_share(share_name, file_permission_key, timeout=None)

Parametry

share_name
Wymagane

Nazwa udziału.

file_permission_key
Wymagane

Klucz uprawnienia do pobierania pliku

timeout
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

get_share_acl

Pobiera uprawnienia dla określonego udziału.

get_share_acl(share_name, timeout=None)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

Słownik zasad dostępu skojarzonych z udziałem.

Typ zwracany

get_share_metadata

Zwraca wszystkie metadane zdefiniowane przez użytkownika dla określonego udziału.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Słownik reprezentujący nazwę metadanych udziału, pary wartości.

Typ zwracany

get_share_properties

Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego udziału. Zwrócone dane nie zawierają listy udziałów plików ani katalogów.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

Udział, który uwidacznia właściwości i metadane.

Typ zwracany

get_share_stats

Pobiera przybliżony rozmiar danych przechowywanych w udziale zaokrąglony w górę do najbliższego gigabajta.

Pamiętaj, że ta wartość może nie zawierać wszystkich ostatnio utworzonych lub ostatnio ponownie rozmiarów plików.

get_share_stats(share_name, timeout=None)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

przybliżony rozmiar danych przechowywanych w udziale.

Typ zwracany

int

get_share_stats_in_bytes

Pobiera przybliżony rozmiar danych przechowywanych w udziale w bajtach.

Pamiętaj, że ta wartość może nie zawierać wszystkich ostatnio utworzonych lub ostatnio ponownie rozmiarów plików.

get_share_stats_in_bytes(share_name, timeout=None)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

przybliżony rozmiar danych przechowywanych w udziale.

Typ zwracany

int

list_directories_and_files

Zwraca generator, aby wyświetlić listę katalogów i plików w określonym udziale. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się po powrocie wszystkich katalogów i plików lub osiągnięciu num_results.

Jeśli określono num_results i udział ma więcej niż określoną liczbę plików i katalogów, generator będzie miał wypełnione pole next_marker po zakończeniu. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
wartość domyślna: None

Ścieżka do katalogu.

num_results
int
wartość domyślna: None

Określa maksymalną liczbę plików do zwrócenia, łącznie ze wszystkimi elementami katalogu. Jeśli żądanie nie określi num_results lub określa wartość większą niż 5000, serwer zwróci do 5000 elementów. Ustawienie num_results wartości mniejszej lub równej zero powoduje wyświetlenie kodu odpowiedzi błędu 400 (Nieprawidłowe żądanie).

marker
str
wartość domyślna: None

Nieprzezroczysty token kontynuacji. Tę wartość można pobrać z pola next_marker poprzedniego obiektu generatora, jeśli określono num_results i że generator zakończył wyliczanie wyników. Jeśli zostanie określony, ten generator rozpocznie zwracanie wyników z punktu, w którym poprzedni generator zatrzymał.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

prefix
str
wartość domyślna: None

Wyświetl tylko pliki i/lub katalogi z danym prefiksem.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

list_handles

Zwraca generator, aby wyświetlić listę otwartych dojść w katalogu lub pliku w określonym udziale. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się, gdy wszystkie dojścia zostały zwrócone lub num_results zostanie osiągnięty.

Jeśli określono num_results i udział ma więcej niż określoną liczbę plików i katalogów, generator będzie miał wypełnione pole next_marker po zakończeniu. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
wartość domyślna: None

Ścieżka do katalogu.

file_name
str
wartość domyślna: None

Nazwa istniejącego pliku.

recursive
bool
wartość domyślna: None

Wartość logiczna określająca, czy operacja powinna mieć zastosowanie do katalogu określonego w identyfikatorze URI, jego plikach, jego podkatalogach i plikach.

max_results
int
wartość domyślna: None

Określa maksymalną liczbę dojść pobranych do plików i/lub katalogów do zwrócenia. Jeśli żądanie nie określi max_results lub określa wartość większą niż 5000, serwer zwróci do 5000 elementów. Ustawienie max_results wartości mniejszej lub równej zero powoduje wyświetlenie kodu odpowiedzi błędu 400 (Nieprawidłowe żądanie).

marker
str
wartość domyślna: None

Nieprzezroczysty token kontynuacji. Tę wartość można pobrać z pola next_marker poprzedniego obiektu generatora, jeśli określono max_results i że generator zakończył wyliczanie wyników. Jeśli zostanie określony, ten generator rozpocznie zwracanie wyników z punktu, w którym poprzedni generator zatrzymał.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

list_ranges

Pobiera prawidłowe zakresy dla pliku.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

start_range
int
wartość domyślna: None

Określa przesunięcie początkowe bajtów, których zakresy mają być na liście. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

end_range
int
wartość domyślna: None

Określa przesunięcie końcowe bajtów, których zakresy mają być na liście. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot
str
wartość domyślna: None

Ciąg reprezentujący wersję migawki, jeśli ma to zastosowanie.

Zwraca

lista prawidłowych zakresów

Typ zwracany

<xref:a> list <xref:of> FileRange

list_shares

Zwraca generator, aby wyświetlić listę udziałów w ramach określonego konta. Generator będzie z opóźnieniem śledzić tokeny kontynuacji zwracane przez usługę i zatrzymywać się, gdy wszystkie udziały zostały zwrócone lub num_results zostanie osiągnięty.

Jeśli określono num_results i konto ma więcej niż określoną liczbę udziałów, generator będzie miał wypełnione pole next_marker po jego zakończeniu. Ten znacznik może służyć do utworzenia nowego generatora w razie potrzeby uzyskania większej liczby wyników.

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

Parametry

prefix
str
wartość domyślna: None

Filtruje wyniki tak, aby zwracały tylko udziały, których nazwy zaczynają się od określonego prefiksu.

num_results
int
wartość domyślna: None

Określa maksymalną liczbę udziałów do zwrócenia.

include_metadata
bool
wartość domyślna: False

Określa, że metadane udziału mają być zwracane w odpowiedzi.

marker
str
wartość domyślna: None

Nieprzezroczysty token kontynuacji. Tę wartość można pobrać z pola next_marker poprzedniego obiektu generatora, jeśli określono num_results i że generator zakończył wyliczanie wyników. Jeśli zostanie określony, ten generator rozpocznie zwracanie wyników z punktu, w którym poprzedni generator zatrzymał.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

include_snapshots
bool
wartość domyślna: False

Określa, że migawki udziałów mają być zwracane w odpowiedzi.

make_file_url

Tworzy adres URL w celu uzyskania dostępu do pliku.

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

Parametry

share_name
str
Wymagane

Nazwa udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa pliku.

protocol
str
wartość domyślna: None

Protokół do użycia: "http" lub "https". Jeśli nie zostanie określony, użyj protokołu określonego podczas inicjowania usługi FileService.

sas_token
str
wartość domyślna: None

Token sygnatury dostępu współdzielonego utworzony za pomocą generate_shared_access_signature.

Zwraca

adres URL dostępu do plików.

Typ zwracany

str

resize_file

Zmienia rozmiar pliku na określony rozmiar. Jeśli określona wartość bajtu jest mniejsza niż bieżący rozmiar pliku, wszystkie zakresy powyżej określonej wartości bajtu zostaną wyczyszczone.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

content_length
int
Wymagane

Długość zmiany rozmiaru pliku na .

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

set_directory_metadata

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego katalogu. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do katalogu. Aby usunąć wszystkie metadane z katalogu, wywołaj tę operację bez dyktowania metadanych.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

metadata
dict(str, str)<xref:./>
wartość domyślna: None

Dykt zawierający pary name-value do skojarzenia z katalogiem jako metadane. Przykład: {'category':'test'}

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

set_directory_properties

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

Parametry

share_name
Wymagane

Nazwa udziału

directory_name
Wymagane

Nazwa katalogu

file_permission
str
wartość domyślna: None

Uprawnienie do pliku, przenośne sdDL

smb_properties
SMBProperties

Ustawia właściwości pliku powiązanego z protokołem SMB

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

set_file_metadata

Ustawia metadane zdefiniowane przez użytkownika dla określonego pliku jako co najmniej jedną parę name-value.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

metadata
dict(str, str)
wartość domyślna: None

Dict zawierający pary nazw i wartości. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do pliku. Aby usunąć wszystkie metadane z pliku, wywołaj tę operację bez nagłówków metadanych.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

set_file_properties

Ustawia właściwości systemu w pliku. Jeśli dla content_settings ustawiono jedną właściwość, wszystkie właściwości zostaną zastąpione.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

content_settings
ContentSettings
Wymagane

Obiekt ContentSettings używany do ustawiania właściwości pliku.

file_permission
str
wartość domyślna: None

Uprawnienie do pliku, przenośne sdDL

smb_properties
SMBProperties

Ustawia właściwości pliku powiązanego z protokołem SMB

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

set_file_service_properties

Ustawia właściwości usługi plików konta magazynu, w tym usługę Azure analityka magazynu. Jeśli element (ex HourMetrics) jest pozostawiony jako Brak, istniejące ustawienia w usłudze dla tej funkcji są zachowywane.

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

Parametry

hour_metrics
<xref:Metrics>
wartość domyślna: None

Ustawienia metryk godzin zawierają podsumowanie statystyk żądań pogrupowanych według interfejsu API w godzinowych agregacjach dla plików.

minute_metrics
<xref:Metrics>
wartość domyślna: None

Ustawienia metryk minuty zapewniają statystyki żądań dla każdej minuty dla plików.

cors
list(CorsRule)
wartość domyślna: None

Na liście można uwzględnić maksymalnie pięć elementów CorsRule. Jeśli zostanie określona pusta lista, wszystkie reguły CORS zostaną usunięte, a mechanizm CORS zostanie wyłączony dla usługi.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

set_proxy

Ustawia hosta i port serwera proxy dla tunelowania HTTP CONNECT.

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

Parametry

host
str
Wymagane

Adres serwera proxy. Np. "192.168.0.100"

port
int
Wymagane

Port serwera proxy. Np. 6000

user
str
wartość domyślna: None

Użytkownik na potrzeby autoryzacji serwera proxy.

password
str
wartość domyślna: None

Hasło do autoryzacji serwera proxy.

set_share_acl

Ustawia uprawnienia dla określonego udziału lub przechowywanych zasad dostępu, które mogą być używane z sygnaturami dostępu współdzielonego.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

signed_identifiers
dict(str, AccessPolicy)
wartość domyślna: None

Słownik zasad dostępu do skojarzenia z udziałem. Słownik może zawierać maksymalnie 5 elementów. Pusty słownik wyczyści zasady dostępu ustawione w usłudze.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

set_share_metadata

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego udziału. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do udziału. Aby usunąć wszystkie metadane z udziału, wywołaj tę operację bez dyktowania metadanych.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

metadata
dict(str, str)
wartość domyślna: None

Dykt zawierający pary name-value do skojarzenia z udziałem jako metadanymi. Przykład: {'category':'test'}

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

set_share_properties

Ustawia właściwości zdefiniowane przez usługę dla określonego udziału.

set_share_properties(share_name, quota, timeout=None)

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

quota
int
Wymagane

Określa maksymalny rozmiar udziału w gigabajtach. Musi być większa niż 0 i mniejsza niż lub równa 5 TB (5120 GB).

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

snapshot_share

Tworzy migawkę istniejącego udziału na określonym koncie.

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

Parametry

share_name
str
Wymagane

Nazwa udziału do utworzenia migawki.

metadata
<xref:<xref:a dict> of <xref:str to str:>>
wartość domyślna: None

Dykt z parami name_value do skojarzenia z udziałem jako metadanymi. Przykład:{'Category':'test'}

quota
int
wartość domyślna: None

Określa maksymalny rozmiar udziału w gigabajtach. Musi być większa niż 0 i mniejsza niż lub równa 5 TB (5120).

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Zwraca

właściwości migawki

Typ zwracany

update_range

Zapisuje bajty określone przez treść żądania do określonego zakresu.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

data
bytes
Wymagane

Zawartość zakresu.

start_range
int
Wymagane

Początek zakresu bajtów do użycia do aktualizowania sekcji pliku. Zakres może mieć rozmiar do 4 MB. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

end_range
int
Wymagane

Koniec zakresu bajtów do użycia do aktualizowania sekcji pliku. Zakres może mieć rozmiar do 4 MB. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

validate_content
bool
wartość domyślna: False

Jeśli wartość true, oblicza skrót MD5 zawartości strony. Usługa magazynu sprawdza skrót zawartości, która dotarła do wysłanego skrótu. Jest to przede wszystkim przydatne do wykrywania bitflips w sieci, jeśli używasz protokołu HTTP zamiast https jako https (wartość domyślna) będzie już weryfikowane. Należy pamiętać, że ten skrót MD5 nie jest przechowywany w pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

update_range_from_file_url

Zapisuje bajty z jednego punktu końcowego usługi Azure File do określonego zakresu innego punktu końcowego usługi Azure File.

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

Parametry

share_name
str
Wymagane

Nazwa istniejącego udziału.

directory_name
str
Wymagane

Ścieżka do katalogu.

file_name
str
Wymagane

Nazwa istniejącego pliku.

start_range
int
Wymagane

Początek zakresu bajtów do użycia do aktualizowania sekcji pliku. Zakres może mieć rozmiar do 4 MB. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

end_range
int
Wymagane

Koniec zakresu bajtów do użycia do aktualizowania sekcji pliku. Zakres może mieć rozmiar do 4 MB. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

source
str
Wymagane

Adres URL o długości do 2 KB, który określa plik platformy Azure lub obiekt blob. Wartość powinna być zakodowana w adresie URL, ponieważ jest wyświetlana w identyfikatorze URI żądania. Jeśli źródło znajduje się na innym koncie, źródło musi być publiczne lub musi być uwierzytelnione za pośrednictwem sygnatury dostępu współdzielonego. Jeśli źródło jest publiczne, nie jest wymagane uwierzytelnianie. Przykłady: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken

source_start_range
int
Wymagane

Początek zakresu bajtów do użycia do aktualizowania sekcji pliku. Zakres może mieć rozmiar do 4 MB. Parametry start_range i end_range są inkluzywne. Na przykład: start_range=0, end_range=511 pobierze pierwsze 512 bajtów pliku.

timeout
int
wartość domyślna: None

Parametr limitu czasu jest wyrażony w sekundach.

Atrybuty

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