FileService Klas

Referentie

Het SMB-protocol (Server Message Block) is het voorkeursprotocol voor bestandsshares dat momenteel on-premises wordt gebruikt. Met de Microsoft Azure File-service kunnen klanten gebruikmaken van de beschikbaarheid en schaalbaarheid van De IaaS-SMB (Cloud Infrastructure as a Service) van Azure zonder dat ze SMB-clienttoepassingen hoeven te herschrijven.

De Azure File-service biedt ook een aantrekkelijk alternatief voor traditionele DAS- (Direct Attached Storage) en SAN-oplossingen (Storage Area Network), die vaak complex en duur zijn om te installeren, te configureren en te gebruiken.

Overname: StorageClient

FileService

Constructor

FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)

Parameters

Name	Description
account_name	str De naam van het opslagaccount. Dit wordt gebruikt om aanvragen te verifiëren die zijn ondertekend met een accountsleutel en om het opslageindpunt te maken. Dit is vereist tenzij er een verbindingsreeks wordt gegeven. standaardwaarde: None
account_key	str De opslagaccountsleutel. Dit wordt gebruikt voor verificatie met gedeelde sleutels. standaardwaarde: None
sas_token	str Een shared access signature-token dat moet worden gebruikt om aanvragen te verifiëren in plaats van de accountsleutel. Als de accountsleutel en het SAS-token beide zijn opgegeven, wordt de accountsleutel gebruikt om te ondertekenen. standaardwaarde: None
protocol	str Het protocol dat moet worden gebruikt voor aanvragen. De standaardinstelling is https. standaardwaarde: https
endpoint_suffix	str Het hostbasisonderdeel van de URL, minus de accountnaam. De standaardinstelling is Azure (core.windows.net). Overschrijf dit om de China-cloud (core.chinacloudapi.cn) te gebruiken. standaardwaarde: core.windows.net
request_session	<xref:requests.Session> Het sessieobject dat moet worden gebruikt voor HTTP-aanvragen. standaardwaarde: None
connection_string	str Als dit wordt opgegeven, worden alle andere parameters naast de aanvraagsessie overschreven. Zie http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ voor de verbindingsreeks-indeling. standaardwaarde: None
socket_timeout	int Als dit is opgegeven, overschrijft dit de standaardtime-out van de socket. De opgegeven time-out is in seconden. Zie DEFAULT_SOCKET_TIMEOUT in _constants.py voor de standaardwaarde. standaardwaarde: None

Variabelen

Name	Description
MAX_SINGLE_GET_SIZE	int De grootte van het eerste bereik wordt uitgevoerd door get_file_to_*-methoden als max_connections groter is dan 1. Er worden minder gegevens geretourneerd als het bestand kleiner is dan dit.
MAX_CHUNK_GET_SIZE	int De grootte van het volgende bereik wordt uitgevoerd met get_file_to_*-methoden als max_connections groter is dan 1 en het bestand groter is dan MAX_SINGLE_GET_SIZE. Er worden minder gegevens geretourneerd als de rest van het bestand kleiner is dan dit. Als dit is ingesteld op groter dan 4 MB, genereert content_validation een fout als deze is ingeschakeld. Als content_validation echter niet gewenst is, kan een grootte groter dan 4 MB optimaal zijn. Het wordt afgeraden dit in te stellen onder 4 MB.
MAX_RANGE_SIZE	int De grootte van de bereiken die create_file_from_* methoden. Kleinere bereiken kunnen worden geplaatst als er minder gegevens zijn opgegeven. De maximale bereikgrootte die door de service wordt ondersteund, is 4 MB.

Methoden

abort_copy_file	Hiermee wordt een in behandeling zijnde copy_file bewerking afgebroken en blijft een doelbestand met de lengte nul en volledige metagegevens behouden.
clear_range	Wist het opgegeven bereik en maakt de ruimte vrij die in de opslag voor dat bereik wordt gebruikt.
close_handles	Retourneert een generator om geopende ingangen in een map of een bestand onder de opgegeven share te sluiten. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle ingangen zijn gesloten. De geretourneerde waarden vertegenwoordigen het aantal ingangen dat in elke transactie is gesloten.
copy_file	Een bestand asynchroon kopiëren. Met deze bewerking wordt een eigenschapsobject voor de kopieerbewerking geretourneerd, inclusief een kopieer-id die u kunt gebruiken om de kopieerbewerking te controleren of af te breken. De File-service kopieert bestanden naar beste vermogen. Als het doelbestand bestaat, wordt het overschreven. Het doelbestand kan niet worden gewijzigd terwijl de kopieerbewerking wordt uitgevoerd.
create_directory	Hiermee maakt u een nieuwe map onder de opgegeven share of bovenliggende map. Als de map met dezelfde naam al bestaat, mislukt de bewerking in de service. Standaard wordt de uitzondering door de client ingeslikt. Als u de uitzondering wilt zichtbaar maken, geeft u True op voor fail_on_exists.
create_file	Hiermee maakt u een nieuw bestand. Zie create_file_from_* voor functies op hoog niveau die het maken en uploaden van grote bestanden afhandelen met automatische segmentering en voortgangsmeldingen.
create_file_from_bytes	Hiermee maakt u een nieuw bestand op basis van een matrix van bytes of werkt u de inhoud van een bestaand bestand bij met automatische segmentering en voortgangsmeldingen.
create_file_from_path	Hiermee maakt u een nieuw Azure-bestand op basis van een lokaal bestandspad of werkt u de inhoud van een bestaand bestand bij met automatische segmentering en voortgangsmeldingen.
create_file_from_stream	Hiermee maakt u een nieuw bestand op basis van een bestand/stream of werkt u de inhoud van een bestaand bestand bij met automatische segmentering en voortgangsmeldingen.
create_file_from_text	Hiermee maakt u een nieuw bestand op basis van str/unicode of werkt u de inhoud van een bestaand bestand bij met automatische segmentering en voortgangsmeldingen.
create_permission_for_share	Maak een machtiging (een beveiligingsdescriptor) op shareniveau. Deze machtiging kan worden gebruikt voor de bestanden/mappen in de share. Als er al een 'machtiging' bestaat, wordt de sleutel ervan geretourneerd, anders wordt er een nieuwe machtiging op shareniveau gemaakt en wordt de sleutel geretourneerd. :retourneert een bestandsmachtigingssleutel :rtype str
create_share	Hiermee maakt u een nieuwe share onder het opgegeven account. Als de share met dezelfde naam al bestaat, mislukt de bewerking voor de service. Standaard wordt de uitzondering door de client ingeslikt. Als u de uitzondering wilt zichtbaar maken, geeft u Waar op voor fail_on_exists.
delete_directory	Hiermee verwijdert u de opgegeven lege map. Houd er rekening mee dat de map leeg moet zijn voordat deze kan worden verwijderd. Het verwijderen van mappen die niet leeg zijn, mislukt. Als de map niet bestaat, mislukt de bewerking voor de service. Standaard wordt de uitzondering door de client ingeslikt. Als u de uitzondering wilt zichtbaar maken, geeft u Waar op voor fail_not_exist.
delete_file	Hiermee wordt het opgegeven bestand gemarkeerd voor verwijdering. Het bestand wordt later verwijderd tijdens de garbagecollection.
delete_share	Hiermee wordt de opgegeven share gemarkeerd voor verwijdering. Als de share niet bestaat, mislukt de bewerking voor de service. Standaard wordt de uitzondering door de client ingeslikt. Als u de uitzondering wilt zichtbaar maken, geeft u Waar op voor fail_not_exist.
exists	Retourneert een booleaanse waarde die aangeeft of de share bestaat als alleen de sharenaam wordt opgegeven. Als directory_name is opgegeven, wordt er een booleaanse waarde geretourneerd die aangeeft of de map bestaat. Als file_name ook is opgegeven, wordt er een booleaanse waarde geretourneerd die aangeeft of het bestand bestaat.
extract_date_and_request_id
generate_account_shared_access_signature	Hiermee genereert u een Shared Access Signature voor de bestandsservice. Gebruik de geretourneerde handtekening met de parameter sas_token van de FileService.
generate_file_shared_access_signature	Hiermee genereert u een Shared Access Signature voor het bestand. Gebruik de geretourneerde handtekening met de parameter sas_token fileservice.
generate_share_shared_access_signature	Hiermee wordt een shared access signature voor de share gegenereerd. Gebruik de geretourneerde handtekening met de sas_token parameter FileService.
get_directory_metadata	Retourneert alle door de gebruiker gedefinieerde metagegevens voor de opgegeven map.
get_directory_properties	Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven map. De geretourneerde gegevens bevatten niet de lijst met bestanden van de map.
get_file_metadata	Retourneert alle door de gebruiker gedefinieerde metagegevens voor het opgegeven bestand.
get_file_properties	Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het bestand. Retourneert een exemplaar van File met FileProperties en een metagegevensdict.
get_file_service_properties	Hiermee haalt u de eigenschappen op van de bestandsservice van een opslagaccount, waaronder Azure Opslaganalyse.
get_file_to_bytes	Hiermee downloadt u een bestand als een matrix van bytes, met automatische segmentering en voortgangsmeldingen. Retourneert een exemplaar van File met eigenschappen, metagegevens en inhoud.
get_file_to_path	Hiermee downloadt u een bestand naar een bestandspad, met automatische segmentering en voortgangsmeldingen. Retourneert een exemplaar van Bestand met eigenschappen en metagegevens.
get_file_to_stream	Hiermee downloadt u een bestand naar een stream, met automatische segmenterings- en voortgangsmeldingen. Retourneert een exemplaar van File met eigenschappen en metagegevens.
get_file_to_text	Hiermee wordt een bestand gedownload als Unicode-tekst, met automatische segmentering en voortgangsmeldingen. Retourneert een exemplaar van File met eigenschappen, metagegevens en inhoud.
get_permission_for_share	Maak een machtiging (een beveiligingsdescriptor) op shareniveau. Deze machtiging kan worden gebruikt voor de bestanden/mappen in de share. Als er al een 'machtiging' bestaat, wordt de sleutel ervan geretourneerd, anders wordt er een nieuwe machtiging op shareniveau gemaakt en wordt de sleutel geretourneerd. :retourneert een bestandsmachtiging (een draagbare SDDL) :rtype str
get_share_acl	Hiermee haalt u de machtigingen voor de opgegeven share op.
get_share_metadata	Retourneert alle door de gebruiker gedefinieerde metagegevens voor de opgegeven share.
get_share_properties	Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven share. De geretourneerde gegevens bevatten niet de lijst met bestanden of mappen van de shares.
get_share_stats	Hiermee wordt de geschatte grootte opgehaald van de gegevens die zijn opgeslagen op de share, naar boven afgerond op de dichtstbijzijnde gigabyte. Houd er rekening mee dat deze waarde mogelijk niet alle onlangs gemaakte of onlangs opnieuw gemaakte bestanden bevat.
get_share_stats_in_bytes	Hiermee wordt de geschatte grootte opgehaald van de gegevens die zijn opgeslagen op de share in bytes. Houd er rekening mee dat deze waarde mogelijk niet alle onlangs gemaakte of onlangs opnieuw gemaakte bestanden bevat.
list_directories_and_files	Retourneert een generator om de mappen en bestanden onder de opgegeven share weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle mappen en bestanden zijn geretourneerd of num_results is bereikt. Als num_results is opgegeven en de share meer dan dat aantal bestanden en mappen heeft, heeft de generator een ingevuld next_marker veld zodra deze is voltooid. Deze markering kan worden gebruikt om een nieuwe generator te maken als er meer resultaten worden gewenst.
list_handles	Retourneert een generator om geopende ingangen in een map of een bestand onder de opgegeven share weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle ingangen zijn geretourneerd of num_results is bereikt. Als num_results is opgegeven en de share meer dan dat aantal bestanden en mappen heeft, heeft de generator een ingevuld next_marker veld zodra deze is voltooid. Deze markering kan worden gebruikt om een nieuwe generator te maken als er meer resultaten worden gewenst.
list_ranges	Hiermee haalt u de geldige bereiken voor een bestand op.
list_shares	Retourneert een generator om de shares onder het opgegeven account weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle shares zijn geretourneerd of num_results is bereikt. Als num_results is opgegeven en het account meer dan dat aantal shares heeft, heeft de generator een ingevuld next_marker veld zodra het is voltooid. Deze markering kan worden gebruikt om een nieuwe generator te maken als er meer resultaten worden gewenst.
make_file_url	Hiermee maakt u de URL voor toegang tot een bestand.
resize_file	Hiermee wijzigt u de grootte van een bestand in de opgegeven grootte. Als de opgegeven bytewaarde kleiner is dan de huidige grootte van het bestand, worden alle bereiken boven de opgegeven bytewaarde gewist.
set_directory_metadata	Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven map. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de map zijn gekoppeld. Als u alle metagegevens uit de map wilt verwijderen, roept u deze bewerking aan zonder metagegevensdicteren.
set_directory_properties
set_file_metadata	Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor het opgegeven bestand in als een of meer naam-waardeparen.
set_file_properties	Hiermee stelt u systeemeigenschappen voor het bestand in. Als er één eigenschap is ingesteld voor de content_settings, worden alle eigenschappen overschreven.
set_file_service_properties	Hiermee stelt u de eigenschappen van de bestandsservice van een opslagaccount in, waaronder Azure Opslaganalyse. Als een element (bijvoorbeeld HourMetrics) wordt achtergelaten op Geen, blijven de bestaande instellingen in de service voor die functionaliteit behouden.
set_proxy	Hiermee stelt u de host en poort van de proxyserver in voor de HTTP CONNECT-tunneling.
set_share_acl	Hiermee stelt u de machtigingen in voor de opgegeven share of het opgeslagen toegangsbeleid dat kan worden gebruikt met Shared Access Signatures.
set_share_metadata	Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven share. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de share zijn gekoppeld. Als u alle metagegevens uit de share wilt verwijderen, roept u deze bewerking aan zonder metagegevensdicteerfunctie.
set_share_properties	Hiermee stelt u service-gedefinieerde eigenschappen voor de opgegeven share.
snapshot_share	Hiermee maakt u een momentopname van een bestaande share onder het opgegeven account.
update_range	Schrijft de bytes die zijn opgegeven door de aanvraagbody naar het opgegeven bereik.
update_range_from_file_url	Schrijft de bytes van het ene Azure File-eindpunt naar het opgegeven bereik van een ander Azure File-eindpunt.

abort_copy_file

Hiermee wordt een in behandeling zijnde copy_file bewerking afgebroken en blijft een doelbestand met de lengte nul en volledige metagegevens behouden.

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

Parameters

Name	Description
share_name Vereist	str Naam van de doelshare.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van het doelbestand.
copy_id Vereist	str Kopieer de id die is opgegeven in de copy.id van de oorspronkelijke copy_file bewerking.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

clear_range

Wist het opgegeven bereik en maakt de ruimte vrij die in de opslag voor dat bereik wordt gebruikt.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
start_range Vereist	int Begin van bytebereik dat moet worden gebruikt voor het wissen van een sectie van het bestand. Het bereik kan maximaal 4 MB groot zijn. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand.
end_range Vereist	int Einde van het bytebereik dat moet worden gebruikt voor het wissen van een sectie van het bestand. Het bereik kan maximaal 4 MB groot zijn. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

close_handles

Retourneert een generator om geopende ingangen in een map of een bestand onder de opgegeven share te sluiten. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle ingangen zijn gesloten. De geretourneerde waarden vertegenwoordigen het aantal ingangen dat in elke transactie is gesloten.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name	str Het pad naar de map. standaardwaarde: None
file_name	str Naam van bestaand bestand. standaardwaarde: None
recursive	bool Booleaanse waarde die aangeeft of de bewerking moet worden toegepast op de map die is opgegeven in de URI, de bestanden, de submappen en de bijbehorende bestanden. standaardwaarde: None
handle_id	str Vereist. Hiermee geeft u de handle-id op die wordt geopend in het bestand of de map die moet worden gesloten. Astrix ('*') is een jokerteken waarmee alle grepen worden opgegeven. standaardwaarde: None
marker	str Een ondoorzichtig vervolgtoken. Deze waarde kan worden opgehaald uit het next_marker veld van een eerder generatorobject als het sluiten van ingangen nog niet is voltooid. Indien opgegeven, begint deze generator met het sluiten van ingangen vanaf het punt waar de vorige generator is gestopt. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

copy_file

Een bestand asynchroon kopiëren. Met deze bewerking wordt een eigenschapsobject voor de kopieerbewerking geretourneerd, inclusief een kopieer-id die u kunt gebruiken om de kopieerbewerking te controleren of af te breken. De File-service kopieert bestanden naar beste vermogen.

Als het doelbestand bestaat, wordt het overschreven. Het doelbestand kan niet worden gewijzigd terwijl de kopieerbewerking wordt uitgevoerd.

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

Parameters

Name	Description
share_name Vereist	str Naam van de doelshare. De share moet bestaan.
directory_name Vereist	str Naam van de doelmap. De map moet bestaan.
file_name Vereist	str Naam van het doelbestand. Als het doelbestand bestaat, wordt het overschreven. Anders wordt het gemaakt.
copy_source Vereist	str Een URL van maximaal 2 kB die een Azure-bestand of blob aangeeft. De waarde moet URL-gecodeerd zijn zoals deze wordt weergegeven in een aanvraag-URI. Als de bron zich in een ander account bevindt, moet de bron openbaar zijn of moeten worden geverifieerd via een shared access signature. Als de bron openbaar is, is er geen verificatie vereist. Voorbeelden: https://myaccount.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
metadata	dict(str, str)<xref:./> Naam-waardeparen die als metagegevens aan het bestand zijn gekoppeld. Als er geen naam-waardeparen zijn opgegeven, kopieert de bewerking de metagegevens van de bron-blob of het bronbestand naar het doelbestand. Als een of meer naam-waardeparen zijn opgegeven, wordt het doelbestand gemaakt met de opgegeven metagegevens en worden de metagegevens niet gekopieerd uit de bron-blob of het bronbestand. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
CopyProperties	Eigenschappen van de kopieerbewerking, zoals status, bron en id.

create_directory

Hiermee maakt u een nieuwe map onder de opgegeven share of bovenliggende map. Als de map met dezelfde naam al bestaat, mislukt de bewerking in de service. Standaard wordt de uitzondering door de client ingeslikt. Als u de uitzondering wilt zichtbaar maken, geeft u True op voor fail_on_exists.

create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Naam van de map die moet worden gemaakt, inclusief het pad naar de bovenliggende map.
metadata	dict(str, str)<xref::> Een dict met name_value paren om als metagegevens aan de share te koppelen. Voorbeeld:{'Category':'test'} standaardwaarde: None
fail_on_exist	bool opgeven of er een uitzondering moet worden gegenereerd wanneer de map bestaat. Standaard onwaar. standaardwaarde: False
file_permission	str Bestandsmachtiging, een draagbare SDDL standaardwaarde: None
smb_properties	SMBProperties Hiermee stelt u de eigenschappen van het SMB-gerelateerde bestand in
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
bool	Waar als de map is gemaakt, Onwaar als de map al bestaat.

create_file

Hiermee maakt u een nieuw bestand.

Zie create_file_from_* voor functies op hoog niveau die het maken en uploaden van grote bestanden afhandelen met automatische segmentering en voortgangsmeldingen.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van het bestand dat u wilt maken of bijwerken.
content_length Vereist	int Lengte van het bestand in bytes.
content_settings	ContentSettings ContentSettings-object dat wordt gebruikt om bestandseigenschappen in te stellen. standaardwaarde: None
metadata	dict(str, str) Naam-waardeparen die als metagegevens aan het bestand zijn gekoppeld. standaardwaarde: None
file_permission	str Bestandsmachtiging, een draagbare SDDL standaardwaarde: None
smb_properties	SMBProperties Hiermee stelt u de eigenschappen van het SMB-gerelateerde bestand in
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

create_file_from_bytes

Hiermee maakt u een nieuw bestand op basis van een matrix van bytes of werkt u de inhoud van een bestaand bestand bij met automatische segmentering en voortgangsmeldingen.

create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestand dat moet worden gemaakt of bijgewerkt.
file Vereist	str Inhoud van bestand als een matrix van bytes.
index	int Index starten in de matrix van bytes. standaardwaarde: 0
count	int Aantal bytes dat moet worden geüpload. Stel in op Geen of negatieve waarde om alle bytes te uploaden vanaf index. standaardwaarde: None
content_settings	ContentSettings ContentSettings-object dat wordt gebruikt om bestandseigenschappen in te stellen. standaardwaarde: None
metadata	dict(str, str) Naam-waardeparen die als metagegevens aan het bestand zijn gekoppeld. standaardwaarde: None
validate_content	bool Indien waar, berekent u een MD5-hash voor elk bereik van het bestand. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen bij het bestand. standaardwaarde: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Callback voor voortgang met de handtekeningfunctie (huidig, totaal) waarbij huidig het aantal bytes is dat tot nu toe is overgedragen en totaal de grootte van het bestand is, of Geen als de totale grootte onbekend is. standaardwaarde: None
max_connections	int Maximum aantal parallelle verbindingen dat moet worden gebruikt. standaardwaarde: 2
file_permission	str Bestandsmachtiging, een draagbare SDDL standaardwaarde: None
smb_properties	SMBProperties Hiermee stelt u de eigenschappen van het SMB-gerelateerde bestand in
timeout	int De time-outparameter wordt uitgedrukt in seconden. Deze methode kan meerdere aanroepen naar de Azure-service uitvoeren en de time-out is van toepassing op elke aanroep afzonderlijk. standaardwaarde: None

create_file_from_path

Hiermee maakt u een nieuw Azure-bestand op basis van een lokaal bestandspad of werkt u de inhoud van een bestaand bestand bij met automatische segmentering en voortgangsmeldingen.

create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestand dat moet worden gemaakt of bijgewerkt.
local_file_path Vereist	str Pad van het lokale bestand dat moet worden geüpload als de bestandsinhoud.
content_settings	ContentSettings ContentSettings-object dat wordt gebruikt voor het instellen van bestandseigenschappen. standaardwaarde: None
metadata	dict(str, str) Naam-waardeparen die als metagegevens aan het bestand zijn gekoppeld. standaardwaarde: None
validate_content	bool Indien waar, berekent u een MD5-hash voor elk bereik van het bestand. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen bij het bestand. standaardwaarde: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Callback voor voortgang met de handtekeningfunctie (huidig, totaal) waarbij huidig het aantal bytes is dat tot nu toe is overgedragen en totaal de grootte van het bestand is, of Geen als de totale grootte onbekend is. standaardwaarde: None
max_connections	int Maximum aantal parallelle verbindingen dat moet worden gebruikt. standaardwaarde: 2
file_permission	str Bestandsmachtiging, een draagbare SDDL standaardwaarde: None
smb_properties	SMBProperties Hiermee stelt u de eigenschappen van het SMB-gerelateerde bestand in
timeout	int De time-outparameter wordt uitgedrukt in seconden. Deze methode kan meerdere aanroepen naar de Azure-service uitvoeren en de time-out is van toepassing op elke aanroep afzonderlijk. standaardwaarde: None

create_file_from_stream

Hiermee maakt u een nieuw bestand op basis van een bestand/stream of werkt u de inhoud van een bestaand bestand bij met automatische segmentering en voortgangsmeldingen.

create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestand dat moet worden gemaakt of bijgewerkt.
stream Vereist	IOBase Geopend bestand/stream om als bestandsinhoud te uploaden.
count Vereist	int Het aantal bytes dat uit de stream moet worden gelezen. Dit is vereist. Er kan geen bestand worden gemaakt als het aantal onbekend is.
content_settings	ContentSettings ContentSettings-object dat wordt gebruikt om bestandseigenschappen in te stellen. standaardwaarde: None
metadata	dict(str, str) Naam-waardeparen die als metagegevens aan het bestand zijn gekoppeld. standaardwaarde: None
validate_content	bool Indien waar, berekent u een MD5-hash voor elk bereik van het bestand. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen bij het bestand. standaardwaarde: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Callback voor voortgang met de handtekeningfunctie (huidig, totaal) waarbij huidig het aantal bytes is dat tot nu toe is overgedragen en totaal de grootte van het bestand is, of Geen als de totale grootte onbekend is. standaardwaarde: None
max_connections	int Maximum aantal parallelle verbindingen dat moet worden gebruikt. Houd er rekening mee dat parallel uploaden vereist dat de stream kan worden gezocht. standaardwaarde: 2
file_permission	str Bestandsmachtiging, een draagbare SDDL standaardwaarde: None
smb_properties	SMBProperties Hiermee stelt u de eigenschappen van het SMB-gerelateerde bestand in
timeout	int De time-outparameter wordt uitgedrukt in seconden. Deze methode kan meerdere aanroepen naar de Azure-service uitvoeren en de time-out is van toepassing op elke aanroep afzonderlijk. standaardwaarde: None

create_file_from_text

Hiermee maakt u een nieuw bestand op basis van str/unicode of werkt u de inhoud van een bestaand bestand bij met automatische segmentering en voortgangsmeldingen.

create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestand dat moet worden gemaakt of bijgewerkt.
text Vereist	str Tekst die u wilt uploaden naar het bestand.
encoding	str Python-codering om te gebruiken om de tekst te converteren naar bytes. standaardwaarde: utf-8
content_settings	ContentSettings ContentSettings-object dat wordt gebruikt om bestandseigenschappen in te stellen. standaardwaarde: None
metadata	dict(str, str) Naam-waardeparen die als metagegevens aan het bestand zijn gekoppeld. standaardwaarde: None
validate_content	bool Indien waar, berekent u een MD5-hash voor elk bereik van het bestand. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen bij het bestand. standaardwaarde: False
file_permission	str Bestandsmachtiging, een draagbare SDDL standaardwaarde: None
smb_properties	SMBProperties Hiermee stelt u de eigenschappen van het SMB-gerelateerde bestand in
timeout	int De time-outparameter wordt uitgedrukt in seconden. Deze methode kan meerdere aanroepen naar de Azure-service uitvoeren en de time-out is van toepassing op elke aanroep afzonderlijk. standaardwaarde: None

Maak een machtiging (een beveiligingsdescriptor) op shareniveau. Deze machtiging kan worden gebruikt voor de bestanden/mappen in de share. Als er al een 'machtiging' bestaat, wordt de sleutel ervan geretourneerd, anders wordt er een nieuwe machtiging op shareniveau gemaakt en wordt de sleutel geretourneerd.

:retourneert een bestandsmachtigingssleutel :rtype str

create_permission_for_share(share_name, file_permission, timeout=None)

Parameters

Name	Description
share_name Vereist	Naam van share.
file_permission Vereist	Bestandsmachtiging, een draagbare SDDL
timeout	De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Hiermee maakt u een nieuwe share onder het opgegeven account. Als de share met dezelfde naam al bestaat, mislukt de bewerking voor de service. Standaard wordt de uitzondering door de client ingeslikt. Als u de uitzondering wilt zichtbaar maken, geeft u Waar op voor fail_on_exists.

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

Parameters

Name	Description
share_name Vereist	str De naam van de share die moet worden gemaakt.
metadata	dict(str, str) Een dict met name_value paren om als metagegevens aan de share te koppelen. Voorbeeld:{'Category':'test'} standaardwaarde: None
quota	int Hiermee geeft u de maximale grootte van de share, in gigabytes. Moet groter zijn dan 0 en kleiner dan of gelijk aan 5 TB (5120). standaardwaarde: None
fail_on_exist	bool Geef op of er een uitzondering moet worden gegenereerd wanneer de share bestaat. Standaard onwaar. standaardwaarde: False
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
bool	Waar als de share is gemaakt, Onwaar als de share al bestaat.

delete_directory

Hiermee verwijdert u de opgegeven lege map. Houd er rekening mee dat de map leeg moet zijn voordat deze kan worden verwijderd. Het verwijderen van mappen die niet leeg zijn, mislukt.

Als de map niet bestaat, mislukt de bewerking voor de service. Standaard wordt de uitzondering door de client ingeslikt. Als u de uitzondering wilt zichtbaar maken, geeft u Waar op voor fail_not_exist.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Naam van de map die u wilt verwijderen, inclusief het pad naar de bovenliggende map.
fail_not_exist	bool Geef op of er een uitzondering moet worden gegenereerd wanneer de map niet bestaat. standaardwaarde: False
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
bool	Waar als de map is verwijderd, anders Onwaar.

delete_file

Hiermee wordt het opgegeven bestand gemarkeerd voor verwijdering. Het bestand wordt later verwijderd tijdens de garbagecollection.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Hiermee wordt de opgegeven share gemarkeerd voor verwijdering. Als de share niet bestaat, mislukt de bewerking voor de service. Standaard wordt de uitzondering door de client ingeslikt. Als u de uitzondering wilt zichtbaar maken, geeft u Waar op voor fail_not_exist.

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

Parameters

Name	Description
share_name Vereist	str De naam van de share die moet worden verwijderd.
fail_not_exist	bool Geef op of er een uitzondering moet worden gegenereerd wanneer de share niet bestaat. Standaard onwaar. standaardwaarde: False
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de momentopnameversie vertegenwoordigt, indien van toepassing. Geef dit argument op om alleen een specifieke momentopname te verwijderen. delete_snapshots moet Geen zijn als dit is opgegeven. standaardwaarde: None
delete_snapshots	DeleteSnapshot Als u een share met momentopnamen wilt verwijderen, moet dit worden opgegeven als DeleteSnapshot.Include. standaardwaarde: None

Retouren

Type	Description
bool	Waar als de share is verwijderd, bestaat de onjuiste share niet.

exists

Retourneert een booleaanse waarde die aangeeft of de share bestaat als alleen de sharenaam wordt opgegeven. Als directory_name is opgegeven, wordt er een booleaanse waarde geretourneerd die aangeeft of de map bestaat. Als file_name ook is opgegeven, wordt er een booleaanse waarde geretourneerd die aangeeft of het bestand bestaat.

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

Parameters

Name	Description
share_name Vereist	str Naam van een share.
directory_name	str Het pad naar een map. standaardwaarde: None
file_name	str Naam van een bestand. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de momentopnameversie vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
bool	Een booleaanse waarde die aangeeft of de resource bestaat.

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Parameters

Name	Description
retry_context Vereist

generate_account_shared_access_signature

Hiermee genereert u een Shared Access Signature voor de bestandsservice. Gebruik de geretourneerde handtekening met de parameter sas_token van de FileService.

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

Parameters

Name	Description
resource_types Vereist	<xref:ResourceTypes> Hiermee geeft u de resourcetypen op die toegankelijk zijn met de account-SAS.
permission Vereist	<xref:AccountPermissions> De machtigingen die zijn gekoppeld aan de handtekening voor gedeelde toegang. De gebruiker is beperkt tot bewerkingen die zijn toegestaan door de machtigingen. Vereist, tenzij een id wordt opgegeven die verwijst naar een opgeslagen toegangsbeleid dat dit veld bevat. Dit veld moet worden weggelaten als het is opgegeven in een gekoppeld opgeslagen toegangsbeleid.
expiry Vereist	datetime of str Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Vereist, tenzij een id wordt opgegeven die verwijst naar een opgeslagen toegangsbeleid dat dit veld bevat. Dit veld moet worden weggelaten als het is opgegeven in een gekoppeld opgeslagen toegangsbeleid. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is.
start	datetime of str Het tijdstip waarop de handtekening voor gedeelde toegang geldig wordt. Als u dit weglaat, wordt ervan uitgegaan dat de begintijd voor deze aanroep het tijdstip is waarop de opslagservice de aanvraag ontvangt. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. standaardwaarde: None
ip	str Hiermee geeft u een IP-adres of een bereik van IP-adressen van waaruit aanvragen te accepteren. Als het IP-adres van waaruit de aanvraag afkomstig is, niet overeenkomt met het IP-adres of het adresbereik dat is opgegeven in het SAS-token, wordt de aanvraag niet geverifieerd. Als u bijvoorbeeld sip=168.1.5.65 of sip=168.1.5.60-168.1.5.70 op de SAS opgeeft, wordt de aanvraag beperkt tot deze IP-adressen. standaardwaarde: None
protocol	str Hiermee geeft u het protocol op dat is toegestaan voor een aanvraag die is ingediend. Mogelijke waarden zijn zowel HTTPS als HTTP (https,http) of alleen HTTPS (https). De standaardwaarde is https,http. Houd er rekening mee dat alleen HTTP geen toegestane waarde is. standaardwaarde: None

Retouren

Type	Description
str	Een Sas-token (Shared Access Signature).

generate_file_shared_access_signature

Hiermee genereert u een Shared Access Signature voor het bestand. Gebruik de geretourneerde handtekening met de parameter sas_token fileservice.

generate_file_shared_access_signature(share_name, directory_name=None, file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Parameters

Name	Description
share_name Vereist	str Naam van share.
directory_name	str Naam van map. SAS-tokens kunnen niet worden gemaakt voor directory's, dus deze parameter mag alleen aanwezig zijn als file_name is opgegeven. standaardwaarde: None
file_name	str Naam van bestand. standaardwaarde: None
permission	FilePermissions De machtigingen die zijn gekoppeld aan de handtekening voor gedeelde toegang. De gebruiker is beperkt tot bewerkingen die zijn toegestaan door de machtigingen. Machtigingen moeten worden gesorteerd op lezen, maken, schrijven, verwijderen, lijst. Vereist, tenzij een id wordt opgegeven die verwijst naar een opgeslagen toegangsbeleid dat dit veld bevat. Dit veld moet worden weggelaten als het is opgegeven in een gekoppeld opgeslagen toegangsbeleid. standaardwaarde: None
expiry	datetime of str Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Vereist, tenzij een id wordt opgegeven die verwijst naar een opgeslagen toegangsbeleid dat dit veld bevat. Dit veld moet worden weggelaten als het is opgegeven in een gekoppeld opgeslagen toegangsbeleid. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. standaardwaarde: None
start	datetime of str Het tijdstip waarop de handtekening voor gedeelde toegang geldig wordt. Als u dit weglaat, wordt ervan uitgegaan dat de begintijd voor deze aanroep het tijdstip is waarop de opslagservice de aanvraag ontvangt. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. standaardwaarde: None
id	str Een unieke waarde van maximaal 64 tekens die overeenkomt met een opgeslagen toegangsbeleid. Gebruik set_file_service_properties om een opgeslagen toegangsbeleid te maken. standaardwaarde: None
ip	str Hiermee geeft u een IP-adres of een bereik van IP-adressen van waaruit aanvragen te accepteren. Als het IP-adres van waaruit de aanvraag afkomstig is, niet overeenkomt met het IP-adres of het adresbereik dat is opgegeven in het SAS-token, wordt de aanvraag niet geverifieerd. Als u bijvoorbeeld sip=168.1.5.65 of sip=168.1.5.60-168.1.5.70 op de SAS opgeeft, wordt de aanvraag beperkt tot deze IP-adressen. standaardwaarde: None
protocol	str Hiermee geeft u het protocol op dat is toegestaan voor een aanvraag die is ingediend. Mogelijke waarden zijn zowel HTTPS als HTTP (https,http) of alleen HTTPS (https). De standaardwaarde is https,http. Houd er rekening mee dat alleen HTTP geen toegestane waarde is. standaardwaarde: None
cache_control	str Antwoordheaderwaarde voor Cache-Control wanneer de resource wordt geopend met behulp van deze Shared Access Signature. standaardwaarde: None
content_disposition	str Antwoordheaderwaarde voor Content-Disposition wanneer de resource wordt geopend met behulp van deze Shared Access Signature. standaardwaarde: None
content_encoding	str Waarde van antwoordheader voor Content-Encoding wanneer de resource wordt geopend met behulp van deze Shared Access Signature. standaardwaarde: None
content_language	str Antwoordheaderwaarde voor Content-Language wanneer de resource wordt geopend met behulp van deze Shared Access Signature. standaardwaarde: None
content_type	str Antwoordheaderwaarde voor Content-Type wanneer de resource wordt geopend met behulp van deze Shared Access Signature. standaardwaarde: None

Retouren

Type	Description
str	Een Sas-token (Shared Access Signature).

Hiermee wordt een shared access signature voor de share gegenereerd. Gebruik de geretourneerde handtekening met de sas_token parameter FileService.

generate_share_shared_access_signature(share_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Parameters

Name	Description
share_name Vereist	str Naam van share.
permission	SharePermissions De machtigingen die zijn gekoppeld aan de Shared Access Signature. De gebruiker is beperkt tot bewerkingen die zijn toegestaan door de machtigingen. Machtigingen moeten worden geordend voor lezen, maken, schrijven, verwijderen, lijst. Vereist tenzij er een id wordt opgegeven die verwijst naar een opgeslagen toegangsbeleid dat dit veld bevat. Dit veld moet worden weggelaten als het is opgegeven in een gekoppeld opgeslagen toegangsbeleid. standaardwaarde: None
expiry	datetime of str Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Vereist tenzij er een id wordt opgegeven die verwijst naar een opgeslagen toegangsbeleid dat dit veld bevat. Dit veld moet worden weggelaten als het is opgegeven in een gekoppeld opgeslagen toegangsbeleid. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. standaardwaarde: None
start	datetime of str Het tijdstip waarop de Shared Access Signature geldig wordt. Als u dit weglaat, wordt ervan uitgegaan dat de begintijd voor deze aanroep het tijdstip is waarop de opslagservice de aanvraag ontvangt. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. standaardwaarde: None
id	str Een unieke waarde van maximaal 64 tekens die overeenkomt met een opgeslagen toegangsbeleid. Gebruik om een opgeslagen toegangsbeleid te maken set_share_acl. standaardwaarde: None
ip	str Hiermee geeft u een IP-adres of een bereik van IP-adressen van waaruit aanvragen te accepteren. Als het IP-adres waaruit de aanvraag afkomstig is, niet overeenkomt met het IP-adres of adresbereik dat is opgegeven in het SAS-token, wordt de aanvraag niet geverifieerd. Als u bijvoorbeeld sip=168.1.5.65 of sip=168.1.5.60-168.1.5.70 opgeeft op de SAS, wordt de aanvraag beperkt tot deze IP-adressen. standaardwaarde: None
protocol	str Hiermee geeft u het protocol op dat is toegestaan voor een aanvraag die is gedaan. Mogelijke waarden zijn zowel HTTPS als HTTP (https,http) of alleen HTTPS (https). De standaardwaarde is https,http. Houd er rekening mee dat alleen HTTP geen toegestane waarde is. standaardwaarde: None
cache_control	str Antwoordheaderwaarde voor Cache-Control wanneer de resource wordt geopend met behulp van deze shared access signature. standaardwaarde: None
content_disposition	str De waarde van de antwoordheader voor Content-Disposition wanneer de resource wordt geopend met behulp van deze Shared Access Signature. standaardwaarde: None
content_encoding	str Antwoordheaderwaarde voor inhoudscodering wanneer de resource wordt geopend met behulp van deze shared access signature. standaardwaarde: None
content_language	str Antwoordheaderwaarde voor Content-Language wanneer de resource wordt geopend met behulp van deze Shared Access Signature. standaardwaarde: None
content_type	str Antwoordheaderwaarde voor Inhoudstype wanneer de resource wordt geopend met behulp van deze Shared Access Signature. standaardwaarde: None

Retouren

Type	Description
str	Een Sas-token (Shared Access Signature).

get_directory_metadata

Retourneert alle door de gebruiker gedefinieerde metagegevens voor de opgegeven map.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
dict(str, str)	Een woordenlijst die de mapmetagegevensnaam en waardeparen vertegenwoordigt.

get_directory_properties

Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven map. De geretourneerde gegevens bevatten niet de lijst met bestanden van de map.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar een bestaande map.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
Directory	eigenschappen voor de opgegeven map in een mapobject.

get_file_metadata

Retourneert alle door de gebruiker gedefinieerde metagegevens voor het opgegeven bestand.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
dict(str, str)	Een woordenlijst die de naam van de metagegevens van het bestand en waardeparen vertegenwoordigt.

get_file_properties

Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het bestand. Retourneert een exemplaar van File met FileProperties en een metagegevensdict.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
File	een bestandsobject met eigenschappen en metagegevens.

get_file_service_properties

Hiermee haalt u de eigenschappen op van de bestandsservice van een opslagaccount, waaronder Azure Opslaganalyse.

get_file_service_properties(timeout=None)

Parameters

Name	Description
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
ServiceProperties	De eigenschappen van de bestandsservice.

get_file_to_bytes

Hiermee downloadt u een bestand als een matrix van bytes, met automatische segmentering en voortgangsmeldingen. Retourneert een exemplaar van File met eigenschappen, metagegevens en inhoud.

get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
start_range	int Begin van het bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Als er geen end_range wordt gegeven, worden alle bytes na de start_range gedownload. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
end_range	int Einde van bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Als end_range wordt gegeven, moet start_range worden opgegeven. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
validate_content	bool Indien ingesteld op true, valideert een MD5-hash voor elk opgehaald gedeelte van het bestand. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat de service alleen transactionele MD5's retourneert voor segmenten van 4 MB of minder, zodat de eerste aanvraag voor ophalen zelf de grootte heeft. MAX_CHUNK_GET_SIZE in plaats van zelf. MAX_SINGLE_GET_SIZE. Als het zelf is. MAX_CHUNK_GET_SIZE is ingesteld op meer dan 4 MB, wordt er een fout gegenereerd. Omdat het berekenen van de MD5 verwerkingstijd kost en er meer aanvragen moeten worden uitgevoerd vanwege de kleinere segmentgrootte, kan er enige toename van de latentie optreden. standaardwaarde: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Callback voor voortgang met handtekeningfunctie (huidig, totaal) waarbij huidige het aantal bytes is dat tot nu toe is overgedragen en totaal de grootte van het bestand is, indien bekend. standaardwaarde: None
max_connections	int Als dit is ingesteld op 2 of hoger, wordt een eerste keer get uitgevoerd voor de eerste zelf. MAX_SINGLE_GET_SIZE bytes van het bestand. Als dit het hele bestand is, retourneert de methode op dit punt. Als dat niet zo is, worden de resterende gegevens parallel gedownload met behulp van het aantal threads dat gelijk is aan max_connections. Elk segment heeft zelf de grootte. MAX_CHUNK_GET_SIZE. Als dit is ingesteld op 1, wordt één grote get-aanvraag uitgevoerd. Dit wordt over het algemeen niet aanbevolen, maar is beschikbaar als er zeer weinig threads moeten worden gebruikt, netwerkaanvragen erg duur zijn of als een niet-doorzoekbare stroom parallelle downloads verhindert. Dit kan ook waardevol zijn als het bestand gelijktijdig wordt gewijzigd om atomiciteit af te dwingen of als veel bestanden naar verwachting leeg zijn, omdat er een extra aanvraag is vereist voor lege bestanden als max_connections groter is dan 1. standaardwaarde: 2
timeout	int De time-outparameter wordt uitgedrukt in seconden. Met deze methode kunnen meerdere aanroepen naar de Azure-service worden uitgevoerd en de time-out is van toepassing op elke aanroep afzonderlijk. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
File	Een bestand met eigenschappen, inhoud en metagegevens.

get_file_to_path

Hiermee downloadt u een bestand naar een bestandspad, met automatische segmentering en voortgangsmeldingen. Retourneert een exemplaar van Bestand met eigenschappen en metagegevens.

get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
file_path Vereist	str Pad van het bestand om naar te schrijven.
open_mode	str Modus die moet worden gebruikt bij het openen van het bestand. Houd er rekening mee dat het opgeven van alleen toevoegen open_mode parallel downloaden voorkomt. Max_connections moet dus worden ingesteld op 1 als deze open_mode wordt gebruikt. standaardwaarde: wb
start_range	int Begin van het bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Als er geen end_range wordt opgegeven, worden alle bytes na de start_range gedownload. De start_range en end_range zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
end_range	int Einde van bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Als end_range wordt opgegeven, moet start_range worden opgegeven. De start_range en end_range zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
validate_content	bool Indien ingesteld op true, valideert een MD5-hash voor elk opgehaald gedeelte van het bestand. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat de service alleen transactionele MD5's retourneert voor segmenten van 4 MB of minder, dus de eerste get-aanvraag is van de grootte zelf. MAX_CHUNK_GET_SIZE in plaats van zelf. MAX_SINGLE_GET_SIZE. Als je zelf bent. MAX_CHUNK_GET_SIZE is ingesteld op meer dan 4 MB, wordt er een fout gegenereerd. Omdat het berekenen van de MD5 verwerkingstijd kost en er meer aanvragen moeten worden uitgevoerd vanwege de kleinere segmentgrootte, kan de latentie enigszins toenemen. standaardwaarde: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Callback voor voortgang met de handtekeningfunctie (huidig, totaal) waarbij huidige het aantal bytes is dat tot nu toe is overgedragen en het totaal de grootte van het bestand is, indien bekend. standaardwaarde: None
max_connections	int Als deze optie is ingesteld op 2 of hoger, wordt een eerste keer get uitgevoerd voor de eerste zelf. MAX_SINGLE_GET_SIZE bytes van het bestand. Als dit het hele bestand is, retourneert de methode op dit punt. Als dat niet zo is, worden de resterende gegevens parallel gedownload met behulp van het aantal threads dat gelijk is aan max_connections. Elk segment heeft de grootte zelf. MAX_CHUNK_GET_SIZE. Als dit is ingesteld op 1, wordt één grote get-aanvraag uitgevoerd. Dit wordt over het algemeen niet aanbevolen, maar is beschikbaar als er zeer weinig threads moeten worden gebruikt, netwerkaanvragen erg duur zijn of als een niet-doorzoekbare stroom parallelle download verhindert. Dit kan ook waardevol zijn als het bestand gelijktijdig wordt gewijzigd om atomiciteit af te dwingen of als veel bestanden naar verwachting leeg zijn, omdat een extra aanvraag vereist is voor lege bestanden als max_connections groter is dan 1. standaardwaarde: 2
timeout	int De time-outparameter wordt uitgedrukt in seconden. Deze methode kan meerdere aanroepen naar de Azure-service uitvoeren en de time-out is van toepassing op elke aanroep afzonderlijk. standaardwaarde: None
snapshot	str Een tekenreeks die de momentopnameversie vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
File	Een bestand met eigenschappen en metagegevens.

get_file_to_stream

Hiermee downloadt u een bestand naar een stream, met automatische segmenterings- en voortgangsmeldingen. Retourneert een exemplaar van File met eigenschappen en metagegevens.

get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
stream Vereist	IOBase Geopend bestand/stream om naar te schrijven.
start_range	int Begin van het bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Als er geen end_range wordt opgegeven, worden alle bytes na de start_range gedownload. De start_range en end_range zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
end_range	int Einde van bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Als end_range wordt opgegeven, moet start_range worden opgegeven. De start_range en end_range zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
validate_content	bool Indien ingesteld op true, valideert een MD5-hash voor elk opgehaald gedeelte van het bestand. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat de service alleen transactionele MD5's retourneert voor segmenten van 4 MB of minder, dus de eerste get-aanvraag is van de grootte zelf. MAX_CHUNK_GET_SIZE in plaats van zelf. MAX_SINGLE_GET_SIZE. Als je zelf bent. MAX_CHUNK_GET_SIZE is ingesteld op meer dan 4 MB, wordt er een fout gegenereerd. Omdat het berekenen van de MD5 verwerkingstijd kost en er meer aanvragen moeten worden uitgevoerd vanwege de kleinere segmentgrootte, kan de latentie enigszins toenemen. standaardwaarde: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Callback voor voortgang met de handtekeningfunctie (huidig, totaal) waarbij huidige het aantal bytes is dat tot nu toe is overgedragen en het totaal de grootte van het bestand is, indien bekend. standaardwaarde: None
max_connections	int Als deze optie is ingesteld op 2 of hoger, wordt een eerste keer get uitgevoerd voor de eerste zelf. MAX_SINGLE_GET_SIZE bytes van het bestand. Als dit het hele bestand is, retourneert de methode op dit punt. Als dat niet zo is, worden de resterende gegevens parallel gedownload met behulp van het aantal threads dat gelijk is aan max_connections. Elk segment heeft de grootte zelf. MAX_CHUNK_GET_SIZE. Als dit is ingesteld op 1, wordt één grote get-aanvraag uitgevoerd. Dit wordt over het algemeen niet aanbevolen, maar is beschikbaar als er zeer weinig threads moeten worden gebruikt, netwerkaanvragen erg duur zijn of als een niet-doorzoekbare stroom parallelle download verhindert. Dit kan ook waardevol zijn als het bestand gelijktijdig wordt gewijzigd om atomiciteit af te dwingen of als veel bestanden naar verwachting leeg zijn, omdat een extra aanvraag vereist is voor lege bestanden als max_connections groter is dan 1. standaardwaarde: 2
timeout	int De time-outparameter wordt uitgedrukt in seconden. Deze methode kan meerdere aanroepen naar de Azure-service uitvoeren en de time-out is van toepassing op elke aanroep afzonderlijk. standaardwaarde: None
snapshot	str Een tekenreeks die de momentopnameversie vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
File	Een bestand met eigenschappen en metagegevens.

get_file_to_text

Hiermee wordt een bestand gedownload als Unicode-tekst, met automatische segmentering en voortgangsmeldingen. Retourneert een exemplaar van File met eigenschappen, metagegevens en inhoud.

get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
encoding	str Python-codering die moet worden gebruikt bij het decoderen van de bestandsgegevens. standaardwaarde: utf-8
start_range	int Begin van het bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Als er geen end_range wordt opgegeven, worden alle bytes na de start_range gedownload. De start_range en end_range zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
end_range	int Einde van bytebereik dat moet worden gebruikt voor het downloaden van een sectie van het bestand. Als end_range wordt opgegeven, moet start_range worden opgegeven. De start_range en end_range zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
validate_content	bool Indien ingesteld op true, valideert een MD5-hash voor elk opgehaald gedeelte van het bestand. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https, omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat de service alleen transactionele MD5's retourneert voor segmenten van 4 MB of minder, dus de eerste get-aanvraag is van de grootte zelf. MAX_CHUNK_GET_SIZE in plaats van zelf. MAX_SINGLE_GET_SIZE. Als je zelf bent. MAX_CHUNK_GET_SIZE is ingesteld op meer dan 4 MB, wordt er een fout gegenereerd. Omdat het berekenen van de MD5 verwerkingstijd kost en er meer aanvragen moeten worden uitgevoerd vanwege de kleinere segmentgrootte, kan de latentie enigszins toenemen. standaardwaarde: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) Callback voor voortgang met de handtekeningfunctie (huidig, totaal) waarbij huidige het aantal bytes is dat tot nu toe is overgedragen en het totaal de grootte van het bestand is, indien bekend. standaardwaarde: None
max_connections	int Als deze optie is ingesteld op 2 of hoger, wordt een eerste keer get uitgevoerd voor de eerste zelf. MAX_SINGLE_GET_SIZE bytes van het bestand. Als dit het hele bestand is, retourneert de methode op dit punt. Als dat niet zo is, worden de resterende gegevens parallel gedownload met behulp van het aantal threads dat gelijk is aan max_connections. Elk segment heeft de grootte zelf. MAX_CHUNK_GET_SIZE. Als dit is ingesteld op 1, wordt één grote get-aanvraag uitgevoerd. Dit wordt over het algemeen niet aanbevolen, maar is beschikbaar als er zeer weinig threads moeten worden gebruikt, netwerkaanvragen erg duur zijn of als een niet-doorzoekbare stroom parallelle download verhindert. Dit kan ook waardevol zijn als het bestand gelijktijdig wordt gewijzigd om atomiciteit af te dwingen of als veel bestanden naar verwachting leeg zijn, omdat een extra aanvraag vereist is voor lege bestanden als max_connections groter is dan 1. standaardwaarde: 2
timeout	int De time-outparameter wordt uitgedrukt in seconden. Deze methode kan meerdere aanroepen naar de Azure-service uitvoeren en de time-out is van toepassing op elke aanroep afzonderlijk. standaardwaarde: None
snapshot	str Een tekenreeks die de momentopnameversie vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
File	Een bestand met eigenschappen, inhoud en metagegevens.

:retourneert een bestandsmachtiging (een draagbare SDDL) :rtype str

get_permission_for_share(share_name, file_permission_key, timeout=None)

Parameters

Name	Description
share_name Vereist	Naam van share.
file_permission_key Vereist	Sleutel van de bestandsmachtiging om op te halen
timeout	De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Hiermee haalt u de machtigingen voor de opgegeven share op.

get_share_acl(share_name, timeout=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
dict(str, AccessPolicy)	Een woordenlijst met toegangsbeleid dat is gekoppeld aan de share.

Retourneert alle door de gebruiker gedefinieerde metagegevens voor de opgegeven share.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
dict(str, str)	Een woordenlijst die de naam van de metagegevens van de share en waardeparen vertegenwoordigt.

Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven share. De geretourneerde gegevens bevatten niet de lijst met bestanden of mappen van de shares.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
Share	Een share die eigenschappen en metagegevens beschikbaar maakt.

Hiermee wordt de geschatte grootte opgehaald van de gegevens die zijn opgeslagen op de share, naar boven afgerond op de dichtstbijzijnde gigabyte.

Houd er rekening mee dat deze waarde mogelijk niet alle onlangs gemaakte of onlangs opnieuw gemaakte bestanden bevat.

get_share_stats(share_name, timeout=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
int	de geschatte grootte van de gegevens die zijn opgeslagen op de share.

Hiermee wordt de geschatte grootte opgehaald van de gegevens die zijn opgeslagen op de share in bytes.

Houd er rekening mee dat deze waarde mogelijk niet alle onlangs gemaakte of onlangs opnieuw gemaakte bestanden bevat.

get_share_stats_in_bytes(share_name, timeout=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
int	de geschatte grootte van de gegevens die zijn opgeslagen op de share.

list_directories_and_files

Retourneert een generator om de mappen en bestanden onder de opgegeven share weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle mappen en bestanden zijn geretourneerd of num_results is bereikt.

Als num_results is opgegeven en de share meer dan dat aantal bestanden en mappen heeft, heeft de generator een ingevuld next_marker veld zodra deze is voltooid. Deze markering kan worden gebruikt om een nieuwe generator te maken als er meer resultaten worden gewenst.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name	str Het pad naar de map. standaardwaarde: None
num_results	int Hiermee geeft u het maximum aantal bestanden op dat moet worden geretourneerd, inclusief alle mapelementen. Als de aanvraag geen num_results of een waarde opgeeft die groter is dan 5000, retourneert de server maximaal 5000 items. Als u num_results instelt op een waarde die kleiner is dan of gelijk is aan nul, resulteert dit in foutcode 400 (Ongeldige aanvraag). standaardwaarde: None
marker	str Een ondoorzichtig vervolgtoken. Deze waarde kan worden opgehaald uit het veld next_marker van een eerder generatorobject als num_results is opgegeven en die generator klaar is met het inventariseren van de resultaten. Indien opgegeven, begint deze generator met het retourneren van resultaten vanaf het punt waar de vorige generator is gestopt. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
prefix	str Vermeld alleen de bestanden en/of mappen met het opgegeven voorvoegsel. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

list_handles

Retourneert een generator om geopende ingangen in een map of een bestand onder de opgegeven share weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle ingangen zijn geretourneerd of num_results is bereikt.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name	str Het pad naar de map. standaardwaarde: None
file_name	str Naam van bestaand bestand. standaardwaarde: None
recursive	bool Booleaanse waarde die aangeeft of de bewerking moet worden toegepast op de map die is opgegeven in de URI, de bestanden, de submappen en de bijbehorende bestanden. standaardwaarde: None
max_results	int Hiermee geeft u het maximum aantal ingangen op dat wordt gebruikt voor bestanden en/of mappen die moeten worden geretourneerd. Als de aanvraag geen max_results of een waarde opgeeft die groter is dan 5000, retourneert de server maximaal 5000 items. Als u max_results instelt op een waarde die kleiner is dan of gelijk is aan nul, resulteert dit in foutcode 400 (Ongeldige aanvraag). standaardwaarde: None
marker	str Een ondoorzichtig vervolgtoken. Deze waarde kan worden opgehaald uit het veld next_marker van een eerder generatorobject als max_results is opgegeven en die generator klaar is met het inventariseren van de resultaten. Indien opgegeven, begint deze generator met het retourneren van resultaten vanaf het punt waar de vorige generator is gestopt. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

list_ranges

Hiermee haalt u de geldige bereiken voor een bestand op.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
start_range	int Hiermee geeft u de begin offset van bytes waarover bereiken te vermelden. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
end_range	int Hiermee geeft u de eind-offset van bytes waarover een lijst met bereiken. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
snapshot	str Een tekenreeks die de versie van de momentopname vertegenwoordigt, indien van toepassing. standaardwaarde: None

Retouren

Type	Description
<xref:a> list <xref:of> FileRange	een lijst met geldige bereiken

list_shares

Retourneert een generator om de shares onder het opgegeven account weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle shares zijn geretourneerd of num_results is bereikt.

Als num_results is opgegeven en het account meer dan dat aantal shares heeft, heeft de generator een ingevuld next_marker veld zodra het is voltooid. Deze markering kan worden gebruikt om een nieuwe generator te maken als er meer resultaten worden gewenst.

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

Parameters

Name	Description
prefix	str Filtert de resultaten om alleen shares te retourneren waarvan de naam begint met het opgegeven voorvoegsel. standaardwaarde: None
num_results	int Hiermee geeft u het maximum aantal shares op dat moet worden geretourneerd. standaardwaarde: None
include_metadata	bool Hiermee geeft u op dat metagegevens van de share worden geretourneerd in het antwoord. standaardwaarde: False
marker	str Een ondoorzichtig vervolgtoken. Deze waarde kan worden opgehaald uit het veld next_marker van een eerder generatorobject als num_results is opgegeven en die generator klaar is met het inventariseren van de resultaten. Indien opgegeven, begint deze generator met het retourneren van resultaten vanaf het punt waar de vorige generator is gestopt. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None
include_snapshots	bool Hiermee geeft u op dat momentopnamen van shares worden geretourneerd in het antwoord. standaardwaarde: False

make_file_url

Hiermee maakt u de URL voor toegang tot een bestand.

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

Parameters

Name	Description
share_name Vereist	str Naam van share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestand.
protocol	str Te gebruiken protocol: 'http' of 'https'. Als dit niet is opgegeven, wordt het protocol gebruikt dat is opgegeven toen FileService werd geïnitialiseerd. standaardwaarde: None
sas_token	str Shared Access Signature-token gemaakt met generate_shared_access_signature. standaardwaarde: None

Retouren

Type	Description
str	URL voor bestandstoegang.

resize_file

Hiermee wijzigt u de grootte van een bestand in de opgegeven grootte. Als de opgegeven bytewaarde kleiner is dan de huidige grootte van het bestand, worden alle bereiken boven de opgegeven bytewaarde gewist.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
content_length Vereist	int De lengte om het formaat van het bestand in te wijzigen.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

set_directory_metadata

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven map. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de map zijn gekoppeld. Als u alle metagegevens uit de map wilt verwijderen, roept u deze bewerking aan zonder metagegevensdicteren.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
metadata	dict(str, str)<xref:./> Een dict met naam-waardeparen die als metagegevens aan de map moeten worden gekoppeld. Voorbeeld: {'category':'test'} standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

set_directory_properties

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

Parameters

Name	Description
share_name Vereist	Naam van de share
directory_name Vereist	Naam van de map
file_permission	str Bestandsmachtiging, een draagbare SDDL standaardwaarde: None
smb_properties	SMBProperties Hiermee stelt u de eigenschappen van het SMB-gerelateerde bestand in
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

set_file_metadata

Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor het opgegeven bestand in als een of meer naam-waardeparen.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
metadata	dict(str, str) Dict met naam- en waardeparen. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan het bestand zijn gekoppeld. Als u alle metagegevens uit het bestand wilt verwijderen, roept u deze bewerking aan zonder metagegevensheaders. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

set_file_properties

Hiermee stelt u systeemeigenschappen voor het bestand in. Als er één eigenschap is ingesteld voor de content_settings, worden alle eigenschappen overschreven.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
content_settings Vereist	ContentSettings ContentSettings-object dat wordt gebruikt om de bestandseigenschappen in te stellen.
file_permission	str Bestandsmachtiging, een draagbare SDDL standaardwaarde: None
smb_properties	SMBProperties Hiermee stelt u de eigenschappen van het SMB-gerelateerde bestand in
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

set_file_service_properties

Hiermee stelt u de eigenschappen van de bestandsservice van een opslagaccount in, waaronder Azure Opslaganalyse. Als een element (bijvoorbeeld HourMetrics) wordt achtergelaten op Geen, blijven de bestaande instellingen in de service voor die functionaliteit behouden.

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

Parameters

Name	Description
hour_metrics	<xref:Metrics> De instellingen voor metrische uurgegevens bieden een overzicht van aanvraagstatistieken gegroepeerd per API in aggregaties per uur voor bestanden. standaardwaarde: None
minute_metrics	<xref:Metrics> De instellingen voor metrische minuutgegevens bieden aanvraagstatistieken voor elke minuut voor bestanden. standaardwaarde: None
cors	list(CorsRule) U kunt maximaal vijf CorsRule-elementen in de lijst opnemen. Als er een lege lijst is opgegeven, worden alle CORS-regels verwijderd en CORS uitgeschakeld voor de service. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

set_proxy

Hiermee stelt u de host en poort van de proxyserver in voor de HTTP CONNECT-tunneling.

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

Parameters

Name	Description
host Vereist	str Adres van de proxy. Bijvoorbeeld: '192.168.0.100'
port Vereist	int Poort van de proxy. Bijvoorbeeld: 6000
user	str Gebruiker voor proxyautorisatie. standaardwaarde: None
password	str Wachtwoord voor proxyautorisatie. standaardwaarde: None

Hiermee stelt u de machtigingen in voor de opgegeven share of het opgeslagen toegangsbeleid dat kan worden gebruikt met Shared Access Signatures.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
signed_identifiers	dict(str, AccessPolicy) Een woordenlijst met toegangsbeleidsregels die aan de share moeten worden gekoppeld. De woordenlijst kan maximaal 5 elementen bevatten. Met een lege woordenlijst wordt het toegangsbeleid dat voor de service is ingesteld, gewist. standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven share. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de share zijn gekoppeld. Als u alle metagegevens uit de share wilt verwijderen, roept u deze bewerking aan zonder metagegevensdicteerfunctie.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
metadata	dict(str, str) Een dict met naam-waardeparen die als metagegevens aan de share moeten worden gekoppeld. Voorbeeld: {'category':'test'} standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Hiermee stelt u service-gedefinieerde eigenschappen voor de opgegeven share.

set_share_properties(share_name, quota, timeout=None)

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
quota Vereist	int Hiermee geeft u de maximale grootte van de share, in gigabytes. Moet groter zijn dan 0 en kleiner dan of gelijk aan 5 TB (5120 GB).
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Hiermee maakt u een momentopname van een bestaande share onder het opgegeven account.

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

Parameters

Name	Description
share_name Vereist	str De naam van de share waarvan u een momentopname wilt maken.
metadata	<xref:<xref:a dict> of <xref:str to str:>> Een dict met name_value paren om als metagegevens aan de share te koppelen. Voorbeeld:{'Category':'test'} standaardwaarde: None
quota	int Hiermee geeft u de maximale grootte van de share, in gigabytes. Moet groter zijn dan 0 en kleiner dan of gelijk aan 5 TB (5120). standaardwaarde: None
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Retouren

Type	Description
Share	momentopname-eigenschappen

update_range

Schrijft de bytes die zijn opgegeven door de aanvraagbody naar het opgegeven bereik.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
data Vereist	bytes Inhoud van het bereik.
start_range Vereist	int Begin van het bytebereik dat moet worden gebruikt voor het bijwerken van een sectie van het bestand. Het bereik kan maximaal 4 MB groot zijn. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand.
end_range Vereist	int Einde van bytebereik dat moet worden gebruikt voor het bijwerken van een sectie van het bestand. Het bereik kan maximaal 4 MB groot zijn. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand.
validate_content	bool Als dit waar is, wordt een MD5-hash van de pagina-inhoud berekend. De opslagservice controleert de hash van de inhoud die is aangekomen met de hash die is verzonden. Dit is vooral waardevol voor het detecteren van bitflips op de draad als u http gebruikt in plaats van https omdat https (de standaardinstelling) al wordt gevalideerd. Houd er rekening mee dat deze MD5-hash niet wordt opgeslagen met het bestand. standaardwaarde: False
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

update_range_from_file_url

Schrijft de bytes van het ene Azure File-eindpunt naar het opgegeven bereik van een ander Azure File-eindpunt.

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

Parameters

Name	Description
share_name Vereist	str Naam van bestaande share.
directory_name Vereist	str Het pad naar de map.
file_name Vereist	str Naam van bestaand bestand.
start_range Vereist	int Begin van het bytebereik dat moet worden gebruikt voor het bijwerken van een sectie van het bestand. Het bereik kan maximaal 4 MB groot zijn. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand.
end_range Vereist	int Einde van bytebereik dat moet worden gebruikt voor het bijwerken van een sectie van het bestand. Het bereik kan maximaal 4 MB groot zijn. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand.
source Vereist	str Een URL van maximaal 2 kB die een Azure-bestand of blob aangeeft. De waarde moet URL-gecodeerd zijn zoals deze wordt weergegeven in een aanvraag-URI. Als de bron zich in een ander account bevindt, moet de bron openbaar zijn of moeten worden geverifieerd via een shared access signature. Als de bron openbaar is, is er geen verificatie vereist. Voorbeelden: https://myaccount.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
source_start_range Vereist	int Begin van het bytebereik dat moet worden gebruikt voor het bijwerken van een sectie van het bestand. Het bereik kan maximaal 4 MB groot zijn. De start_range en end_range parameters zijn inclusief. Bijvoorbeeld: start_range=0, end_range=511 downloadt de eerste 512 bytes aan bestand.
timeout	int De time-outparameter wordt uitgedrukt in seconden. standaardwaarde: None

Kenmerken

protocol

request_session

socket_timeout

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 8388608

MAX_RANGE_SIZE

MAX_RANGE_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432

Delen via

FileService Klas

Constructor

Parameters

Variabelen

Methoden

abort_copy_file

Parameters

clear_range

Parameters

close_handles

Parameters

copy_file

Parameters

Retouren

create_directory

Parameters

Retouren

create_file

Parameters

create_file_from_bytes

Parameters

create_file_from_path

Parameters

create_file_from_stream

Parameters

create_file_from_text

Parameters

create_permission_for_share

Parameters

create_share

Parameters

Retouren

delete_directory

Parameters

Retouren

delete_file

Parameters

delete_share

Parameters

Retouren

exists

Parameters

Retouren

extract_date_and_request_id

Parameters

generate_account_shared_access_signature

Parameters

Retouren

generate_file_shared_access_signature

Parameters

Retouren

generate_share_shared_access_signature

Parameters

Retouren

get_directory_metadata

Parameters

Retouren

get_directory_properties

Parameters

Retouren

get_file_metadata

Parameters

Retouren

get_file_properties

Parameters

Retouren

get_file_service_properties

Parameters

Retouren

get_file_to_bytes

Parameters

Retouren

get_file_to_path

Parameters

Retouren

get_file_to_stream

Parameters

Retouren

get_file_to_text