filedatalake Pakiet

Pakiety

aio

Klasy

AccessControlChangeCounters

AccessControlChangeCounters zawiera liczbę operacji, które zmieniają Access Control listy cyklicznie.

AccessControlChangeFailure

Reprezentuje wpis, który nie może zaktualizować listy Access Control.

AccessControlChangeResult

AccessControlChangeResult zawiera wynik operacji, które zmieniają Access Control Listy rekursywnie.

AccessControlChanges

AccessControlChanges zawiera wsadowe i skumulowane liczby operacji, które zmieniają Access Control List rekursywnie. Ponadto uwidacznia wpisy ścieżki, których nie można zaktualizować podczas wykonywania tych operacji.

AccessPolicy

Klasa zasad dostępu używana przez zestaw i uzyskiwanie metod zasad dostępu w każdej usłudze.

Przechowywane zasady dostępu mogą określać czas rozpoczęcia, czas wygaśnięcia i uprawnienia dla sygnatur dostępu współdzielonego, z którymi jest skojarzony. W zależności od tego, jak chcesz kontrolować dostęp do zasobu, możesz określić wszystkie te parametry w przechowywanych zasadach dostępu i pominąć je z adresu URL sygnatury dostępu współdzielonego. Dzięki temu można zmodyfikować zachowanie skojarzonego podpisu w dowolnym momencie, a także odwołać go. Możesz też określić jeden lub więcej parametrów zasad dostępu w ramach przechowywanych zasad dostępu, a inne w adresie URL. Na koniec możesz określić wszystkie parametry w adresie URL. W takim przypadku można użyć przechowywanych zasad dostępu, aby odwołać podpis, ale nie zmodyfikować jego zachowania.

Razem sygnatura dostępu współdzielonego i przechowywane zasady dostępu muszą zawierać wszystkie pola wymagane do uwierzytelnienia podpisu. Jeśli brakuje wymaganych pól, żądanie zakończy się niepowodzeniem. Podobnie, jeśli pole jest określone zarówno w adresie URL sygnatury dostępu współdzielonego, jak i w przechowywanych zasadach dostępu, żądanie zakończy się niepowodzeniem z kodem stanu 400 (nieprawidłowe żądanie).

AccountSasPermissions
AnalyticsLogging

Ustawienia rejestrowania usługi Azure Analytics.

ArrowDialect

pole schematu strzałki.

Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.

ContentSettings

Ustawienia zawartości pliku lub katalogu.

CorsRule

Mechanizm CORS (udostępnianie zasobów między źródłami) to funkcja protokołu HTTP, która umożliwia aplikacji internetowej działającej w ramach jednej domeny dostęp do zasobów w innej domenie. Przeglądarki internetowe wdrażają ograniczenie bezpieczeństwa nazywane zasadami jednego źródła, które zapobiega wywoływaniu interfejsów API w innych domenach przez strony internetowe. Mechanizm CORS zapewnia bezpieczną metodę umożliwiania jednej domenie (domenie źródłowej) wywoływania interfejsów API z innej domeny.

CustomerProvidedEncryptionKey

Wszystkie dane w usłudze Azure Storage są szyfrowane w spoczynku przy użyciu klucza szyfrowania na poziomie konta. W wersjach 2021-06-08 i nowszych można zarządzać kluczem używanym do szyfrowania zawartości pliku i metadanych aplikacji dla każdego pliku, dostarczając klucz szyfrowania AES-256 w żądaniach do usługi magazynu.

W przypadku korzystania z klucza dostarczonego przez klienta usługa Azure Storage nie zarządza kluczem ani go utrwala. Podczas zapisywania danych w pliku podany klucz jest używany do szyfrowania danych przed zapisaniem ich na dysku. Skrót SHA-256 klucza szyfrowania jest zapisywany obok zawartości pliku i służy do sprawdzania, czy wszystkie kolejne operacje względem pliku używają tego samego klucza szyfrowania. Tego skrótu nie można użyć do pobrania klucza szyfrowania ani odszyfrowywania zawartości pliku. Podczas odczytywania pliku podany klucz jest używany do odszyfrowywania danych po odczytaniu ich z dysku. W obu przypadkach podany klucz szyfrowania jest bezpiecznie odrzucany po zakończeniu procesu szyfrowania lub odszyfrowywania.

DataLakeDirectoryClient

Klient do interakcji z katalogiem DataLake, nawet jeśli katalog może jeszcze nie istnieć.

W przypadku operacji dotyczących określonego podkatalogu lub pliku w katalogu można pobrać klienta katalogu lub klienta plików przy użyciu get_sub_directory_client funkcji lub get_file_client .

DataLakeFileClient

Klient do interakcji z plikiem DataLake, nawet jeśli plik może jeszcze nie istnieć.

DataLakeFileQueryError

Wystąpił błąd podczas szybkiej operacji zapytania.

DataLakeLeaseClient

Tworzy nowy element DataLakeLeaseClient.

Ten klient udostępnia operacje dzierżawy na elementach FileSystemClient, DataLakeDirectoryClient lub DataLakeFileClient.

DataLakeServiceClient

Klient do interakcji z usługą DataLake na poziomie konta.

Ten klient udostępnia operacje pobierania i konfigurowania właściwości konta, a także listy, tworzenia i usuwania systemów plików w ramach konta. W przypadku operacji związanych z określonym systemem plików, katalogiem lub plikiem klienci dla tych jednostek mogą być również pobierani przy użyciu funkcji get_client .

DeletedPathProperties

Właściwości wypełnione dla usuniętej ścieżki.

DelimitedJsonDialect

Definiuje serializacji danych wejściowych lub wyjściowych JSON dla zapytania datalake.

Ogranicznik ciągu słowa kluczowego: znak separatora wiersza, wartość domyślna to "

'

DelimitedTextDialect

Definiuje serializacji danych wejściowych lub wyjściowych rozdzielanych (CSV) dla żądania zapytania datalake.

Ogranicznik str słowa kluczowego: separator kolumny, wartość domyślna to ",".

ciąg słowa kluczowego: cudzysłów pól, wartość domyślna to "".

lineterminator str słowa kluczowego: separator rekordu, wartość domyślna to "

'. słowo kluczowe str escapechar: Znak ucieczki, domyślnie jest pusty.

wartość logiczna słowa kluczowego has_header: czy dane obiektu blob zawierają nagłówki w pierwszym wierszu. Wartość domyślna to False, co oznacza, że dane zostaną zwrócone włącznie z pierwszym wierszem. W przypadku ustawienia wartości True dane będą zwracane wyłącznie z pierwszego wiersza.

DirectoryProperties
DirectorySasPermissions

DirectorySasPermissions, klasa, która ma być używana z funkcją generate_directory_sas .

EncryptionScopeOptions

Domyślna konfiguracja zakresu szyfrowania dla systemu plików.

Ten zakres jest używany niejawnie dla wszystkich przyszłych zapisów w systemie plików, ale może być zastępowany na operację obiektu blob.

Nowość w wersji 12.9.0.

ExponentialRetry

Ponawianie wykładnicze.

Tworzy obiekt ponawiania wykładniczego. Initial_backoff służy do pierwszego ponawiania próby. Kolejne ponowne próby są ponawiane po initial_backoff + increment_power^retry_count sekundach.

FileProperties
FileSasPermissions

FileSasPermissions, klasa, która ma być używana z funkcją generate_file_sas .

FileSystemClient

Klient do interakcji z określonym systemem plików, nawet jeśli ten system plików może jeszcze nie istnieć.

W przypadku operacji związanych z określonym katalogiem lub plikiem w tym systemie plików można pobrać klienta katalogu lub klienta plików przy użyciu get_directory_client funkcji lub get_file_client .

FileSystemProperties

Klasa właściwości systemu plików.

Zwrócone FileSystemProperties wystąpienia uwidaczniają te wartości za pośrednictwem interfejsu słownika, na przykład: file_system_props["last_modified"]. Ponadto nazwa systemu plików jest dostępna jako file_system_props["name"].

FileSystemPropertiesPaged

Iterowalne właściwości systemu plików.

FileSystemSasPermissions

FileSystemSasPermissions, klasa, która ma być używana z funkcją generate_file_system_sas .

LeaseProperties

Właściwości dzierżawy usługi DataLake.

LinearRetry

Ponawianie liniowe.

Tworzy obiekt ponawiania liniowego.

LocationMode

Określa lokalizację, do którego ma zostać wysłane żądanie. Ten tryb dotyczy tylko kont RA-GRS, które zezwalają na pomocniczy dostęp do odczytu. Wszystkie inne typy kont muszą używać wartości PRIMARY.

Metrics

Podsumowanie statystyk żądań pogrupowanych według interfejsu API w agregacjach godzinowych lub minutowych.

PathProperties

Właściwości ścieżki wymienione przez interfejs API get_paths.

ResourceTypes

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

RetentionPolicy

Zasady przechowywania określające, jak długo powinny być utrwalane skojarzone dane.

StaticWebsite

Właściwości umożliwiające konto hostowania statycznej witryny internetowej.

StorageStreamDownloader

Obiekt przesyłania strumieniowego do pobrania z usługi Azure Storage.

UserDelegationKey

Reprezentuje klucz delegowania użytkownika udostępniany użytkownikowi przez usługę Azure Storage na podstawie tokenu dostępu usługi Azure Active Directory.

Pola są zapisywane jako proste ciągi, ponieważ użytkownik nie musi wchodzić w interakcje z tym obiektem; aby wygenerować sygnaturę dostępu współdzielonego identyfikacji, użytkownik może po prostu przekazać go do odpowiedniego interfejsu API.

Wyliczenia

ArrowType
PublicAccess

Określa, czy dane w systemie plików mogą być dostępne publicznie i na poziomie dostępu.

QuickQueryDialect

Określa dialekt wejściowy/wyjściowy szybkiego zapytania.

StorageErrorCode

Funkcje

generate_account_sas

Generuje sygnaturę dostępu współdzielonego dla usługi DataLake.

Użyj zwróconego podpisu jako parametru poświadczeń dowolnego elementu DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient lub DataLakeFileClient.

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str | None, **kwargs: Any) -> str

Parametry

account_name
str
Wymagane

Nazwa konta magazynu używana do generowania sygnatury dostępu współdzielonego.

account_key
str
Wymagane

Klucz dostępu do generowania sygnatury dostępu współdzielonego.

resource_types
str lub ResourceTypes
Wymagane

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

permission
str lub AccountSasPermissions
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 zapisanych zasadach dostępu.

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 zapisanych zasadach dostępu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start
datetime lub str

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

ip
str

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 adresu ip=168.1.5.65 lub ip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol
str

Określa protokół dozwolony dla żądania. Wartość domyślna to https.

encryption_scope
str

Określa zakres szyfrowania dla żądania, aby wszystkie operacje zapisu będą szyfrowane.

Zwraca

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

Typ zwracany

str

generate_directory_sas

Generuje sygnaturę dostępu współdzielonego dla katalogu.

Użyj zwróconego podpisu z parametrem poświadczeń dowolnego elementu DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient lub DataLakeFileClient.

generate_directory_sas(account_name: str, file_system_name: str, directory_name: str, credential: str | UserDelegationKey, permission: DirectorySasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Parametry

account_name
str
Wymagane

Nazwa konta magazynu używana do generowania sygnatury dostępu współdzielonego.

file_system_name
str
Wymagane

Nazwa systemu plików.

directory_name
str
Wymagane

Nazwa katalogu.

credential
str lub UserDelegationKey
Wymagane

Poświadczenie może być kluczem konta lub kluczem delegowania użytkownika. Jeśli używasz klucza konta jako poświadczenia, typ poświadczeń powinien być ciągiem. Zamiast klucza konta użytkownik może również przekazać klucz delegowania użytkownika. Klucz delegowania użytkownika można uzyskać z usługi, uwierzytelniając się przy użyciu tożsamości usługi AAD; Można to osiągnąć przez wywołanie metody get_user_delegation_key. Gdy jest obecny, sygnatura dostępu współdzielonego jest podpisana przy użyciu klucza delegowania użytkownika.

permission
str lub DirectorySasPermissions
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 racwdlmeop. 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 zapisanych zasadach dostępu.

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 zapisanych zasadach dostępu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start
datetime lub str

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

ip
str

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 adresu ip=168.1.5.65 lub ip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol
str

Określa protokół dozwolony dla żądania. Wartość domyślna to https.

cache_control
str

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ść nagłówka odpowiedzi dla właściwości Content-Disposition, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_encoding
str

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ść 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ść nagłówka odpowiedzi dla typu zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

preauthorized_agent_object_id
str

Identyfikator obiektu usługi AAD użytkownika zakładał, że jest autoryzowany przez właściciela klucza delegowania użytkownika w celu wykonania akcji przyznanej przez token SAS. Usługa zweryfikuje token SYGNATURy dostępu współdzielonego i upewni się, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, ale nie zostanie wykonane żadne dodatkowe sprawdzenie uprawnień dla identyfikatora obiektu agenta.

agent_object_id
str

Identyfikator obiektu usługi AAD użytkownika zakładał, że nieautoryzowany przez właściciela klucza delegowania użytkownika do wykonania akcji przyznanej przez token SAS. Usługa zweryfikuje token SYGNATURy dostępu współdzielonego i upewni się, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, a usługa wykona dodatkową kontrolę listy ACL POSIX w celu ustalenia, czy ten użytkownik ma autoryzację do wykonania żądanej operacji.

correlation_id
str

Identyfikator korelacji w celu skorelowania dzienników inspekcji magazynu z dziennikami inspekcji używanymi przez podmiot zabezpieczeń generujący i dystrybuujący sygnaturę dostępu współdzielonego.

encryption_scope
str

Określa zakres szyfrowania dla żądania, aby wszystkie operacje zapisu będą szyfrowane.

Zwraca

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

Typ zwracany

str

generate_file_sas

Generuje sygnaturę dostępu współdzielonego dla pliku.

Użyj zwróconego podpisu z parametrem poświadczeń dowolnego obiektu BDataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient lub DataLakeFileClient.

generate_file_sas(account_name: str, file_system_name: str, directory_name: str, file_name: str, credential: str | UserDelegationKey, permission: FileSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Parametry

account_name
str
Wymagane

Nazwa konta magazynu używana do generowania sygnatury dostępu współdzielonego.

file_system_name
str
Wymagane

Nazwa systemu plików.

directory_name
str
Wymagane

Nazwa katalogu.

file_name
str
Wymagane

Nazwa pliku.

credential
str lub UserDelegationKey
Wymagane

Poświadczenie może być kluczem konta lub kluczem delegowania użytkownika. Jeśli używasz klucza konta jako poświadczenia, typ poświadczeń powinien być ciągiem. Zamiast klucza konta użytkownik może również przekazać klucz delegowania użytkownika. Klucz delegowania użytkownika można uzyskać z usługi, uwierzytelniając się przy użyciu tożsamości usługi AAD; Można to osiągnąć przez wywołanie metody get_user_delegation_key. Gdy jest obecny, sygnatura dostępu współdzielonego jest podpisana przy użyciu klucza delegowania użytkownika.

permission
str lub FileSasPermissions
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 racwdlmeop. 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 zapisanych zasadach dostępu.

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 zapisanych zasadach dostępu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start
datetime lub str

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

ip
str

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 adresu ip=168.1.5.65 lub ip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol
str

Określa protokół dozwolony dla żądania. Wartość domyślna to https.

cache_control
str

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ść nagłówka odpowiedzi dla właściwości Content-Disposition, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

content_encoding
str

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ść 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ść nagłówka odpowiedzi dla typu zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

preauthorized_agent_object_id
str

Identyfikator obiektu usługi AAD użytkownika zakładał, że jest autoryzowany przez właściciela klucza delegowania użytkownika w celu wykonania akcji przyznanej przez token SAS. Usługa zweryfikuje token SYGNATURy dostępu współdzielonego i upewni się, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, ale nie zostanie wykonane żadne dodatkowe sprawdzenie uprawnień dla identyfikatora obiektu agenta.

agent_object_id
str

Identyfikator obiektu usługi AAD użytkownika zakładał, że nieautoryzowany przez właściciela klucza delegowania użytkownika do wykonania akcji przyznanej przez token SAS. Usługa zweryfikuje token SYGNATURy dostępu współdzielonego i upewni się, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, a usługa wykona dodatkową kontrolę listy ACL POSIX w celu ustalenia, czy ten użytkownik ma autoryzację do wykonania żądanej operacji.

correlation_id
str

Identyfikator korelacji w celu skorelowania dzienników inspekcji magazynu z dziennikami inspekcji używanymi przez podmiot zabezpieczeń generujący i dystrybuujący sygnaturę dostępu współdzielonego. Tej funkcji można używać tylko podczas generowania sygnatury dostępu współdzielonego z kluczem delegowania.

encryption_scope
str

Określa zakres szyfrowania dla żądania, aby wszystkie operacje zapisu będą szyfrowane.

Zwraca

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

Typ zwracany

str

generate_file_system_sas

Generuje sygnaturę dostępu współdzielonego dla systemu plików.

Użyj zwróconego podpisu z parametrem poświadczeń dowolnego elementu DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient lub DataLakeFileClient.

generate_file_system_sas(account_name: str, file_system_name: str, credential: str | UserDelegationKey, permission: FileSystemSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Parametry

account_name
str
Wymagane

Nazwa konta magazynu używana do generowania sygnatury dostępu współdzielonego.

file_system_name
str
Wymagane

Nazwa systemu plików.

credential
str lub UserDelegationKey
Wymagane

Poświadczenie może być kluczem konta lub kluczem delegowania użytkownika. Jeśli używasz klucza konta jako poświadczenia, typ poświadczeń powinien być ciągiem. Zamiast klucza konta użytkownik może również przekazać klucz delegowania użytkownika. Klucz delegowania użytkownika można uzyskać z usługi, uwierzytelniając się przy użyciu tożsamości usługi AAD; Można to osiągnąć przez wywołanie metody get_user_delegation_key. Gdy jest obecny, sygnatura dostępu współdzielonego jest podpisana przy użyciu klucza delegowania użytkownika.

permission
str lub FileSystemSasPermissions
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 racwdlmeop. 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

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

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 adresu IP=168.1.5.65 lub ip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol
str

Określa protokół dozwolony dla złożonego żądania. Wartość domyślna to https.

cache_control
str

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ść 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ść 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ść 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ść nagłówka odpowiedzi dla typu zawartości, gdy zasób jest uzyskiwany przy użyciu tego sygnatury dostępu współdzielonego.

preauthorized_agent_object_id
str

Identyfikator obiektu usługi AAD użytkownika zakładał, że ma być autoryzowany przez właściciela klucza delegowania użytkownika w celu wykonania akcji przyznanej przez token SAS. Usługa zweryfikuje token sygnatury dostępu współdzielonego i upewni się, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, ale nie zostaną wykonane żadne dodatkowe sprawdzanie uprawnień dla identyfikatora obiektu agenta.

agent_object_id
str

Identyfikator obiektu usługi AAD użytkownika zakładał, że nieautoryzowany przez właściciela klucza delegowania użytkownika w celu wykonania akcji przyznanej przez token SAS. Usługa zweryfikuje token sygnatury dostępu współdzielonego i upewni się, że właściciel klucza delegowania użytkownika ma wymagane uprawnienia przed udzieleniem dostępu, a usługa wykona dodatkową kontrolę listy ACL poSIX w celu ustalenia, czy ten użytkownik ma autoryzację do wykonania żądanej operacji.

correlation_id
str

Identyfikator korelacji w celu skorelowania dzienników inspekcji magazynu z dziennikami inspekcji używanymi przez jednostkę generującą i dystrybuując sygnaturę dostępu współdzielonego.

encryption_scope
str

Określa zakres szyfrowania dla żądania, aby wszystkie operacje zapisu są szyfrowane.

Zwraca

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

Typ zwracany

str