ShareClient Klasa

  • Odwołanie

Klient korzystający z określonego udziału może jeszcze nie istnieć.

W przypadku operacji związanych z określonym katalogiem lub plikiem w tym udziale klienci dla tych jednostek można również pobrać przy użyciu get_directory_client funkcji i get_file_client .

Aby uzyskać więcej opcjonalnych konfiguracji, kliknij tutaj.

Dziedziczenie
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin
ShareClient

Konstruktor

ShareClient(account_url: str, share_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)

Parametry

account_url
str
Wymagane

Identyfikator URI konta magazynu. Aby utworzyć klienta z pełnym identyfikatorem URI udziału, użyj from_share_url klasymethod.

share_name
str
Wymagane

Nazwa udziału, z którym ma być używana interakcja.

snapshot
str
wartość domyślna: None

Opcjonalna migawka udziału, na której ma działać. Może to być ciąg identyfikatora migawki lub odpowiedź zwrócona z .create_snapshot

credential
wartość domyślna: None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS. Wartość może być ciągiem tokenu SYGNATURy dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z pliku azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z pliku azure.identity. Jeśli identyfikator URI zasobu zawiera już token SAS, zostanie on zignorowany na rzecz jawnego poświadczenia

  • z wyjątkiem przypadku elementu AzureSasCredential, gdzie powodujące konflikt tokeny SYGNATURy dostępu współdzielonego spowodują wywołanie błędu ValueError. Jeśli używasz wystąpienia obiektu AzureNamedKeyCredential, "name" powinien być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.
token_intent
Literal['backup']

Wymagane w przypadku używania tokenuCredential do uwierzytelniania i ignorowania innych form uwierzytelniania. Określa intencję dla wszystkich żądań podczas korzystania z uwierzytelniania TokenCredential . Możliwe wartości:

kopia zapasowa — określa, że żądania są przeznaczone dla operacji typu kopii zapasowej/administratora, co oznacza, że wszystkie listy ACL plików/katalogów są pomijane, a pełne uprawnienia są przyznawane. Użytkownik musi również mieć wymagane uprawnienia RBAC.

allow_trailing_dot
bool

Jeśli wartość true, końcowa kropka nie zostanie przycięta z docelowego identyfikatora URI.

allow_source_trailing_dot
bool

Jeśli wartość true, końcowa kropka nie zostanie przycięta ze źródłowego identyfikatora URI.

api_version
str

Wersja interfejsu API usługi Storage do użycia dla żądań. Wartość domyślna to najnowsza wersja usługi zgodna z bieżącym zestawem SDK. Ustawienie starszej wersji może spowodować zmniejszenie zgodności funkcji.

Nowość w wersji 12.1.0.

secondary_hostname
str

Nazwa hosta pomocniczego punktu końcowego.

max_range_size
int

Maksymalny rozmiar zakresu używany do przekazywania pliku. Wartość domyślna to 4*1024*1024.

Metody

acquire_lease

Żąda nowej dzierżawy.

Jeśli udział nie ma aktywnej dzierżawy, usługa udostępniania tworzy dzierżawę udziału i zwraca nową dzierżawę.

Nowość w wersji 12.5.0.
close

Ta metoda polega na zamknięciu gniazd otwartych przez klienta. Nie trzeba jej używać w przypadku używania z menedżerem kontekstu.
create_directory

Tworzy katalog w udziale i zwraca klienta w celu interakcji z katalogiem.
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.
create_share

Tworzy nowy udział w ramach konta. Jeśli udział o tej samej nazwie już istnieje, operacja zakończy się niepowodzeniem.
create_snapshot

Tworzy migawkę udziału.

Migawka to wersja udziału tylko do odczytu, która jest wykonywana w danym momencie. Można go odczytywać, kopiować lub usuwać, ale nie modyfikować. Migawki umożliwiają tworzenie kopii zapasowej udziału w momencie ich wyświetlania.

Migawka udziału ma taką samą nazwę jak udział podstawowy, z którego wykonywana jest migawka, z dołączona wartość DateTime wskazująca czas, w którym migawka została wykonana.
delete_directory

Oznacza katalog do usunięcia. Katalog zostanie później usunięty podczas odzyskiwania pamięci.
delete_share

Oznacza określony udział do usunięcia. Udział zostanie później usunięty podczas odzyskiwania pamięci.
from_connection_string

Utwórz element ShareClient na podstawie parametrów połączenia.
from_share_url
get_directory_client

Pobierz klienta w celu interakcji z określonym katalogiem. Katalog nie musi już istnieć.
get_file_client

Pobierz klienta, aby wchodzić w interakcję z określonym plikiem. Plik nie musi jeszcze istnieć.
get_permission_for_share

Uzyskiwanie uprawnień (deskryptora zabezpieczeń) dla danego klucza.

Tego uprawnienia można użyć dla plików/katalogów w udziale.
get_share_access_policy

Pobiera uprawnienia dla udziału. Uprawnienia wskazują, czy pliki w udziale mogą być dostępne publicznie.
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 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

Wyświetla listę katalogów i plików w udziale.
set_share_access_policy

Ustawia uprawnienia dla udziału lub przechowywane zasady dostępu, które mogą być używane z sygnaturami dostępu współdzielonego. Uprawnienia wskazują, czy pliki w udziale mogą być dostępne publicznie.
set_share_metadata

Ustawia metadane 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 udziału.

Nowość w wersji 12.4.0.
set_share_quota

Ustawia limit przydziału udziału.

acquire_lease

Żąda nowej dzierżawy.

Jeśli udział nie ma aktywnej dzierżawy, usługa udostępniania tworzy dzierżawę udziału i zwraca nową dzierżawę.

Nowość w wersji 12.5.0.

acquire_lease(**kwargs: Any) -> ShareLeaseClient

Parametry

lease_duration
int

Określa czas trwania dzierżawy, w sekundach lub ujemny (-1) dla dzierżawy, która nigdy nie wygasa. Dzierżawa nieskończenie nieskończona może należeć do zakresu od 15 do 60 sekund. Nie można zmienić czasu trwania dzierżawy przy użyciu odnowienia lub zmiany. Wartość domyślna to -1 (nieskończona dzierżawa).

lease_id
str

Proponowany identyfikator dzierżawy w formacie ciągu identyfikatora GUID. Usługa Share Service zwraca wartość 400 (nieprawidłowe żądanie), jeśli proponowany identyfikator dzierżawy nie ma poprawnego formatu.

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Obiekt ShareLeaseClient.

Typ zwracany

ShareLeaseClient

Przykłady

Uzyskiwanie dzierżawy udziału.


   share.create_directory("mydir")
   lease = share.acquire_lease()
   share.get_share_properties(lease=lease)
   share.delete_share(lease=lease)

close

Ta metoda polega na zamknięciu gniazd otwartych przez klienta. Nie trzeba jej używać w przypadku używania z menedżerem kontekstu.

close()

create_directory

Tworzy katalog w udziale i zwraca klienta w celu interakcji z katalogiem.

create_directory(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

Parametry

directory_name
str
Wymagane

Nazwa katalogu.

metadata

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

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

ShareDirectoryClient

Typ zwracany

ShareDirectoryClient

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.

create_permission_for_share(file_permission: str, **kwargs: Any) -> str

Parametry

file_permission
str
Wymagane

Uprawnienie do pliku, przenośne sdDL

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Klucz uprawnień do pliku

Typ zwracany

str

create_share

Tworzy nowy udział w ramach konta. Jeśli udział o tej samej nazwie już istnieje, operacja zakończy się niepowodzeniem.

create_share(**kwargs: Any) -> Dict[str, Any]

Parametry

metadata
dict(str,str)

Pary name-value skojarzone z udziałem jako metadane.

quota
int

Przydział, który ma zostać przydzielony.

access_tier

Określa warstwę dostępu udziału. Możliwe wartości: "TransactionOptimized", "Hot", "Cool"

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

protocols
str lub ShareProtocols

Protokoły umożliwiające włączenie udziału. W udziale można włączyć tylko jeden protokół.

root_squash
str lub ShareRootSquash

Root squash do ustawienia w udziale. Tylko prawidłowe dla udziałów NFS. Możliwe wartości to: "NoRootSquash", "RootSquash", "AllSquash".

Zwraca

Zaktualizowany przez udział dykt właściwości (Etag i ostatnia modyfikacja).

Typ zwracany

Dict[str, Any]

Przykłady

Tworzy udział plików.


   # Create share with Access Tier set to Hot
   share.create_share(access_tier=ShareAccessTier("Hot"))

create_snapshot

Tworzy migawkę udziału.

Migawka to wersja udziału tylko do odczytu, która jest wykonywana w danym momencie. Można go odczytywać, kopiować lub usuwać, ale nie modyfikować. Migawki umożliwiają tworzenie kopii zapasowej udziału w momencie ich wyświetlania.

Migawka udziału ma taką samą nazwę jak udział podstawowy, z którego wykonywana jest migawka, z dołączona wartość DateTime wskazująca czas, w którym migawka została wykonana.

create_snapshot(**kwargs: Any | None) -> Dict[str, Any]

Parametry

metadata
dict(str,str)

Pary name-value skojarzone z udziałem jako metadane.

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Zaktualizowany dykt właściwości udziału (identyfikator migawki, element Etag i ostatnia modyfikacja).

Typ zwracany

dict[str, Any]

Przykłady

Tworzy migawkę udziału plików.


   share.create_snapshot()

delete_directory

Oznacza katalog do usunięcia. Katalog zostanie później usunięty podczas odzyskiwania pamięci.

delete_directory(directory_name: str, **kwargs: Any) -> None

Parametry

directory_name
str
Wymagane

Nazwa katalogu.

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Typ zwracany

None

delete_share

Oznacza określony udział do usunięcia. Udział zostanie później usunięty podczas odzyskiwania pamięci.

delete_share(delete_snapshots: bool | None = False, **kwargs) -> None

Parametry

delete_snapshots
bool
Wymagane

Wskazuje, czy migawki mają zostać usunięte.

lease

Wymagane, jeśli udział ma aktywną dzierżawę. Wartość może być obiektem ShareLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

Nowość w wersji 12.5.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-08-04".

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Przykłady

Usuwa udział i wszystkie migawki.


   share.delete_share(delete_snapshots=True)

from_connection_string

Utwórz element ShareClient na podstawie parametrów połączenia.

from_connection_string(conn_str: str, share_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametry

conn_str
str
Wymagane

Parametry połączenia z kontem usługi Azure Storage.

share_name
str
Wymagane

Nazwa udziału.

snapshot
str
wartość domyślna: None

Opcjonalna migawka udziału, na której ma działać. Może to być ciąg identyfikatora migawki lub odpowiedź zwrócona z .create_snapshot

credential
wartość domyślna: None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS. Wartość może być ciągiem tokenu SYGNATURy dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z pliku azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z pliku azure.identity. Jeśli identyfikator URI zasobu zawiera już token SAS, zostanie on zignorowany na rzecz jawnego poświadczenia

  • z wyjątkiem przypadku elementu AzureSasCredential, gdzie powodujące konflikt tokeny SYGNATURy dostępu współdzielonego spowodują wywołanie błędu ValueError. Jeśli używasz wystąpienia obiektu AzureNamedKeyCredential, "name" powinien być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.

Zwraca

Klient udostępniania.

Typ zwracany

ShareClient

Przykłady

Pobiera klienta udziału z parametrów połączenia.


   from azure.storage.fileshare import ShareClient
   share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")

from_share_url 

from_share_url(share_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametry

share_url
str
Wymagane

Pełny identyfikator URI udziału.

snapshot
str
wartość domyślna: None

Opcjonalna migawka udziału, na której ma działać. Może to być ciąg identyfikatora migawki lub odpowiedź zwrócona z .create_snapshot

credential
wartość domyślna: None

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS. Wartość może być ciągiem tokenu SYGNATURy dostępu współdzielonego, wystąpieniem klasy AzureSasCredential lub AzureNamedKeyCredential z pliku azure.core.credentials, kluczem dostępu współużytkowanego konta lub wystąpieniem klasy TokenCredentials z pliku azure.identity. Jeśli identyfikator URI zasobu zawiera już token SAS, zostanie on zignorowany na rzecz jawnego poświadczenia

  • z wyjątkiem przypadku elementu AzureSasCredential, gdzie powodujące konflikt tokeny SYGNATURy dostępu współdzielonego spowodują wywołanie błędu ValueError. Jeśli używasz wystąpienia obiektu AzureNamedKeyCredential, "name" powinien być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.

Zwraca

Klient udostępniania.

Typ zwracany

ShareClient

get_directory_client

Pobierz klienta w celu interakcji z określonym katalogiem. Katalog nie musi już istnieć.

get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient

Parametry

directory_path
str
wartość domyślna: None

Ścieżka do określonego katalogu.

Zwraca

Klient katalogu.

Typ zwracany

ShareDirectoryClient

get_file_client

Pobierz klienta, aby wchodzić w interakcję z określonym plikiem. Plik nie musi jeszcze istnieć.

get_file_client(file_path: str) -> ShareFileClient

Parametry

file_path
str
Wymagane

Ścieżka do określonego pliku.

Zwraca

Klient pliku.

Typ zwracany

ShareFileClient

get_permission_for_share

Uzyskiwanie uprawnień (deskryptora zabezpieczeń) dla danego klucza.

Tego uprawnienia można użyć dla plików/katalogów w udziale.

get_permission_for_share(permission_key: str, **kwargs: Any) -> str

Parametry

permission_key
str
Wymagane

Klucz uprawnienia do pobierania pliku

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Uprawnienie do pliku (przenośny plik SDDL)

Typ zwracany

str

get_share_access_policy

Pobiera uprawnienia dla udziału. Uprawnienia wskazują, czy pliki w udziale mogą być dostępne publicznie.

get_share_access_policy(**kwargs: Any) -> Dict[str, Any]

Parametry

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

lease

Wymagane, jeśli udział ma aktywną dzierżawę. Wartość może być obiektem ShareLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

Nowość w wersji 12.5.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-08-04".

Zwraca

Uzyskiwanie dostępu do informacji o zasadach w dyktowaniu.

Typ zwracany

dict[str, Any]

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(**kwargs: Any) -> ShareProperties

Parametry

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

lease

Wymagane, jeśli udział ma aktywną dzierżawę. Wartość może być obiektem ShareLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

Nowość w wersji 12.5.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-08-04".

Zwraca

Właściwości udziału.

Typ zwracany

ShareProperties

Przykłady

Pobiera właściwości udziału.


   properties = share.get_share_properties()

get_share_stats

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(**kwargs: Any) -> int

Parametry

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

lease

Wymagane, jeśli udział ma aktywną dzierżawę. Wartość może być obiektem ShareLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

Nowość w wersji 12.5.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-08-04".

Zwraca

Przybliżony rozmiar danych (w bajtach) przechowywanych w udziale.

Typ zwracany

int

list_directories_and_files

Wyświetla listę katalogów i plików w udziale.

list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]

Parametry

directory_name
str
Wymagane

Nazwa katalogu.

name_starts_with
str
Wymagane

Filtruje wyniki, aby zwracać tylko katalogi, których nazwy zaczynają się od określonego prefiksu.

marker
str
Wymagane

Nieprzezroczysty token kontynuacji. Tę wartość można pobrać z pola next_marker poprzedniego obiektu generatora. Jeśli zostanie określony, ten generator rozpocznie zwracanie wyników od tego momentu.

include
list[str]

Dołącz ten parametr, aby określić co najmniej jeden zestaw danych do uwzględnienia w odpowiedzi. Możliwe wartości str to "timestamps", "Etag", "Attributes", "PermissionKey".

Nowość w wersji 12.6.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-10-02".

include_extended_info
bool

Jeśli ta wartość ma wartość true, identyfikator pliku zostanie zwrócony w wynikach listy.

Nowość w wersji 12.6.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-10-02".

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

Zwraca

Automatyczne stronicowanie iterowalne z dyktowaniem DirectoryProperties i FileProperties

Typ zwracany

Iterable[Dict[str,str]]

Przykłady

Wyświetlanie listy katalogów i plików w udziale.


   # Create a directory in the share
   dir_client = share.create_directory("mydir")

   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source_file:
       dir_client.upload_file(file_name="sample", data=source_file)

   # List files in the directory
   my_files = list(share.list_directories_and_files(directory_name="mydir"))
   print(my_files)

set_share_access_policy

Ustawia uprawnienia dla udziału lub przechowywane zasady dostępu, które mogą być używane z sygnaturami dostępu współdzielonego. Uprawnienia wskazują, czy pliki w udziale mogą być dostępne publicznie.

set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]

Parametry

signed_identifiers
dict(str, AccessPolicy)
Wymagane

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

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

lease

Wymagane, jeśli udział ma aktywną dzierżawę. Wartość może być obiektem ShareLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

Nowość w wersji 12.5.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-08-04".

Zwraca

Zaktualizowany przez udział dykt właściwości (Etag i ostatnia modyfikacja).

Typ zwracany

dict(str, Any)

set_share_metadata

Ustawia metadane 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(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parametry

metadata
dict(str, str)
Wymagane

Pary name-value skojarzone z udziałem jako metadane.

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

lease

Wymagane, jeśli udział ma aktywną dzierżawę. Wartość może być obiektem ShareLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

Nowość w wersji 12.5.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-08-04".

Zwraca

Zaktualizowany przez udział dykt właściwości (Etag i ostatnia modyfikacja).

Typ zwracany

dict(str, Any)

Przykłady

Ustawia metadane udziału.


   data = {'category': 'test'}
   share.set_share_metadata(metadata=data)

set_share_properties

Ustawia właściwości udziału.

Nowość w wersji 12.4.0.

set_share_properties(**kwargs: Any) -> Dict[str, Any]

Parametry

access_tier
str lub <xref:azure.storage.fileshare.models.ShareAccessTier>

Określa warstwę dostępu udziału. Możliwe wartości: "TransactionOptimized", "Hot" i "Cool"

quota
int

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

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

root_squash
str lub ShareRootSquash

Root squash do ustawienia w udziale. Tylko prawidłowe dla udziałów NFS. Możliwe wartości to: "NoRootSquash", "RootSquash", "AllSquash".

lease

Wymagane, jeśli udział ma aktywną dzierżawę. Wartość może być obiektem ShareLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

Zwraca

Zaktualizowany przez udział dykt właściwości (Etag i ostatnia modyfikacja).

Typ zwracany

dict(str, Any)

Przykłady

Ustawia właściwości udziału.


   # Set the tier for the first share to Hot
   share1.set_share_properties(access_tier="Hot")
   # Set the quota for the first share to 3
   share1.set_share_properties(quota=3)
   # Set the tier for the second share to Cool and quota to 2
   share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)

   # Get the shares' properties
   print(share1.get_share_properties().access_tier)
   print(share1.get_share_properties().quota)
   print(share2.get_share_properties().access_tier)
   print(share2.get_share_properties().quota)

set_share_quota

Ustawia limit przydziału udziału.

set_share_quota(quota: int, **kwargs: Any) -> Dict[str, Any]

Parametry

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.

timeout
int

Ustawia limit czasu po stronie serwera dla operacji w sekundach. Aby uzyskać więcej informacji, zobacz https://video2.skills-academy.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Ta wartość nie jest śledzona ani weryfikowana na kliencie. Aby skonfigurować limity czasu sieci po stronie klienta, zobacz tutaj.

lease

Wymagane, jeśli udział ma aktywną dzierżawę. Wartość może być obiektem ShareLeaseClient lub identyfikatorem dzierżawy jako ciągiem.

Nowość w wersji 12.5.0.

Ten argument słowa kluczowego został wprowadzony w interfejsie API w wersji "2020-08-04".

Zwraca

Zaktualizowany przez udział dykt właściwości (Etag i ostatnia modyfikacja).

Typ zwracany

dict(str, Any)

Przykłady

Ustawia limit przydziału udziału.


   # Set the quota for the share to 1GB
   share.set_share_quota(quota=1)

Atrybuty

api_version

Wersja interfejsu API usługi Storage używana na potrzeby żądań.

location_mode

Tryb lokalizacji, z którego obecnie korzysta klient.

Domyślnie będzie to "podstawowe". Opcje obejmują "podstawowe" i "pomocnicze".

primary_endpoint

Pełny podstawowy adres URL punktu końcowego.

primary_hostname

Nazwa hosta podstawowego punktu końcowego.

secondary_endpoint

Pełny adres URL pomocniczego punktu końcowego, jeśli został skonfigurowany.

Jeśli parametr ValueError nie będzie dostępny, zostanie zgłoszony błąd. Aby jawnie określić pomocniczą nazwę hosta, użyj opcjonalnego argumentu słowa kluczowego secondary_hostname podczas tworzenia wystąpienia.

Wyjątki

ValueError

secondary_hostname

Nazwa hosta pomocniczego punktu końcowego.

Jeśli ta opcja nie będzie dostępna, będzie to brak. Aby jawnie określić pomocniczą nazwę hosta, użyj opcjonalnego argumentu słowa kluczowego secondary_hostname podczas tworzenia wystąpienia.

url

Pełny adres URL punktu końcowego do tej jednostki, w tym token SAS, jeśli jest używany.

Może to być podstawowy punkt końcowy lub pomocniczy punkt końcowy w zależności od bieżącego location_mode. :returns: pełny adres URL punktu końcowego do tej jednostki, w tym token SAS, jeśli jest używany. :rtype: str