filedatalake Paket
Paket
aio |
Klasser
AccessControlChangeCounters |
AccessControlChangeCounters innehåller antalet åtgärder som ändrar Access Control listor rekursivt. |
AccessControlChangeFailure |
Representerar en post som inte kunde uppdatera Access Control lista. |
AccessControlChangeResult |
AccessControlChangeResult innehåller resultatet av åtgärder som ändrar Access Control listor rekursivt. |
AccessControlChanges |
AccessControlChanges innehåller batch- och kumulativa antal åtgärder som ändras Access Control listor rekursivt. Dessutom exponeras sökvägsposter som inte kunde uppdateras medan åtgärderna fortskrider. |
AccessPolicy |
Access Policy-klassen som används av uppsättningen och få åtkomstprincipmetoder i varje tjänst. En lagrad åtkomstprincip kan ange starttid, förfallotid och behörigheter för signaturer för delad åtkomst som den är associerad med. Beroende på hur du vill styra åtkomsten till din resurs kan du ange alla dessa parametrar i den lagrade åtkomstprincipen och utelämna dem från URL:en för signaturen för delad åtkomst. På så sätt kan du när som helst ändra den associerade signaturens beteende och återkalla den. Eller så kan du ange en eller flera av åtkomstprincipparametrarna i den lagrade åtkomstprincipen och de andra på URL:en. Slutligen kan du ange alla parametrar på URL:en. I det här fallet kan du använda den lagrade åtkomstprincipen för att återkalla signaturen, men inte ändra dess beteende. Tillsammans måste signaturen för delad åtkomst och den lagrade åtkomstprincipen innehålla alla fält som krävs för att autentisera signaturen. Om några obligatoriska fält saknas misslyckas begäran. På samma sätt misslyckas begäran med statuskod 400 (felaktig begäran) om ett fält anges både i URL:en för signatur för delad åtkomst och i den lagrade åtkomstprincipen. |
AccountSasPermissions | |
AnalyticsLogging |
Loggningsinställningar för Azure Analytics. |
ArrowDialect |
i ett pilschema. Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure. |
ContentSettings |
Innehållsinställningarna för en fil eller katalog. |
CorsRule |
CORS är en HTTP-funktion som gör det möjligt för ett webbprogram som körs i en domän att komma åt resurser i en annan domän. Webbläsare implementerar en säkerhetsbegränsning som har samma ursprungsprincip som förhindrar att en webbsida anropar API:er i en annan domän. CORS är ett säkert sätt att tillåta en domän (ursprungsdomänen) att anropa API:er i en annan domän. |
CustomerProvidedEncryptionKey |
Alla data i Azure Storage krypteras i vila med hjälp av en krypteringsnyckel på kontonivå. I version 2021-06-08 och senare kan du hantera nyckeln som används för att kryptera filinnehåll och programmetadata per fil genom att tillhandahålla en AES-256-krypteringsnyckel i begäranden till lagringstjänsten. När du använder en nyckel som tillhandahålls av kunden hanterar eller bevarar Inte Azure Storage din nyckel. När du skriver data till en fil används den angivna nyckeln för att kryptera dina data innan du skriver dem till disken. En SHA-256-hash för krypteringsnyckeln skrivs tillsammans med filinnehållet och används för att verifiera att alla efterföljande åtgärder mot filen använder samma krypteringsnyckel. Denna hash kan inte användas för att hämta krypteringsnyckeln eller dekryptera innehållet i filen. När du läser en fil används den angivna nyckeln för att dekryptera dina data efter att ha läst den från disken. I båda fallen ignoreras den angivna krypteringsnyckeln på ett säkert sätt så snart krypterings- eller dekrypteringsprocessen har slutförts. |
DataLakeDirectoryClient |
En klient för att interagera med DataLake-katalogen, även om katalogen kanske inte finns ännu. För åtgärder som rör en specifik underkatalog eller fil under katalogen kan en katalogklient eller filklient hämtas med hjälp av get_sub_directory_client funktionerna eller get_file_client . |
DataLakeFileClient |
En klient som interagerar med DataLake-filen, även om filen kanske inte finns ännu. |
DataLakeFileQueryError |
Felet inträffade under snabbfrågeåtgärden. |
DataLakeLeaseClient |
Skapar en ny DataLakeLeaseClient. Den här klienten tillhandahåller låneåtgärder på en FileSystemClient, DataLakeDirectoryClient eller DataLakeFileClient. |
DataLakeServiceClient |
En klient som interagerar med DataLake-tjänsten på kontonivå. Den här klienten tillhandahåller åtgärder för att hämta och konfigurera kontoegenskaper samt lista, skapa och ta bort filsystem i kontot. För åtgärder som rör ett specifikt filsystem, katalog eller fil kan klienter för dessa entiteter också hämtas med hjälp av get_client funktioner. |
DeletedPathProperties |
Egenskaper som har fyllts i för en borttagen sökväg. |
DelimitedJsonDialect |
Definierar indata- eller utdata-JSON-serialiseringen för en datalake-fråga. keyword str delimiter: Radavgränsarens tecken, standardvärdet är ' ' |
DelimitedTextDialect |
Definierar den indata- eller utdataavgränsade (CSV)-serialiseringen för en datalake-frågebegäran. keyword str delimiter: Kolumnavgränsare, standardvärdet är ','. keyword str quotechar: Field quote, defaults to '". keyword str lineterminator: Postavgränsare, standardvärdet är ' '. nyckelordsutrymningsdiagram: Escape-tecken, standardvärdet är tomt. nyckelordsbool has_header: Om blobdata innehåller rubriker på den första raden. Standardvärdet är False, vilket innebär att data returneras inklusive den första raden. Om värdet är True returneras data exklusivt för den första raden. |
DirectoryProperties | |
DirectorySasPermissions |
DirectorySasPermissions-klassen som ska användas med funktionen generate_directory_sas . |
EncryptionScopeOptions |
Standardkonfigurationen för krypteringsomfång för ett filsystem. Det här omfånget används implicit för alla framtida skrivningar i filsystemet, men kan åsidosättas per blobåtgärd. Ny i version 12.9.0. |
ExponentialRetry |
Exponentiellt återförsök. Konstruerar ett exponentiellt återförsöksobjekt. Den initial_backoff används för det första återförsöket. Efterföljande återförsök görs efter initial_backoff + increment_power^retry_count sekunder. |
FileProperties | |
FileSasPermissions |
Klassen FileSasPermissions som ska användas med funktionen generate_file_sas . |
FileSystemClient |
En klient som interagerar med ett visst filsystem, även om det filsystemet kanske inte redan finns. För åtgärder som rör en specifik katalog eller fil i det här filsystemet kan en katalogklient eller filklient hämtas med hjälp av get_directory_client funktionerna eller get_file_client . |
FileSystemProperties |
Egenskapsklass för filsystem. Returnerade |
FileSystemPropertiesPaged |
En itererbar filsystemsegenskaper. |
FileSystemSasPermissions |
FileSystemSasPermissions-klassen som ska användas med funktionen generate_file_system_sas . |
LeaseProperties |
Egenskaper för DataLake-lån. |
LinearRetry |
Linjärt återförsök. Konstruerar ett linjärt återförsöksobjekt. |
LocationMode |
Anger den plats som begäran ska skickas till. Det här läget gäller endast för RA-GRS-konton som tillåter sekundär läsåtkomst. Alla andra kontotyper måste använda PRIMARY. |
Metrics |
En sammanfattning av begärandestatistik grupperad efter API i tim- eller minutaggregeringar. |
PathProperties |
Sökvägsegenskaper som anges av get_paths api. |
ResourceTypes |
Anger de resurstyper som är tillgängliga med kontots SAS. |
RetentionPolicy |
Kvarhållningsprincipen som avgör hur länge associerade data ska bevaras. |
StaticWebsite |
De egenskaper som gör att ett konto kan vara värd för en statisk webbplats. |
StorageStreamDownloader |
Ett strömmande objekt som ska laddas ned från Azure Storage. |
UserDelegationKey |
Representerar en nyckel för användardelegering som tillhandahålls till användaren av Azure Storage baserat på deras Azure Active Directory-åtkomsttoken. Fälten sparas som enkla strängar eftersom användaren inte behöver interagera med det här objektet. för att generera en identifierande SAS kan användaren helt enkelt skicka den till rätt API. |
Uppräkningar
ArrowType | |
PublicAccess |
Anger om data i filsystemet kan nås offentligt och åtkomstnivån. |
QuickQueryDialect |
Anger snabbfrågedialekten input/output. |
StorageErrorCode |
Funktioner
generate_account_sas
Genererar en signatur för delad åtkomst för DataLake-tjänsten.
Använd den returnerade signaturen som autentiseringsparameter för alla DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient eller DataLakeFileClient.
generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str | None, **kwargs: Any) -> str
Parametrar
- account_name
- str
Namnet på lagringskontot som används för att generera signaturen för delad åtkomst.
- resource_types
- str eller ResourceTypes
Anger de resurstyper som är tillgängliga med kontots SAS.
- permission
- str eller AccountSasPermissions
De behörigheter som är associerade med signaturen för delad åtkomst. Användaren är begränsad till åtgärder som tillåts av behörigheterna. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip.
Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
Den tidpunkt då signaturen för delad åtkomst blir giltig. Om det utelämnas antas starttiden för det här anropet vara den tid då lagringstjänsten tar emot begäran. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
- ip
- str
Anger en IP-adress eller ett intervall med IP-adresser som begäranden ska accepteras från. Om IP-adressen som begäran kommer från inte matchar IP-adressen eller adressintervallet som anges i SAS-token autentiseras inte begäran. Om du till exempel anger ip=168.1.5.65 eller ip=168.1.5.60-168.1.5.70 på SAS begränsas begäran till dessa IP-adresser.
- protocol
- str
Anger vilket protokoll som tillåts för en begäran. Standardvärdet är https.
- encryption_scope
- str
Anger krypteringsomfånget för en begäran som görs så att alla skrivåtgärder kommer att vara tjänstkrypterade.
Returer
En sas-token (signatur för delad åtkomst).
Returtyp
generate_directory_sas
Genererar en signatur för delad åtkomst för en katalog.
Använd den returnerade signaturen med autentiseringsparametern för alla DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient eller 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
Parametrar
- account_name
- str
Namnet på lagringskontot som används för att generera signaturen för delad åtkomst.
- credential
- str eller UserDelegationKey
Autentiseringsuppgifter kan vara antingen kontonyckel eller användardelegeringsnyckel. Om kontonyckeln används som autentiseringsuppgifter ska autentiseringstypen vara en str. I stället för en kontonyckel kan användaren också skicka in en användardelegeringsnyckel. En nyckel för användardelegering kan hämtas från tjänsten genom autentisering med en AAD-identitet. detta kan åstadkommas genom att anropa get_user_delegation_key. När den finns signeras SAS med användarens delegeringsnyckel i stället.
- permission
- str eller DirectorySasPermissions
De behörigheter som är associerade med signaturen för delad åtkomst. Användaren är begränsad till åtgärder som tillåts av behörigheterna. Behörigheter måste beställas racwdlmeop. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip.
Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
Den tidpunkt då signaturen för delad åtkomst blir giltig. Om det utelämnas antas starttiden för det här anropet vara den tid då lagringstjänsten tar emot begäran. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
- ip
- str
Anger en IP-adress eller ett intervall med IP-adresser som begäranden ska accepteras från. Om IP-adressen som begäran kommer från inte matchar IP-adressen eller adressintervallet som anges i SAS-token autentiseras inte begäran. Om du till exempel anger ip=168.1.5.65 eller ip=168.1.5.60-168.1.5.70 på SAS begränsas begäran till dessa IP-adresser.
- protocol
- str
Anger vilket protokoll som tillåts för en begäran. Standardvärdet är https.
- cache_control
- str
Svarshuvudvärde för Cache-Control när resursen används med den här signaturen för delad åtkomst.
- content_disposition
- str
Svarshuvudvärde för Content-Disposition när resursen används med den här signaturen för delad åtkomst.
- content_encoding
- str
Svarshuvudvärde för Content-Encoding när resursen används med den här signaturen för delad åtkomst.
- content_language
- str
Svarshuvudvärde för Content-Language när resursen används med den här signaturen för delad åtkomst.
- content_type
- str
Svarshuvudvärde för Content-Type när resursen används med den här signaturen för delad åtkomst.
- preauthorized_agent_object_id
- str
AAD-objekt-ID för en användare som antas ha behörighet av ägaren till användarens delegeringsnyckel för att utföra åtgärden som beviljats av SAS-token. Tjänsten verifierar SAS-token och ser till att ägaren av användardelegeringsnyckeln har de behörigheter som krävs innan åtkomst beviljas, men ingen ytterligare behörighetskontroll för agentobjekt-ID:t utförs.
- agent_object_id
- str
AAD-objekt-ID för en användare som antas vara obehörig av ägaren av användardelegeringsnyckeln för att utföra åtgärden som beviljats av SAS-token. Tjänsten verifierar SAS-token och ser till att ägaren av användardelegeringsnyckeln har de behörigheter som krävs innan åtkomst beviljas och att tjänsten utför ytterligare en POSIX ACL-kontroll för att avgöra om användaren har behörighet att utföra den begärda åtgärden.
- correlation_id
- str
Korrelations-ID:t för att korrelera lagringsgranskningsloggarna med de granskningsloggar som används av huvudkontot som genererar och distribuerar SAS.
- encryption_scope
- str
Anger krypteringsomfånget för en begäran som görs så att alla skrivåtgärder kommer att vara tjänstkrypterade.
Returer
En sas-token (signatur för delad åtkomst).
Returtyp
generate_file_sas
Genererar en signatur för delad åtkomst för en fil.
Använd den returnerade signaturen med autentiseringsparametern för BDataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient eller 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
Parametrar
- account_name
- str
Namnet på lagringskontot som används för att generera signaturen för delad åtkomst.
- credential
- str eller UserDelegationKey
Autentiseringsuppgifter kan vara antingen kontonyckel eller användardelegeringsnyckel. Om kontonyckeln används som autentiseringsuppgifter ska autentiseringstypen vara en str. I stället för en kontonyckel kan användaren också skicka in en användardelegeringsnyckel. En nyckel för användardelegering kan hämtas från tjänsten genom autentisering med en AAD-identitet. detta kan åstadkommas genom att anropa get_user_delegation_key. När den finns signeras SAS med användarens delegeringsnyckel i stället.
- permission
- str eller FileSasPermissions
De behörigheter som är associerade med signaturen för delad åtkomst. Användaren är begränsad till åtgärder som tillåts av behörigheterna. Behörigheter måste beställas racwdlmeop. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip.
Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
Den tidpunkt då signaturen för delad åtkomst blir giltig. Om det utelämnas antas starttiden för det här anropet vara den tid då lagringstjänsten tar emot begäran. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
- ip
- str
Anger en IP-adress eller ett intervall med IP-adresser som begäranden ska accepteras från. Om IP-adressen som begäran kommer från inte matchar IP-adressen eller adressintervallet som anges i SAS-token autentiseras inte begäran. Om du till exempel anger ip=168.1.5.65 eller ip=168.1.5.60-168.1.5.70 på SAS begränsas begäran till dessa IP-adresser.
- protocol
- str
Anger vilket protokoll som tillåts för en begäran. Standardvärdet är https.
- cache_control
- str
Svarshuvudvärde för Cache-Control när resursen används med den här signaturen för delad åtkomst.
- content_disposition
- str
Svarshuvudvärde för Content-Disposition när resursen används med den här signaturen för delad åtkomst.
- content_encoding
- str
Svarshuvudvärde för Content-Encoding när resursen används med den här signaturen för delad åtkomst.
- content_language
- str
Svarshuvudvärde för Content-Language när resursen används med den här signaturen för delad åtkomst.
- content_type
- str
Svarshuvudvärde för Content-Type när resursen används med den här signaturen för delad åtkomst.
- preauthorized_agent_object_id
- str
AAD-objekt-ID för en användare som antas ha behörighet av ägaren till användarens delegeringsnyckel för att utföra åtgärden som beviljats av SAS-token. Tjänsten verifierar SAS-token och ser till att ägaren av användardelegeringsnyckeln har de behörigheter som krävs innan åtkomst beviljas, men ingen ytterligare behörighetskontroll för agentobjekt-ID:t utförs.
- agent_object_id
- str
AAD-objekt-ID för en användare som antas vara obehörig av ägaren av användardelegeringsnyckeln för att utföra åtgärden som beviljats av SAS-token. Tjänsten verifierar SAS-token och ser till att ägaren av användardelegeringsnyckeln har de behörigheter som krävs innan åtkomst beviljas och att tjänsten utför ytterligare en POSIX ACL-kontroll för att avgöra om användaren har behörighet att utföra den begärda åtgärden.
- correlation_id
- str
Korrelations-ID:t för att korrelera lagringsgranskningsloggarna med de granskningsloggar som används av huvudkontot som genererar och distribuerar SAS. Detta kan endast användas när du genererar en SAS med delegeringsnyckel.
- encryption_scope
- str
Anger krypteringsomfånget för en begäran som görs så att alla skrivåtgärder kommer att vara tjänstkrypterade.
Returer
En sas-token (signatur för delad åtkomst).
Returtyp
generate_file_system_sas
Genererar en signatur för delad åtkomst för ett filsystem.
Använd den returnerade signaturen med autentiseringsparametern för alla DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient eller 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
Parametrar
- account_name
- str
Namnet på lagringskontot som används för att generera signaturen för delad åtkomst.
- credential
- str eller UserDelegationKey
Autentiseringsuppgifter kan vara antingen kontonyckel eller användardelegeringsnyckel. Om kontonyckeln används som autentiseringsuppgifter ska autentiseringstypen vara en str. I stället för en kontonyckel kan användaren också skicka in en användardelegeringsnyckel. En nyckel för användardelegering kan hämtas från tjänsten genom autentisering med en AAD-identitet. detta kan åstadkommas genom att anropa get_user_delegation_key. När den finns signeras SAS med användarens delegeringsnyckel i stället.
- permission
- str eller FileSystemSasPermissions
De behörigheter som är associerade med signaturen för delad åtkomst. Användaren är begränsad till åtgärder som tillåts av behörigheterna. Behörigheter måste beställas racwdlmeop. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip.
Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
Den tidpunkt då signaturen för delad åtkomst blir giltig. Om det utelämnas antas starttiden för det här anropet vara den tid då lagringstjänsten tar emot begäran. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
- ip
- str
Anger en IP-adress eller ett intervall med IP-adresser som begäranden ska accepteras från. Om IP-adressen som begäran kommer från inte matchar IP-adressen eller adressintervallet som anges i SAS-token autentiseras inte begäran. Om du till exempel anger ip=168.1.5.65 eller ip=168.1.5.60-168.1.5.70 på SAS begränsas begäran till dessa IP-adresser.
- protocol
- str
Anger vilket protokoll som tillåts för en begäran. Standardvärdet är https.
- cache_control
- str
Svarshuvudvärde för Cache-Control när resursen används med den här signaturen för delad åtkomst.
- content_disposition
- str
Svarshuvudvärde för Content-Disposition när resursen används med den här signaturen för delad åtkomst.
- content_encoding
- str
Svarshuvudvärde för Content-Encoding när resursen används med den här signaturen för delad åtkomst.
- content_language
- str
Svarshuvudvärde för Content-Language när resursen används med den här signaturen för delad åtkomst.
- content_type
- str
Svarshuvudvärde för Content-Type när resursen används med den här signaturen för delad åtkomst.
- preauthorized_agent_object_id
- str
AAD-objekt-ID för en användare som antas ha behörighet av ägaren till användarens delegeringsnyckel för att utföra åtgärden som beviljats av SAS-token. Tjänsten verifierar SAS-token och ser till att ägaren av användardelegeringsnyckeln har de behörigheter som krävs innan åtkomst beviljas, men ingen ytterligare behörighetskontroll för agentobjekt-ID:t utförs.
- agent_object_id
- str
AAD-objekt-ID för en användare som antas vara obehörig av ägaren av användardelegeringsnyckeln för att utföra åtgärden som beviljats av SAS-token. Tjänsten verifierar SAS-token och ser till att ägaren av användardelegeringsnyckeln har de behörigheter som krävs innan åtkomst beviljas och att tjänsten utför ytterligare en POSIX ACL-kontroll för att avgöra om användaren har behörighet att utföra den begärda åtgärden.
- correlation_id
- str
Korrelations-ID:t för att korrelera lagringsgranskningsloggarna med de granskningsloggar som används av huvudkontot som genererar och distribuerar SAS.
- encryption_scope
- str
Anger krypteringsomfånget för en begäran som görs så att alla skrivåtgärder kommer att vara tjänstkrypterade.
Returer
En sas-token (signatur för delad åtkomst).
Returtyp
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för