azure.storage.filedatalake.DataLakeDirectoryClient class

Żąda nowej dzierżawy. Jeśli plik lub katalog nie ma aktywnej dzierżawy, usługa DataLake tworzy dzierżawę pliku/katalogu i zwraca nowy identyfikator dzierżawy.

acquire_lease(lease_duration: int | None = -1, lease_id: str | None = None, **kwargs) -> DataLakeLeaseClient

Parametry

lease_duration: int

Wymagane

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

Wymagane

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

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

timeout: int

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

Zwraca

Obiekt DataLakeLeaseClient, który można uruchomić w menedżerze kontekstu.

Typ zwracany

DataLakeLeaseClient

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

close() -> None

Utwórz nowy katalog.

create_directory(metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Parametry

metadata: dict(str, str)

Wymagane

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

content_settings: ContentSettings

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

lease: DataLakeLeaseClient lub str

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

umask: str

Opcjonalne i prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Podczas tworzenia pliku lub katalogu i folder nadrzędny nie ma domyślnej listy ACL, maska umask ogranicza uprawnienia pliku lub katalogu do utworzenia. Wynikowe uprawnienie jest podane przez p & ^u, gdzie p jest uprawnieniem i jest maską umask. Jeśli na przykład wartość p to 0777 i wartość 0057, wynikowe uprawnienie to 0720. Domyślne uprawnienie to 0777 dla katalogu i 0666 dla pliku. Domyślna maska umask to 0027. Maska umask musi być określona w 4-cyfrowej notacji ósemkowej (np. 0766).

owner: str

Właściciel pliku lub katalogu.

group: str

Grupa będąca właścicielem pliku lub katalogu.

acl: str

Ustawia prawa kontroli dostępu POSIX dla plików i katalogów. Wartość jest rozdzielaną przecinkami listą wpisów kontroli dostępu. Każdy wpis kontroli dostępu (ACE) składa się z zakresu, typu, identyfikatora użytkownika lub grupy i uprawnień w formacie "[scope:][type]:[id]:[permissions]".

lease_id: str

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

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.

permissions: str

Opcjonalne i prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Ustawia uprawnienia dostępu POSIX dla właściciela pliku, grupy właścicieli plików i innych. Każda klasa może mieć uprawnienie do odczytu, zapisu lub wykonywania. Bit sticky jest również obsługiwany. Obsługiwane są notacje symboliczne (rwxrw-rw-) i 4-cyfrowe notacje ósemkowej (np. 0766).

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

cpk: CustomerProvidedEncryptionKey

Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS.

timeout: int

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

Zwraca

Słownik nagłówków odpowiedzi.

Typ zwracany

Dict[str, Union[str, datetime]]

Przykłady

Utwórz katalog.


   directory_client.create_directory()

Utwórz nowy plik i zwróć klienta pliku do interakcji.

create_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient

Parametry

file: str lub FileProperties

Wymagane

Plik, z którym należy korzystać. Może to być nazwa pliku lub wystąpienie właściwości FileProperties.

content_settings: ContentSettings

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

metadata

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

lease: DataLakeLeaseClient lub str

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

umask: str

Opcjonalne i prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Podczas tworzenia pliku lub katalogu i folder nadrzędny nie ma domyślnej listy ACL, maska umask ogranicza uprawnienia pliku lub katalogu do utworzenia. Wynikowe uprawnienie jest podane przez p & ^u, gdzie p jest uprawnieniem i jest maską umask. Jeśli na przykład wartość p to 0777 i wartość 0057, wynikowe uprawnienie to 0720. Domyślne uprawnienie to 0777 dla katalogu i 0666 dla pliku. Domyślna maska umask to 0027. Maska umask musi być określona w 4-cyfrowej notacji ósemkowej (np. 0766).

owner: str

Właściciel pliku lub katalogu.

group: str

Grupa będąca właścicielem pliku lub katalogu.

acl: str

Ustawia prawa kontroli dostępu POSIX dla plików i katalogów. Wartość jest rozdzielaną przecinkami listą wpisów kontroli dostępu. Każdy wpis kontroli dostępu (ACE) składa się z zakresu, typu, identyfikatora użytkownika lub grupy i uprawnień w formacie "[scope:][type]:[id]:[permissions]".

lease_id: str

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

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.

expires_on: datetime lub int

Czas ustawiania pliku na wygaśnięcie. Jeśli typ expires_on jest int, czas wygaśnięcia zostanie ustawiony jako liczba milisekund upłynął od czasu utworzenia. Jeśli typ expires_on to data/godzina, godzina wygaśnięcia zostanie ustawiona bezwzględnie na podaną godzinę. Jeśli nie podano informacji o strefie czasowej, zostanie to zinterpretowane jako UTC.

permissions: str

Opcjonalne i prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Ustawia uprawnienia dostępu POSIX dla właściciela pliku, grupy właścicieli plików i innych. Każda klasa może mieć uprawnienie do odczytu, zapisu lub wykonywania. Bit sticky jest również obsługiwany. Obsługiwane są notacje symboliczne (rwxrw-rw-) i 4-cyfrowe notacje ósemkowej (np. 0766).

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

cpk: CustomerProvidedEncryptionKey

Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS.

timeout: int

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

Zwraca

DataLakeFileClient

Utwórz podkatalog i zwróć klienta podkatalogu do interakcji.

create_sub_directory(sub_directory: DirectoryProperties | str, metadata: Dict[str, str] | None = None, **kwargs) -> DataLakeDirectoryClient

Parametry

sub_directory: str lub DirectoryProperties

Wymagane

Katalog, z którym należy korzystać. Może to być nazwa katalogu lub wystąpienie właściwości DirectoryProperties.

metadata: dict(str, str)

Wymagane

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

content_settings: ContentSettings

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

lease: DataLakeLeaseClient lub str

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

umask: str

Opcjonalne i prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Podczas tworzenia pliku lub katalogu i folder nadrzędny nie ma domyślnej listy ACL, maska umask ogranicza uprawnienia pliku lub katalogu do utworzenia. Wynikowe uprawnienie jest podane przez p & ^u, gdzie p jest uprawnieniem i jest maską umask. Jeśli na przykład wartość p to 0777 i wartość 0057, wynikowe uprawnienie to 0720. Domyślne uprawnienie to 0777 dla katalogu i 0666 dla pliku. Domyślna maska umask to 0027. Maska umask musi być określona w 4-cyfrowej notacji ósemkowej (np. 0766).

owner: str

Właściciel pliku lub katalogu.

group: str

Grupa będąca właścicielem pliku lub katalogu.

acl: str

Ustawia prawa kontroli dostępu POSIX dla plików i katalogów. Wartość jest rozdzielaną przecinkami listą wpisów kontroli dostępu. Każdy wpis kontroli dostępu (ACE) składa się z zakresu, typu, identyfikatora użytkownika lub grupy i uprawnień w formacie "[scope:][type]:[id]:[permissions]".

lease_id: str

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

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.

permissions: str

Opcjonalne i prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Ustawia uprawnienia dostępu POSIX dla właściciela pliku, grupy właścicieli plików i innych. Każda klasa może mieć uprawnienie do odczytu, zapisu lub wykonywania. Bit sticky jest również obsługiwany. Obsługiwane są notacje symboliczne (rwxrw-rw-) i 4-cyfrowe notacje ósemkowej (np. 0766).

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

cpk: CustomerProvidedEncryptionKey

Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS.

timeout: int

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

Zwraca

DataLakeDirectoryClient dla podkatalogu.

Oznacza określony katalog do usunięcia.

delete_directory(**kwargs) -> None

Parametry

lease: DataLakeLeaseClient lub str

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

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

timeout: int

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

Zwraca

Brak

Przykłady

Usuń katalog.


   new_directory.delete_directory()

Oznacza określony podkatalog do usunięcia.

delete_sub_directory(sub_directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Parametry

sub_directory: str lub DirectoryProperties

Wymagane

Katalog, z którym należy korzystać. Może to być nazwa katalogu lub wystąpienie właściwości DirectoryProperties.

lease: DataLakeLeaseClient lub str

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

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

timeout: int

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

Zwraca

DataLakeDirectoryClient dla podkatalogu

Zwraca wartość True, jeśli istnieje katalog i zwraca wartość False w przeciwnym razie.

exists(**kwargs: Any) -> bool

Parametry

timeout: int

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

Zwraca

Wartość True, jeśli istnieje katalog, w przeciwnym razie wartość False.

Typ zwracany

bool

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

from_connection_string(conn_str: str, file_system_name: str, directory_name: str, 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.

file_system_name: str

Wymagane

Nazwa systemu plików do interakcji.

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.

directory_name: str

Wymagane

Nazwa katalogu do interakcji. Katalog znajduje się w systemie plików.

credential

Wymagane

Poświadczenia, za pomocą których należy się uwierzytelniać. Jest to opcjonalne, jeśli adres URL konta ma już token SAS lub parametry połączenia mają już wartości klucza dostępu współdzielonego. 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. Poświadczenia podane w tym miejscu będą miały pierwszeństwo przed tymi w parametrach połączenia. Jeśli używasz wystąpienia obiektu AzureNamedKeyCredential, "name" powinien być nazwą konta magazynu, a "klucz" powinien być kluczem konta magazynu.

Zwraca

a DataLakeDirectoryClient

Typ zwracany

DataLakeDirectoryClient

get_access_control(upn: bool | None = None, **kwargs) -> Dict[str, Any]

Parametry

upn: bool

Wymagane

Opcjonalny. Prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Jeśli wartość "true", wartości tożsamości użytkownika zwrócone w nagłówkach odpowiedzi x-ms-owner, x-ms-group i x-ms-acl zostaną przekształcone z identyfikatorów obiektów usługi Azure Active Directory na główne nazwy użytkowników. Jeśli wartość "false", wartości zostaną zwrócone jako identyfikatory obiektów usługi Azure Active Directory. Wartość domyślna to false. Należy pamiętać, że identyfikatory obiektów grup i aplikacji nie są tłumaczone, ponieważ nie mają unikatowych przyjaznych nazw.

lease: DataLakeLeaseClient lub str

Wymagane, jeśli plik/katalog ma aktywną dzierżawę. Wartość może być obiektem LeaseClient lub identyfikatorem dzierżawy jako ciągiem.

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

timeout: int

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

response dict

dykt odpowiedzi.

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla katalogu. Nie zwraca zawartości katalogu.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

Parametry

lease: DataLakeLeaseClient lub str

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

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

cpk: CustomerProvidedEncryptionKey

Odszyfrowuje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS. Wymagane, jeśli katalog został utworzony przy użyciu klucza dostarczonego przez klienta.

timeout: int

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

Typ zwracany

DirectoryProperties

Przykłady

Pobieranie właściwości pliku/katalogu.


   props = new_directory.get_directory_properties()

Pobierz klienta do interakcji z określonym plikiem.

Plik nie musi jeszcze istnieć.

get_file_client(file: FileProperties | str) -> DataLakeFileClient

Parametry

file: str lub FileProperties

Wymagane

Plik, z którym należy wchodzić w interakcję. Może to być nazwa pliku lub wystąpienie właściwości FileProperties. Np. katalog/podkatalog/plik

Zwraca

Element DataLakeFileClient.

Typ zwracany

DataLakeFileClient

Pobierz klienta do interakcji z określonym podkatalogem bieżącego katalogu.

Podkatalog nie musi jeszcze istnieć.

get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Parametry

sub_directory: str lub DirectoryProperties

Wymagane

Katalog, z którym należy korzystać. Może to być nazwa katalogu lub wystąpienie właściwości DirectoryProperties.

Zwraca

Element DataLakeDirectoryClient.

Typ zwracany

DataLakeDirectoryClient

Usuwa Access Control na ścieżce i ścieżkach podrzędnych.

remove_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parametry

acl: str

Wymagane

Usuwa prawa kontroli dostępu POSIX w plikach i katalogach. Wartość jest rozdzielaną przecinkami listą wpisów kontroli dostępu. Każdy wpis kontroli dostępu (ACE) składa się z zakresu, typu i identyfikatora użytkownika lub grupy w formacie "[scope:][type]::[id]".

progress_hook: <xref:func>(AccessControlChanges)

Wywołanie zwrotne, w którym obiekt wywołujący może śledzić postęp operacji, a także zbierać ścieżki, które nie mogły ulec zmianie Access Control.

continuation_token: str

Opcjonalny token kontynuacji, którego można użyć do wznowienia wcześniej zatrzymanych operacji.

batch_size: int

Opcjonalny. Jeśli rozmiar zestawu danych przekracza rozmiar partii, operacja zostanie podzielona na wiele żądań, aby można było śledzić postęp. Rozmiar partii powinien wynosić od 1 do 2000. Wartość domyślna, gdy nieokreślone jest 2000.

max_batches: int

Opcjonalny. Definiuje maksymalną liczbę partii, które można wykonać podczas jednej zmiany Access Control operacji. Jeśli wartość maksymalna zostanie osiągnięta przed przetworzeniem wszystkich ścieżek podrzędnych, token kontynuacji może służyć do wznowienia operacji. Pusta wartość wskazuje, że maksymalna liczba partii w niezwiązanych i operacja trwa do końca.

continue_on_failure: bool

Jeśli ustawiono wartość Fałsz, operacja zakończy się szybko po napotkaniu błędów użytkownika (4XX). Jeśli prawda, operacja będzie ignorować błędy użytkownika i kontynuować operację na innych podrzędnych jednostkach katalogu. Token kontynuacji zostanie zwrócony tylko wtedy, gdy continue_on_failure ma wartość True w przypadku błędów użytkownika. Jeśli nie zostanie ustawiona wartość domyślna to Fałsz.

timeout: int

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

Zwraca

Podsumowanie operacji cyklicznych, w tym liczbę sukcesów i niepowodzeń, a także token kontynuacji w przypadku przedwczesnego zakończenia operacji.

Typ zwracany

AccessControlChangeResult

Wyjątki

AzureError

Użytkownik może ponownie uruchomić operację przy użyciu pola continuation_token azureError, jeśli token jest dostępny.

Zmień nazwę katalogu źródłowego.

rename_directory(new_name: str, **kwargs: Any) -> DataLakeDirectoryClient

Parametry

new_name: str

Wymagane

nowa nazwa katalogu, do którego użytkownik chce zmienić nazwę. Wartość musi mieć następujący format: "{filesystem}/{directory}/{subdirectory}".

source_lease: DataLakeLeaseClient lub str

Identyfikator dzierżawy ścieżki źródłowej. Jeśli zostanie określona, ścieżka źródłowa musi mieć aktywną dzierżawę, a identyfikator dzierżawy musi być zgodny.

lease: DataLakeLeaseClient lub str

Wymagane, jeśli plik/katalog ma aktywną dzierżawę. Wartość może być obiektem LeaseClient lub identyfikatorem dzierżawy jako ciągiem.

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

source_if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

source_if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC będzie mieć wartość UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

source_etag: str

Źródłowa wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

source_match_condition: MatchConditions

Warunek dopasowania źródła do użycia w tagu etag.

timeout: int

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

Zwraca

DataLakeDirectoryClient

Przykłady

Zmień nazwę katalogu źródłowego.


   new_dir_name = "testdir2"
   print("Renaming the directory named '{}' to '{}'.".format(dir_name, new_dir_name))
   new_directory = directory_client\
       .rename_directory(new_name=directory_client.file_system_name + '/' + new_dir_name)

Ustaw właściciela, grupę, uprawnienia lub listę kontroli dostępu dla ścieżki.

set_access_control(owner: str | None = None, group: str | None = None, permissions: str | None = None, acl: str | None = None, **kwargs) -> Dict[str, str | datetime]

Parametry

owner: str

Wymagane

Opcjonalny. Właściciel pliku lub katalogu.

group: str

Wymagane

Opcjonalny. Grupa będąca właścicielem pliku lub katalogu.

permissions: str

Wymagane

Opcjonalne i prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Ustawia uprawnienia dostępu POSIX dla właściciela pliku, grupy właścicieli plików i innych. Każda klasa może mieć uprawnienie do odczytu, zapisu lub wykonywania. Bit sticky jest również obsługiwany. Obsługiwane są notacje symboliczne (rwxrw-rw-) i 4-cyfrowe notacje ósemkowej (np. 0766). uprawnienia i listy acl wykluczają się wzajemnie.

acl: str

Wymagane

Ustawia prawa kontroli dostępu POSIX dla plików i katalogów. Wartość jest rozdzielaną przecinkami listą wpisów kontroli dostępu. Każdy wpis kontroli dostępu (ACE) składa się z zakresu, typu, identyfikatora użytkownika lub grupy i uprawnień w formacie "[scope:][type]:[id]:[permissions]". uprawnienia i listy acl wykluczają się wzajemnie.

lease: DataLakeLeaseClient lub str

Wymagane, jeśli plik/katalog ma aktywną dzierżawę. Wartość może być obiektem LeaseClient lub identyfikatorem dzierżawy jako ciągiem.

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

timeout: int

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

response dict

dict odpowiedzi (Etag i ostatnia modyfikacja).

Ustawia Access Control na ścieżce i ścieżkach podrzędnych.

set_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parametry

acl: str

Wymagane

Ustawia prawa kontroli dostępu POSIX dla plików i katalogów. Wartość jest rozdzielaną przecinkami listą wpisów kontroli dostępu. Każdy wpis kontroli dostępu (ACE) składa się z zakresu, typu, identyfikatora użytkownika lub grupy i uprawnień w formacie "[scope:][type]:[id]:[permissions]".

progress_hook: <xref:func>(AccessControlChanges)

Wywołanie zwrotne, w którym obiekt wywołujący może śledzić postęp operacji, a także zbierać ścieżki, których nie można zmienić Access Control.

continuation_token: str

Opcjonalny token kontynuacji, którego można użyć do wznowienia wcześniej zatrzymanych operacji.

batch_size: int

Opcjonalny. Jeśli rozmiar zestawu danych przekracza rozmiar partii, operacja zostanie podzielona na wiele żądań, aby można było śledzić postęp. Rozmiar partii powinien należeć do zakresu od 1 do 2000. Wartość domyślna, gdy nieokreślone jest 2000.

max_batches: int

Opcjonalny. Definiuje maksymalną liczbę partii, które mogą wykonywać pojedyncza zmiana Access Control operacji. Jeśli wartość maksymalna zostanie osiągnięta przed przetworzeniem wszystkich ścieżek podrzędnych, można użyć tokenu kontynuacji do wznowienia operacji. Pusta wartość wskazuje, że maksymalna liczba partii w niepowiązanych operacjach jest kontynuowana do końca.

continue_on_failure: bool

W przypadku ustawienia wartości Fałsz operacja zakończy się szybko po napotkaniu błędów użytkownika (4XX). Jeśli wartość True, operacja zignoruje błędy użytkownika i przejdzie do operacji na innych podrzędnych jednostkach katalogu. Token kontynuacji zostanie zwrócony tylko wtedy, gdy continue_on_failure ma wartość True w przypadku błędów użytkownika. Jeśli nie zostanie ustawiona wartość domyślna to Fałsz.

timeout: int

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

Zwraca

Podsumowanie operacji cyklicznych, w tym liczbę sukcesów i niepowodzeń, a także token kontynuacji na wypadek przedwczesnego zakończenia operacji.

Typ zwracany

AccessControlChangeResult

Wyjątki

AzureError

Użytkownik może ponownie uruchomić operację przy użyciu pola continuation_token AzureError, jeśli token jest dostępny.

Ustawia właściwości systemowe w pliku lub katalogu.

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

set_http_headers(content_settings: ContentSettings | None = None, **kwargs) -> Dict[str, Any]

Parametry

content_settings: ContentSettings

Wymagane

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

lease: DataLakeLeaseClient lub str

Jeśli zostanie określony, set_file_system_metadata powiedzie się tylko wtedy, gdy dzierżawa systemu plików jest aktywna i jest zgodna z tym identyfikatorem.

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

timeout: int

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

Zwraca

file/directory-updated property dict (Etag i ostatnia modyfikacja)

Typ zwracany

Dict[str, Any]

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

set_metadata(metadata: Dict[str, str], **kwargs) -> Dict[str, str | datetime]

Parametry

metadata: Dict[str, str]

Wymagane

Dykt zawierający pary nazwa-wartość do skojarzenia z systemem plików jako metadane. Przykład: {'category':'test'}

lease: DataLakeLeaseClient lub str

Jeśli zostanie określony, set_file_system_metadata powiedzie się tylko wtedy, gdy dzierżawa systemu plików jest aktywna i jest zgodna z tym identyfikatorem.

if_modified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób został zmodyfikowany od określonego czasu.

if_unmodified_since: datetime

Wartość typu Data/godzina. Platforma Azure oczekuje, że wartość daty przekazana w formacie UTC. Jeśli strefa czasowa jest uwzględniona, wszystkie daty i godziny inne niż UTC zostaną przekonwertowane na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc. Określ ten nagłówek, aby wykonać operację tylko wtedy, gdy zasób nie został zmodyfikowany od określonej daty/godziny.

etag: str

Wartość elementu ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .

match_condition: MatchConditions

Warunek dopasowania do użycia na etagu.

cpk: CustomerProvidedEncryptionKey

Szyfruje dane po stronie usługi przy użyciu danego klucza. Korzystanie z kluczy dostarczonych przez klienta musi odbywać się za pośrednictwem protokołu HTTPS.

timeout: int

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

Zwraca

system plików — zaktualizowany dykt właściwości (Etag i ostatnia modyfikacja).

Modyfikuje Access Control na ścieżce i ścieżkach podrzędnych.

update_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parametry

acl: str

Wymagane

Modyfikuje prawa kontroli dostępu POSIX do plików i katalogów. Wartość jest rozdzielaną przecinkami listą wpisów kontroli dostępu. Każdy wpis kontroli dostępu (ACE) składa się z zakresu, typu, identyfikatora użytkownika lub grupy i uprawnień w formacie "[scope:][type]:[id]:[permissions]".

progress_hook: <xref:func>(AccessControlChanges)

Wywołanie zwrotne, w którym obiekt wywołujący może śledzić postęp operacji, a także zbierać ścieżki, których nie można zmienić Access Control.

continuation_token: str

Opcjonalny token kontynuacji, którego można użyć do wznowienia wcześniej zatrzymanych operacji.

batch_size: int

Opcjonalny. Jeśli rozmiar zestawu danych przekracza rozmiar partii, operacja zostanie podzielona na wiele żądań, aby można było śledzić postęp. Rozmiar partii powinien należeć do zakresu od 1 do 2000. Wartość domyślna, gdy nieokreślone jest 2000.

max_batches: int

Opcjonalny. Definiuje maksymalną liczbę partii, które mogą wykonywać pojedyncza zmiana Access Control operacji. Jeśli wartość maksymalna zostanie osiągnięta przed przetworzeniem wszystkich ścieżek podrzędnych, można użyć tokenu kontynuacji do wznowienia operacji. Pusta wartość wskazuje, że maksymalna liczba partii w niepowiązanych operacjach jest kontynuowana do końca.

continue_on_failure: bool

W przypadku ustawienia wartości Fałsz operacja zakończy się szybko po napotkaniu błędów użytkownika (4XX). Jeśli wartość True, operacja zignoruje błędy użytkownika i przejdzie do operacji na innych podrzędnych jednostkach katalogu. Token kontynuacji zostanie zwrócony tylko wtedy, gdy continue_on_failure ma wartość True w przypadku błędów użytkownika. Jeśli nie zostanie ustawiona wartość domyślna to Fałsz.

timeout: int

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

Zwraca

Podsumowanie operacji cyklicznych, w tym liczbę sukcesów i niepowodzeń, a także token kontynuacji na wypadek przedwczesnego zakończenia operacji.

Typ zwracany

AccessControlChangeResult

Wyjątki

AzureError

Użytkownik może ponownie uruchomić operację przy użyciu pola continuation_token AzureError, jeśli token jest dostępny.

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

Tryb lokalizacji, z którego obecnie korzysta klient.

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

Pełny podstawowy adres URL punktu końcowego.

Nazwa hosta podstawowego punktu końcowego.

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

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.

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

acquire_lease	Żąda nowej dzierżawy. Jeśli plik lub katalog nie ma aktywnej dzierżawy, usługa DataLake tworzy dzierżawę pliku/katalogu i zwraca nowy identyfikator dzierżawy.
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	Utwórz nowy katalog.
create_file	Utwórz nowy plik i zwróć klienta pliku do interakcji.
create_sub_directory	Utwórz podkatalog i zwróć klienta podkatalogu do interakcji.
delete_directory	Oznacza określony katalog do usunięcia.
delete_sub_directory	Oznacza określony podkatalog do usunięcia.
exists	Zwraca wartość True, jeśli istnieje katalog i zwraca wartość False w przeciwnym razie.
from_connection_string	Utwórz element DataLakeDirectoryClient na podstawie parametrów połączenia.
get_access_control
get_directory_properties	Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla katalogu. Nie zwraca zawartości katalogu.
get_file_client	Pobierz klienta do interakcji z określonym plikiem. Plik nie musi jeszcze istnieć.
get_sub_directory_client	Pobierz klienta do interakcji z określonym podkatalogem bieżącego katalogu. Podkatalog nie musi jeszcze istnieć.
remove_access_control_recursive	Usuwa Access Control na ścieżce i ścieżkach podrzędnych.
rename_directory	Zmień nazwę katalogu źródłowego.
set_access_control	Ustaw właściciela, grupę, uprawnienia lub listę kontroli dostępu dla ścieżki.
set_access_control_recursive	Ustawia Access Control na ścieżce i ścieżkach podrzędnych.
set_http_headers	Ustawia właściwości systemowe w pliku lub katalogu. Jeśli dla content_settings ustawiono jedną właściwość, wszystkie właściwości zostaną zastąpione.
set_metadata	Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego systemu plików. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do systemu plików. Aby usunąć wszystkie metadane z systemu plików, wywołaj tę operację bez dyktowania metadanych.
update_access_control_recursive	Modyfikuje Access Control na ścieżce i ścieżkach podrzędnych.

Udostępnij za pośrednictwem

DataLakeDirectoryClient Klasa

Konstruktor

Parametry

Przykłady

Zmienne

Metody

acquire_lease

Parametry

Zwraca

Typ zwracany

close

create_directory

Parametry

Zwraca

Typ zwracany

Przykłady

create_file

Parametry

Zwraca

create_sub_directory

Parametry

Zwraca

delete_directory

Parametry

Zwraca

Przykłady

delete_sub_directory

Parametry

Zwraca

exists

Parametry

Zwraca

Typ zwracany

from_connection_string

Parametry

Zwraca

Typ zwracany

get_access_control

Parametry

get_directory_properties

Parametry

Typ zwracany

Przykłady

get_file_client

Parametry

Zwraca

Typ zwracany

get_sub_directory_client

Parametry

Zwraca

Typ zwracany

remove_access_control_recursive

Parametry

Zwraca

Typ zwracany

Wyjątki

rename_directory

Parametry

Zwraca

Przykłady

set_access_control

Parametry

set_access_control_recursive

Parametry

Zwraca

Typ zwracany

Wyjątki

set_http_headers

Parametry

Zwraca

Typ zwracany

set_metadata

Parametry

Zwraca

update_access_control_recursive

Parametry

Zwraca

Typ zwracany

Wyjątki