Dela via

ShareFileClient Klass

  • Referens

En klient för att interagera med en specifik fil, även om filen kanske inte finns ännu.

Klicka här om du vill ha mer valfri konfiguration.

Arv
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin
ShareFileClient

Konstruktor

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

Parametrar

account_url
str
Obligatorisk

URI:n till lagringskontot. Använd classmethod för att skapa en klient med den fullständiga URI:n för filen from_file_url .

share_name
str
Obligatorisk

Namnet på resursen för filen.

file_path
str
Obligatorisk

Filsökvägen till filen som du vill interagera med. Om det här värdet anges åsidosätter det ett filvärde som anges i fil-URL:en.

snapshot
str
standardvärde: None

En valfri filögonblicksbild som ska användas. Detta kan vara ögonblicksbildens ID-sträng eller svaret som returneras från create_snapshot.

credential
standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift

  • utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.
token_intent
Literal['backup']

Krävs när du använder TokenCredential för autentisering och ignoreras för andra former av autentisering. Anger avsikten för alla begäranden när du använder TokenCredential-autentisering . Möjliga värden:

backup – Anger att begäranden är avsedda för säkerhetskopierings-/administratörstypåtgärder, vilket innebär att alla fil-/katalog-ACL:er kringgås och fullständiga behörigheter beviljas. Användaren måste också ha nödvändig RBAC-behörighet.

allow_trailing_dot
bool

Om det är sant kommer den avslutande punkten inte att trimmas från mål-URI:n.

allow_source_trailing_dot
bool

Om det är sant kommer den avslutande punkten inte att trimmas från käll-URI:n.

api_version
str

Lagrings-API-versionen som ska användas för begäranden. Standardvärdet är den senaste tjänstversionen som är kompatibel med den aktuella SDK:en. Om du anger en äldre version kan det leda till minskad funktionskompatibilitet.

Ny i version 12.1.0.

secondary_hostname
str

Värdnamnet för den sekundära slutpunkten.

max_range_size
int

Den maximala intervallstorleken som används för en filuppladdning. Standardvärdet är 4*1024*1024.

audience
str

Målgruppen som ska användas när du begär token för Azure Active Directory-autentisering. Har bara en effekt när autentiseringsuppgifter är av typen TokenCredential. Värdet kan vara https://storage.azure.com/ (standard) eller https://.file.core.windows.net.

Metoder

abort_copy

Avbryt en pågående kopieringsåtgärd.

Då lämnas en målfil utan längd och fullständiga metadata. Detta genererar ett fel om kopieringsåtgärden redan har avslutats.
acquire_lease

Begär ett nytt lån.

Om filen inte har något aktivt lån skapar filtjänsten ett lån för blobben och returnerar ett nytt lån.
clear_range

Rensar det angivna intervallet och frigör det utrymme som används i lagringen för det intervallet.
close

Den här metoden är att stänga de sockets som öppnats av klienten. Den behöver inte användas när du använder med en kontexthanterare.
close_all_handles

Stäng alla öppna filreferenser.

Den här åtgärden blockeras tills tjänsten har stängt alla öppna referenser.
close_handle

Stäng ett öppet filhandtag.
create_file

Skapar en ny fil.

Observera att den endast initierar filen utan innehåll.
delete_file

Markerar den angivna filen för borttagning. Filen tas senare bort under skräpinsamlingen.
download_file

Laddar ned en fil till StorageStreamDownloader. Metoden readall() måste användas för att läsa allt innehåll, eller så måste readinto() användas för att ladda ned filen till en dataström. Med chunks() returneras en iterator som gör att användaren kan iterera över innehållet i segment.
from_connection_string

Skapa ShareFileClient från en anslutningssträng.
from_file_url

En klient för att interagera med en specifik fil, även om filen kanske inte finns ännu.
get_file_properties

Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för filen.
get_ranges

Returnerar listan över giltiga sidintervall för en fil eller ögonblicksbild av en fil.
get_ranges_diff

Returnerar listan över giltiga sidintervall för en fil eller ögonblicksbild av en fil.

Nytt i version 12.6.0.
list_handles

Listreferenser för fil.
rename_file

Byt namn på källfilen.

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes eller str :keyword file_creation_time:

Skapandetid för filen.

:p aramtype file_creation_time:~datetime.datetime eller str :keyword file_last_write_time:

Senaste skrivtid för filen.

:p aramtype file_last_write_time:~datetime.datetime eller str :keyword file_change_time:

Ändra tid för filen. Om inte anges anges ändringstiden till aktuellt datum/tid.

Ny i version 12.8.0: Den här parametern introducerades i API-versionen "2021-06-08".
resize_file

Ändrar storlek på en fil till den angivna storleken.
set_file_metadata

Anger användardefinierade metadata för den angivna filen som ett eller flera namn/värde-par.

Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till filen. Om du vill ta bort alla metadata från filen anropar du den här åtgärden utan metadatadikt.
set_http_headers

Anger HTTP-huvuden i filen.
start_copy_from_url

Initierar kopiering av data från en käll-URL till filen som refereras av klienten.

Status för den här kopieringsåtgärden finns med hjälp av metoden get_properties .
upload_file

Laddar upp en ny fil.

param-data: Filens innehåll.

längd på param int: Filens längd i byte. Ange dess maximala storlek, upp till 1 TiB.

param file_attributes: Filsystemets attribut för filer och kataloger. Om det inte anges är standardvärdet "Ingen" och attributen anges till "Arkiv". Här är ett exempel på när var-typen är str: 'Temporary|Arkiv'. file_attributes värde är inte skiftlägeskänsligt.

type file_attributes: str eller ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: Skapandetid för filens standardvärde: Nu.

typ file_creation_time: str eller ~datetime.datetime

param file_last_write_time: Senaste skrivtid för filen Standardvärde: Nu.

typ file_last_write_time: str eller ~datetime.datetime

param file_permission: Om det anges ska behörigheten (säkerhetsbeskrivning) anges för katalogen/filen. Det här huvudet kan användas om Behörighetsstorleken är <= 8 KB, annars ska rubriken x-ms-file-permission-key användas. Standardvärde: Ärv. Om SDDL anges som indata måste det ha ägare, grupp och dacl. Obs! Endast en av x-ms-file-permission eller x-ms-file-permission-key ska anges.

typ file_permission: str

param permission_key: Nyckeln för behörigheten som ska anges för katalogen/filen. Obs! Endast en av x-ms-file-permission eller x-ms-file-permission-key ska anges.

typ permission_key: str
upload_range

Ladda upp ett byteintervall till en fil.
upload_range_from_url

Skriver byte från en Azure File-slutpunkt till det angivna intervallet för en annan Azure File-slutpunkt.

abort_copy

Avbryt en pågående kopieringsåtgärd.

Då lämnas en målfil utan längd och fullständiga metadata. Detta genererar ett fel om kopieringsåtgärden redan har avslutats.

abort_copy(copy_id: str | FileProperties, **kwargs: Any) -> None

Parametrar

copy_id
str eller FileProperties
Obligatorisk

Kopieringsåtgärden som ska avbrytas. Detta kan vara antingen ett ID eller en instans av FileProperties.

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

None

acquire_lease

Begär ett nytt lån.

Om filen inte har något aktivt lån skapar filtjänsten ett lån för blobben och returnerar ett nytt lån.

acquire_lease(lease_id: str | None = None, **kwargs: Any) -> ShareLeaseClient

Parametrar

lease_id
str
Obligatorisk

Föreslaget låne-ID i ett GUID-strängformat. Filtjänsten returnerar 400 (ogiltig begäran) om det föreslagna låne-ID:t inte har rätt format.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett ShareLeaseClient-objekt.

Returtyp

ShareLeaseClient

Exempel

Skaffa ett lån för en fil.


   source_file.create_file(1024)
   lease = source_file.acquire_lease()
   source_file.upload_file(b'hello world', lease=lease)

   lease.release()

clear_range

Rensar det angivna intervallet och frigör det utrymme som används i lagringen för det intervallet.

clear_range(offset: int, length: int, **kwargs) -> Dict[str, Any]

Parametrar

offset
int
Obligatorisk

Start av byteintervall som ska användas för att rensa ett avsnitt i filen. Intervallet kan vara upp till 4 MB stort.

length
int
Obligatorisk

Antal byte som ska användas för att rensa ett avsnitt i filen. Intervallet kan vara upp till 4 MB stort.

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Fil-uppdaterad egenskapsdikt (Etag och senast ändrad).

Returtyp

Dict[str, Any]

close

Den här metoden är att stänga de sockets som öppnats av klienten. Den behöver inte användas när du använder med en kontexthanterare.

close()

close_all_handles

Stäng alla öppna filreferenser.

Den här åtgärden blockeras tills tjänsten har stängt alla öppna referenser.

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

Parametrar

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Antalet stängda handtag (detta kan vara 0 om det angivna handtaget inte hittades) och antalet referenser kunde inte stängas i en dikta.

Returtyp

dict[str, int]

close_handle

Stäng ett öppet filhandtag.

close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, int]

Parametrar

handle
str eller Handle
Obligatorisk

Ett specifikt handtag att stänga.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Antalet stängda handtag (detta kan vara 0 om det angivna handtaget inte hittades) och antalet referenser kunde inte stängas i en dikta.

Returtyp

dict[str, int]

create_file

Skapar en ny fil.

Observera att den endast initierar filen utan innehåll.

create_file(size: int, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parametrar

size
int
Obligatorisk

Anger den maximala storleken för filen, upp till 1 TB.

file_attributes
NTFSAttributes
Obligatorisk

Filsystemets attribut för filer och kataloger. Om det inte anges är standardvärdet "Ingen" och attributen anges till "Arkiv". Här är ett exempel på när var-typen är str: 'Temporary|Arkiv'. file_attributes värde är inte skiftlägeskänsligt.

file_creation_time
str eller datetime
Obligatorisk

Skapandetid för filens standardvärde: Nu.

file_last_write_time
str eller datetime
Obligatorisk

Senaste skrivtid för filens standardvärde: Nu.

file_permission
str
Obligatorisk

Om detta anges ska behörigheten (säkerhetsbeskrivning) anges för katalogen/filen. Det här huvudet kan användas om behörighetsstorleken är <= 8 kB, annars ska rubriken x-ms-file-permission-key användas. Standardvärde: Ärv. Om SDDL anges som indata måste det ha ägare, grupp och dacl. Obs! Endast en av x-ms-file-permission eller x-ms-file-permission-key ska anges.

permission_key
str
Obligatorisk

Nyckeln för behörigheten som ska anges för katalogen/filen. Obs! Endast en av x-ms-file-permission eller x-ms-file-permission-key ska anges.

file_change_time
str eller datetime

Ändra tid för filen. Om inget anges anges ändringstiden till aktuellt datum/tid.

Ny i version 12.8.0: Den här parametern introducerades i API-versionen "2021-06-08".

content_settings
ContentSettings

ContentSettings-objekt som används för att ange filegenskaper. Används för att ange innehållstyp, kodning, språk, borttagning, md5 och cachekontroll.

metadata
dict(str,str)

Namn/värde-par som är associerade med filen som metadata.

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Filuppdaterad egenskapsdikt (Etag och senast ändrad).

Returtyp

dict(str, Any)

Exempel

Skapa en fil.


   # Create and allocate bytes for the file (no content added yet)
   my_allocated_file.create_file(size=100)

delete_file

Markerar den angivna filen för borttagning. Filen tas senare bort under skräpinsamlingen.

delete_file(**kwargs: Any) -> None

Parametrar

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

None

Exempel

Ta bort en fil.


   my_file.delete_file()

download_file

Laddar ned en fil till StorageStreamDownloader. Metoden readall() måste användas för att läsa allt innehåll, eller så måste readinto() användas för att ladda ned filen till en dataström. Med chunks() returneras en iterator som gör att användaren kan iterera över innehållet i segment.

download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

Parametrar

offset
int
Obligatorisk

Start av byteintervall som ska användas för att ladda ned ett avsnitt i filen. Måste anges om längden anges.

length
int
Obligatorisk

Antal byte som ska läsas från strömmen. Detta är valfritt, men bör anges för optimala prestanda.

max_concurrency
int

Maximalt antal parallella anslutningar som ska användas.

validate_content
bool

Om det är sant beräknas en MD5-hash för varje segment i filen. Lagringstjänsten kontrollerar hashen för det innehåll som har anlänt med den hash som skickades. Detta är främst värdefullt för att identifiera bitflips på kabeln om http i stället för https som https (standard) redan verifieras. Observera att denna MD5-hash inte lagras med filen. Observera också att om den är aktiverad används inte den minneseffektiva uppladdningsalgoritmen eftersom databehandling av MD5-hashen kräver buffring av hela block, och detta motverkar syftet med den minneseffektiva algoritmen.

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

progress_hook
Callable[[int, int], None]

Ett återanrop för att spåra förloppet för en tidskrävande nedladdning. Signaturen är function(current: int, total: int) där aktuell är antalet byte som har överförts hittills, och total är den totala storleken på nedladdningen.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett strömmande objekt (StorageStreamDownloader)

Returtyp

<xref:azure.storage.fileshare.StorageStreamDownloader>

Exempel

Ladda ned en fil.


   with open(DEST_FILE, "wb") as data:
       stream = my_file.download_file()
       data.write(stream.readall())

from_connection_string

Skapa ShareFileClient från en anslutningssträng.

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

Parametrar

conn_str
str
Obligatorisk

En anslutningssträng till ett Azure Storage-konto.

share_name
str
Obligatorisk

Namnet på resursen.

file_path
str
Obligatorisk

Filsökvägen.

snapshot
str
standardvärde: None

En valfri ögonblicksbild av filen som ska användas. Det kan vara strängen för ögonblicksbilds-ID eller svaret som returneras från create_snapshot.

credential
standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift

  • utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "name" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.
audience
str

Målgruppen som ska användas när du begär token för Azure Active Directory-autentisering. Har endast en effekt när autentiseringsuppgifter är av typen TokenCredential. Värdet kan vara https://storage.azure.com/ (standard) eller https://.file.core.windows.net.

Returer

En filklient.

Returtyp

ShareFileClient

Exempel

Skapar filklienten med anslutningssträng.


   from azure.storage.fileshare import ShareFileClient
   file = ShareFileClient.from_connection_string(
       self.connection_string,
       share_name="helloworld2",
       file_path="myfile")

from_file_url

En klient för att interagera med en specifik fil, även om filen kanske inte finns ännu.

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

Parametrar

file_url
str
Obligatorisk

Den fullständiga URI:n till filen.

snapshot
str
standardvärde: None

En valfri ögonblicksbild av filen som ska användas. Det kan vara strängen för ögonblicksbilds-ID eller svaret som returneras från create_snapshot.

credential
standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift

  • utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "name" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.
audience
str

Målgruppen som ska användas när du begär token för Azure Active Directory-autentisering. Har endast en effekt när autentiseringsuppgifter är av typen TokenCredential. Värdet kan vara https://storage.azure.com/ (standard) eller https://.file.core.windows.net.

Returer

En filklient.

Returtyp

ShareFileClient

get_file_properties

Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för filen.

get_file_properties(**kwargs: Any) -> FileProperties

Parametrar

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

FileProperties

Returtyp

FileProperties

get_ranges

Returnerar listan över giltiga sidintervall för en fil eller ögonblicksbild av en fil.

get_ranges(offset: int | None = None, length: int | None = None, **kwargs: Any) -> List[Dict[str, int]]

Parametrar

offset
int
Obligatorisk

Anger startförskjutningen för byte som intervall ska hämtas över.

length
int
Obligatorisk

Antal byte som ska användas för att hämta intervall.

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En lista över giltiga intervall.

Returtyp

List[dict[str, int]]

get_ranges_diff

Returnerar listan över giltiga sidintervall för en fil eller ögonblicksbild av en fil.

Nytt i version 12.6.0.

get_ranges_diff(previous_sharesnapshot: str | Dict[str, Any], offset: int | None = None, length: int | None = None, **kwargs: Any) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Parametrar

offset
int
Obligatorisk

Anger startförskjutningen för byte som intervall ska hämtas över.

length
int
Obligatorisk

Antal byte som ska användas för att hämta intervall.

previous_sharesnapshot
str
Obligatorisk

Parametern snapshot diff som innehåller ett ogenomskinligt DateTime-värde som anger en tidigare ögonblicksbild av filen som ska jämföras med en senare ögonblicksbild eller den aktuella filen.

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En tupplar med två listor med filintervall som ordlistor med "start- och slutnycklar". Det första elementet är fyllda filintervall, det andra elementet rensas filintervall.

Returtyp

tuple(list(dict(str, str), list(dict(str, str))

list_handles

Listreferenser för fil.

list_handles(**kwargs: Any) -> ItemPaged[Handle]

Parametrar

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En automatisk växling av itererbar handtag

Returtyp

ItemPaged[Handle]

rename_file

Byt namn på källfilen.

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes eller str :keyword file_creation_time:

Skapandetid för filen.

:p aramtype file_creation_time:~datetime.datetime eller str :keyword file_last_write_time:

Senaste skrivtid för filen.

:p aramtype file_last_write_time:~datetime.datetime eller str :keyword file_change_time:

Ändra tid för filen. Om inte anges anges ändringstiden till aktuellt datum/tid.

Ny i version 12.8.0: Den här parametern introducerades i API-versionen "2021-06-08".

rename_file(new_name: str, **kwargs: Any) -> ShareFileClient

Parametrar

content_type
str

Innehållstypen för den nya filen.

Ny i version 12.8.0: Den här parametern introducerades i API-versionen "2021-06-08".

metadata
Dict[str,str]

Ett namn/värde-par som ska associeras med ett fillagringsobjekt.

source_lease
ShareLeaseClient eller str

Krävs om källfilen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

destination_lease
ShareLeaseClient eller str

Krävs om målfilen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Returer

Den nya filklienten.

Returtyp

ShareFileClient

resize_file

Ändrar storlek på en fil till den angivna storleken.

resize_file(size: int, **kwargs: Any) -> Dict[str, Any]

Parametrar

size
int
Obligatorisk

Storlek för att ändra storlek på filen till (i byte)

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Fil-uppdaterad egenskapsdikt (Etag och senast ändrad).

Returtyp

Dict[str, Any]

set_file_metadata

Anger användardefinierade metadata för den angivna filen som ett eller flera namn/värde-par.

Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till filen. Om du vill ta bort alla metadata från filen anropar du den här åtgärden utan metadatadikt.

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

Parametrar

metadata
dict(str, str)
Obligatorisk

Namn/värde-par som är associerade med filen som metadata.

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Fil-uppdaterad egenskapsdikt (Etag och senast ändrad).

Returtyp

dict(str, Any)

set_http_headers

Anger HTTP-huvuden i filen.

set_http_headers(content_settings: ContentSettings, file_attributes: str | NTFSAttributes = 'preserve', file_creation_time: str | datetime | None = 'preserve', file_last_write_time: str | datetime | None = 'preserve', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parametrar

content_settings
ContentSettings
Obligatorisk

ContentSettings-objekt som används för att ange filegenskaper. Används för att ange innehållstyp, kodning, språk, disposition, md5 och cachekontroll.

file_attributes
NTFSAttributes
Obligatorisk

Filsystemattributen för filer och kataloger. Om det inte anges anger du att befintliga värden ska bevaras. Här är ett exempel på när var-typen är str: 'Temporary|Arkiv'

file_creation_time
str eller datetime
Obligatorisk

Skapandetid för filens standardvärde: Behåll.

file_last_write_time
str eller datetime
Obligatorisk

Senaste skrivtid för filens standardvärde: Bevara.

file_permission
str
Obligatorisk

Om det anges ska behörigheten (säkerhetsbeskrivning) anges för katalogen/filen. Det här huvudet kan användas om Behörighetsstorleken är <= 8 KB, annars ska rubriken x-ms-file-permission-key användas. Standardvärde: Ärv. Om SDDL anges som indata måste det ha ägare, grupp och dacl. Obs! Endast en av x-ms-file-permission eller x-ms-file-permission-key ska anges.

permission_key
str
Obligatorisk

Nyckeln för behörigheten som ska anges för katalogen/filen. Obs! Endast en av x-ms-file-permission eller x-ms-file-permission-key ska anges.

file_change_time
str eller datetime

Ändra tid för filen. Om inte anges anges ändringstiden till aktuellt datum/tid.

Ny i version 12.8.0: Den här parametern introducerades i API-versionen "2021-06-08".

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Fil-uppdaterad egenskapsdikt (Etag och senast ändrad).

Returtyp

dict(str, Any)

start_copy_from_url

Initierar kopiering av data från en käll-URL till filen som refereras av klienten.

Status för den här kopieringsåtgärden finns med hjälp av metoden get_properties .

start_copy_from_url(source_url: str, **kwargs: Any) -> Any

Parametrar

source_url
str
Obligatorisk

Anger url:en för källfilen.

file_permission
str

Om det anges ska behörigheten (säkerhetsbeskrivning) anges för katalogen/filen. Det här värdet kan anges till "källa" för att kopiera säkerhetsbeskrivningen från källfilen. Annars används det här värdet för att åsidosätta källvärdet om det anges. Om det inte anges ärvs behörighetsvärdet från målfilens överordnade katalog. Den här inställningen kan användas om Behörighetsstorleken är <= 8 KB, annars ska permission_key användas. Om SDDL anges som indata måste det ha ägare, grupp och dacl. Obs! Endast en av file_permission eller permission_key ska anges.

Ny i version 12.1.0: Den här parametern introducerades i API-versionen "2019-07-07".

permission_key
str

Nyckeln för behörigheten som ska anges för katalogen/filen. Det här värdet kan anges till "källa" för att kopiera säkerhetsbeskrivningen från källfilen. Annars används det här värdet för att åsidosätta källvärdet om det anges. Om det inte anges ärvs behörighetsvärdet från målfilens överordnade katalog. Obs! Endast en av file_permission eller permission_key ska anges.

Ny i version 12.1.0: Den här parametern introducerades i API-versionen "2019-07-07".

file_attributes
NTFSAttributes

Det här värdet kan anges till "källa" för att kopiera filattribut från källfilen till målfilen, eller för att rensa alla attribut kan det anges till "Ingen". Annars kan den ställas in på en lista med attribut som ska anges i målfilen. Om detta inte anges är standardvärdet "Arkiv".

Ny i version 12.1.0: Den här parametern introducerades i API-versionen "2019-07-07".

file_creation_time
str eller datetime

Det här värdet kan anges till "källa" för att kopiera skapandetiden från källfilen till målfilen, eller en datetime som ska anges som skapandetid för målfilen. Detta kan också vara en sträng i ISO 8601-format. Om detta inte anges anges skapandetiden till datumtidsvärdet för skapandet (eller när den skrevs över) av målfilen av kopieringsmotorn.

Ny i version 12.1.0: Den här parametern introducerades i API-versionen "2019-07-07".

file_last_write_time
str eller datetime

Det här värdet kan anges till "källa" för att kopiera den senaste skrivtiden från källfilen till målfilen, eller en datetime som ska anges som den senaste skrivtiden för målfilen. Detta kan också vara en sträng i ISO 8601-format. Om detta inte anges blir värdet den sista skrivtiden till filen av kopieringsmotorn.

Ny i version 12.1.0: Den här parametern introducerades i API-versionen "2019-07-07".

file_change_time
str eller datetime

Ändra tid för filen. Om inte anges anges ändringstiden till aktuellt datum/tid.

Ny i version 12.9.0: Den här parametern introducerades i API-versionen "2021-06-08".

ignore_read_only
bool

Anger alternativet för att skriva över målfilen om den redan finns och har skrivskyddat attribut inställt.

Ny i version 12.1.0: Den här parametern introducerades i API-versionen "2019-07-07".

set_archive_attribute
bool

Anger alternativet för att ange arkivattributet för målfilen. Sant innebär att arkivattributet anges för målfilen trots attribut åsidosättningar eller källfiltillståndet.

Ny i version 12.1.0: Den här parametern introducerades i API-versionen "2019-07-07".

metadata

Namn/värde-par som är associerade med filen som metadata.

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

dict(str, Any)

Exempel

Kopiera en fil från en URL


   destination_file.start_copy_from_url(source_url=source_url)

upload_file

Laddar upp en ny fil.

param-data: Filens innehåll.

längd på param int: Filens längd i byte. Ange dess maximala storlek, upp till 1 TiB.

param file_attributes: Filsystemets attribut för filer och kataloger. Om det inte anges är standardvärdet "Ingen" och attributen anges till "Arkiv". Här är ett exempel på när var-typen är str: 'Temporary|Arkiv'. file_attributes värde är inte skiftlägeskänsligt.

type file_attributes: str eller ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: Skapandetid för filens standardvärde: Nu.

typ file_creation_time: str eller ~datetime.datetime

param file_last_write_time: Senaste skrivtid för filen Standardvärde: Nu.

typ file_last_write_time: str eller ~datetime.datetime

param file_permission: Om det anges ska behörigheten (säkerhetsbeskrivning) anges för katalogen/filen. Det här huvudet kan användas om Behörighetsstorleken är <= 8 KB, annars ska rubriken x-ms-file-permission-key användas. Standardvärde: Ärv. Om SDDL anges som indata måste det ha ägare, grupp och dacl. Obs! Endast en av x-ms-file-permission eller x-ms-file-permission-key ska anges.

typ file_permission: str

param permission_key: Nyckeln för behörigheten som ska anges för katalogen/filen. Obs! Endast en av x-ms-file-permission eller x-ms-file-permission-key ska anges.

typ permission_key: str

upload_file(data: bytes | str | Iterable | IO, length: int | None = None, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs) -> Dict[str, Any]

Parametrar

file_change_time

Ändra tid för filen. Om inte anges anges ändringstiden till aktuellt datum/tid.

Ny i version 12.8.0: Den här parametern introducerades i API-versionen "2021-06-08".

paramtype file_change_time: str eller ~datetime.datetime

keyword dict(str,str) metadata: Namn/värde-par som är associerade med filen som metadata.

nyckelord ~azure.storage.fileshare.ContentSettings content_settings: ContentSettings-objekt som används för att ange filegenskaper. Används för att ange innehållstyp, kodning, språk, disposition, md5 och cachekontroll.

keyword bool validate_content: Om sant beräknar en MD5-hash för varje filintervall. Lagringstjänsten kontrollerar hashen för det innehåll som har anlänt med hashen som skickades. Detta är främst värdefullt för att identifiera bitflips på tråden om http i stället för https som https (standard) redan verifieras. Observera att denna MD5-hash inte lagras med filen.

keyword int max_concurrency: Maximalt antal parallella anslutningar som ska användas.

nyckelordslån: Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

paramtype lease: ~azure.storage.fileshare.ShareLeaseClient eller str

nyckelord progress_hook: Ett återanrop för att spåra förloppet för en tidskrävande uppladdning. Signaturen är function(current: int, total: Optional[int]) där aktuellt är antalet byte som har överförts hittills, och summan är storleken på bloben eller Ingen om storleken är okänd.

paramtype progress_hook: Callable[[int, Optional[int]], None]

tidsgräns för nyckelordsint: Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

keyword str encoding: Standardvärdet UTF-8.

returns: File-updated property dict (Etag och senast ändrad).

rtype: dict(str, any)

Exempel:Ladda upp en fil.


   with open(SOURCE_FILE, "rb") as source:
       my_file.upload_file(source)

upload_range

Ladda upp ett byteintervall till en fil.

upload_range(data: bytes, offset: int, length: int, **kwargs) -> Dict[str, Any]

Parametrar

data
bytes
Obligatorisk

De data som ska laddas upp.

offset
int
Obligatorisk

Start av byteintervall som ska användas för att ladda upp en del av filen. Intervallet kan vara upp till 4 MB stort.

length
int
Obligatorisk

Antal byte som ska användas för att ladda upp en del av filen. Intervallet kan vara upp till 4 MB stort.

validate_content
bool

Om det är sant beräknas en MD5-hash för sidinnehållet. Lagringstjänsten kontrollerar hashen för det innehåll som har anlänt med den hash som skickades. Detta är främst värdefullt för att identifiera bitflips på kabeln om http i stället för https som https (standard) redan verifieras. Observera att denna MD5-hash inte lagras med filen.

file_last_write_mode
Literal["preserve", "now"]

Om filens senaste skrivtid ska bevaras eller skrivas över. Möjliga värden är "preserve" eller "now". Om inget anges ändras filens senaste skrivtid till aktuellt datum/tid.

Ny i version 12.8.0: Den här parametern introducerades i API-versionen "2021-06-08".

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

encoding
str

Standardvärdet är UTF-8.

Returer

Filuppdaterad egenskapsdikt (Etag och senast ändrad).

Returtyp

Dict[str, Any]

upload_range_from_url

Skriver byte från en Azure File-slutpunkt till det angivna intervallet för en annan Azure File-slutpunkt.

upload_range_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs: Any) -> Dict[str, Any]

Parametrar

offset
int
Obligatorisk

Start av byteintervall som ska användas för att uppdatera ett avsnitt i filen. Intervallet kan vara upp till 4 MB stort.

length
int
Obligatorisk

Antal byte som ska användas för att uppdatera ett avsnitt i filen. Intervallet kan vara upp till 4 MB stort.

source_url
str
Obligatorisk

En URL på upp till 2 kB som anger en Azure-fil eller blob. Värdet ska vara URL-kodat som det skulle visas i en begärande-URI. Om källan finns i ett annat konto måste källan antingen vara offentlig eller autentiseras via en signatur för delad åtkomst. Om källan är offentlig krävs ingen autentisering. Exempel: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken

source_offset
int
Obligatorisk

Detta anger början av intervallet med byte (inklusive) som måste hämtas från kopieringskällan. Tjänsten läser samma antal byte som målintervallet (längdförskjutning).

source_if_modified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange den här villkorliga rubriken för att kopiera bloben endast om källbloben har ändrats sedan det angivna datumet/tiden.

source_if_unmodified_since
datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange den här villkorliga rubriken för att kopiera bloben endast om källbloben inte har ändrats sedan det angivna datumet/tiden.

source_etag
str

ETag-källans värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

source_match_condition
MatchConditions

Källmatchningsvillkoret som ska användas på etag.

file_last_write_mode
Literal["preserve", "now"]

Om filens senaste skrivtid ska bevaras eller skrivas över. Möjliga värden är "preserve" eller "now". Om inget anges ändras filens senaste skrivtid till aktuellt datum/tid.

Ny i version 12.8.0: Den här parametern introducerades i API-versionen "2021-06-08".

lease
ShareLeaseClient eller str

Krävs om filen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.

Ny i version 12.1.0.

timeout
int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

source_authorization
str

Autentisera som tjänstens huvudnamn med hjälp av en klienthemlighet för att få åtkomst till en källblob. Se till att "bearer" är prefixet för strängen source_authorization.

Attribut

api_version

Den version av lagrings-API:et som används för begäranden.

location_mode

Det platsläge som klienten använder för närvarande.

Som standard är detta "primärt". Alternativen är "primär" och "sekundär".

primary_endpoint

Den fullständiga primära slutpunkts-URL:en.

primary_hostname

Värdnamnet för den primära slutpunkten.

secondary_endpoint

Den fullständiga sekundära slutpunkts-URL:en om den har konfigurerats.

Om den inte är tillgänglig utlöses en ValueError. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.

Undantag

ValueError

secondary_hostname

Värdnamnet för den sekundära slutpunkten.

Om det inte är tillgängligt blir det Ingen. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.

url

Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används.

Detta kan vara antingen den primära slutpunkten eller den sekundära slutpunkten beroende på aktuell location_mode. :returns: Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används. :rtype: str