ShareFileClient Classe

Riferimento

Un client per interagire con un file specifico, anche se tale file potrebbe non esistere ancora.

Per altre configurazioni facoltative, fare clic qui.

Ereditarietà: azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin

ShareFileClient

Costruttore

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)

Parametri

account_url: str

Necessario

URI dell'account di archiviazione. Per creare un client dato l'URI completo al file, usare la from_file_url classemethod.

share_name: str

Necessario

Nome della condivisione per il file.

file_path: str

Necessario

Percorso del file con cui interagire. Se specificato, questo valore eseguirà l'override di un valore di file specificato nell'URL del file.

snapshot: str

valore predefinito: None

Snapshot di file facoltativo su cui funzionare. Questa può essere la stringa ID snapshot o la risposta restituita da create_snapshot.

credential

valore predefinito: None

Credenziali con cui eseguire l'autenticazione. Questo è facoltativo se l'URL dell'account ha già un token di firma di accesso condiviso. Il valore può essere una stringa di token sas, un'istanza di AzureSasCredential o AzureNamedKeyCredential da azure.core.credential, una chiave di accesso condiviso dell'account o un'istanza di una classe TokenCredentials da azure.identity. Se l'URI della risorsa contiene già un token di firma di accesso condiviso, questo verrà ignorato a favore di una credenziale esplicita

tranne nel caso di AzureSasCredential, in cui i token sas in conflitto genereranno un valoreError. Se si usa un'istanza di AzureNamedKeyCredential, "name" deve essere il nome dell'account di archiviazione e "key" deve essere la chiave dell'account di archiviazione.

token_intent: Literal['backup']

Obbligatorio quando si usa TokenCredential per l'autenticazione e viene ignorato per altre forme di autenticazione. Specifica la finalità per tutte le richieste quando si usa l'autenticazione TokenCredential . I valori possibili sono:

backup: specifica che le richieste sono destinate alle operazioni di tipo di backup/amministratore, vale a dire che tutti gli ACL file/directory vengono ignorati e le autorizzazioni complete vengono concesse. L'utente deve avere anche l'autorizzazione RBAC necessaria.

allow_trailing_dot: bool

Se true, il punto finale non verrà tagliato dall'URI di destinazione.

allow_source_trailing_dot: bool

Se true, il punto finale non verrà tagliato dall'URI di origine.

api_version: str

Versione dell'API di archiviazione da usare per le richieste. Il valore predefinito è la versione del servizio più recente compatibile con l'SDK corrente. L'impostazione su una versione precedente può comportare una riduzione della compatibilità delle funzionalità.

Novità nella versione 12.1.0.

secondary_hostname: str

Nome host dell'endpoint secondario.

max_range_size: int

Dimensione massima dell'intervallo usata per un caricamento di file. Il valore predefinito è 41024 1024.

audience: str

Destinatari da usare quando si richiedono token per l'autenticazione di Azure Active Directory. Ha un effetto solo quando le credenziali sono di tipo TokenCredential. Il valore potrebbe essere https://storage.azure.com/ (impostazione predefinita) o https://.file.core.windows.net.

Metodi

abort_copy	Interrompere un'operazione di copia continua. In questo modo verrà lasciato un file di destinazione con lunghezza zero e metadati completi. Verrà generato un errore se l'operazione di copia è già stata terminata.
acquire_lease	Richiede un nuovo lease. Se il file non ha un lease attivo, il servizio file crea un lease nel BLOB e restituisce un nuovo lease.
clear_range	Cancella l'intervallo specificato e rilascia lo spazio usato nell'archiviazione per tale intervallo.
close	Questo metodo consiste nel chiudere i socket aperti dal client. Non è necessario usare quando si usa con un gestore di contesto.
close_all_handles	Chiudere tutti gli handle di file aperti. Questa operazione verrà bloccata finché il servizio non ha chiuso tutti gli handle aperti.
close_handle	Chiudere un handle di file aperto.
create_file	Crea un nuovo file. Si noti che inizializza solo il file senza contenuto.
delete_file	Contrassegna il file specificato per l'eliminazione. Il file viene eliminato successivamente durante la Garbage Collection.
download_file	Scarica un file in StorageStreamDownloader. Il metodo readall() deve essere usato per leggere tutto il contenuto o readinto() deve essere usato per scaricare il file in un flusso. L'uso di blocchi() restituisce un iteratore che consente all'utente di eseguire l'iterazione del contenuto in blocchi.
from_connection_string	Creare ShareFileClient da una stringa di connessione.
from_file_url	Un client per interagire con un file specifico, anche se tale file potrebbe non esistere ancora.
get_file_properties	Restituisce tutti i metadati definiti dall'utente, le proprietà HTTP standard e le proprietà di sistema per il file.
get_ranges	Restituisce l'elenco di intervalli di pagine validi per un file o uno snapshot di un file.
get_ranges_diff	Restituisce l'elenco di intervalli di pagine validi per un file o uno snapshot di un file. Novità nella versione 12.6.0.
list_handles	Elenca gli handle per il file.
rename_file	Rinominare il file di origine. :p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes o str :keyword file_creation_time: Ora di creazione per il file. :p aramtype file_creation_time:~datetime.datetime o str :keyword file_last_write_time: Ora dell'ultima scrittura per il file. :p aramtype file_last_write_time:~datetime.datetime o str :keyword file_change_time: Modifica dell'ora per il file. Se non specificato, l'ora di modifica verrà impostata sulla data/ora corrente. Novità nella versione 12.8.0: questo parametro è stato introdotto nella versione DELL'API '2021-06-08'.
resize_file	Imposta un file sulle dimensioni specificate.
set_file_metadata	Imposta i metadati definiti dall'utente per il file specificato come una o più coppie nome-valore. Ogni chiamata a questa operazione sostituisce tutti i metadati esistenti collegati al file. Per rimuovere tutti i metadati dal file, chiamare questa operazione senza dict di metadati.
set_http_headers	Imposta le intestazioni HTTP nel file.
start_copy_from_url	Avvia la copia dei dati da un URL di origine nel file a cui fa riferimento il client. Lo stato di questa operazione di copia è disponibile usando il metodo get_properties .
upload_file	Carica un nuovo file. dati param: contenuto del file. param int length: lunghezza del file in byte. Specificare le dimensioni massime fino a 1 TiB. param file_attributes: attributi del file system per file e directory. Se non è impostato, il valore predefinito sarà "Nessuno" e gli attributi verranno impostati su "Archivio". Ecco un esempio per quando il tipo var è str: 'Temporary\|Archivio'. file_attributes valore non è distinzione tra maiuscole e minuscole. tipo file_attributes: str o ~azure.storage.fileshare.NTFSAttributes param file_creation_time: tempo di creazione per il valore predefinito del file: ora. tipo file_creation_time: str o ~datetime.datetime param file_last_write_time: ultima ora di scrittura per il valore predefinito del file: ora. tipo file_last_write_time: str o ~datetime.datetime param file_permission: se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory/file. Questa intestazione può essere usata se le dimensioni dell'autorizzazione sono <= 8 KB, è necessario usare l'intestazione x-ms-file-permission-key. Valore predefinito: Eredita. Se SDDL viene specificato come input, deve avere proprietario, gruppo e dacl. Nota: è necessario specificare una sola delle autorizzazioni x-ms-file-permission o x-ms-file-permission-key. tipo file_permission: str param permission_key: chiave dell'autorizzazione da impostare per la directory/file. Nota: è necessario specificare una sola delle autorizzazioni x-ms-file-permission o x-ms-file-permission-key. tipo permission_key: str
upload_range	Caricare un intervallo di byte in un file.
upload_range_from_url	Scrive i byte da un endpoint file di Azure nell'intervallo specificato di un altro endpoint file di Azure.

abort_copy

Interrompere un'operazione di copia continua.

In questo modo verrà lasciato un file di destinazione con lunghezza zero e metadati completi. Verrà generato un errore se l'operazione di copia è già stata terminata.

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

Parametri

copy_id: str oppure FileProperties

Necessario

Operazione di copia da interrompere. Può essere un ID o un'istanza di FileProperties.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità nella versione 12.1.0.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Tipo restituito

None

acquire_lease

Richiede un nuovo lease.

Se il file non ha un lease attivo, il servizio file crea un lease nel BLOB e restituisce un nuovo lease.

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

Parametri

lease_id: str

Necessario

ID lease proposto, in un formato di stringa GUID. Il servizio file restituisce 400 (richiesta non valida) se l'ID lease proposto non è nel formato corretto.

timeout: int

Restituisce

Oggetto ShareLeaseClient.

Tipo restituito

ShareLeaseClient

Esempio

Acquisizione di un lease su un file.


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

   lease.release()

clear_range

Cancella l'intervallo specificato e rilascia lo spazio usato nell'archiviazione per tale intervallo.

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

Parametri

offset: int

Necessario

Inizio dell'intervallo di byte da usare per cancellare una sezione del file. L'intervallo può essere fino a 4 MB di dimensioni.

length: int

Necessario

Numero di byte da usare per cancellare una sezione del file. L'intervallo può essere fino a 4 MB di dimensioni.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità nella versione 12.1.0.

timeout: int

Restituisce

Proprietà aggiornata del file (Etag e ultima modifica).

Tipo restituito

Dict[str, Any]

close

Questo metodo consiste nel chiudere i socket aperti dal client. Non è necessario usare quando si usa con un gestore di contesto.

close()

close_all_handles

Chiudere tutti gli handle di file aperti.

Questa operazione verrà bloccata finché il servizio non ha chiuso tutti gli handle aperti.

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

Parametri

timeout: int

Restituisce

Il numero di handle chiusi (questo può essere 0 se l'handle specificato non è stato trovato) e il numero di handle non è riuscito a chiudere in un dict.

Tipo restituito

dict[str, int]

close_handle

Chiudere un handle di file aperto.

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

Parametri

handle: str oppure Handle

Necessario

Handle specifico da chiudere.

timeout: int

Restituisce

Il numero di handle chiusi (questo può essere 0 se l'handle specificato non è stato trovato) e il numero di handle non è riuscito a chiudere in un dict.

Tipo restituito

dict[str, int]

create_file

Crea un nuovo file.

Si noti che inizializza solo il file senza contenuto.

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]

Parametri

size: int

Necessario

Specifica le dimensioni massime per il file, fino a 1 TB.

file_attributes: NTFSAttributes

Necessario

Attributi del file system per file e directory. Se non è impostato, il valore predefinito sarà "Nessuno" e gli attributi verranno impostati su "Archivio". Ecco un esempio per quando il tipo var è str: 'Temporary|Archivio'. file_attributes valore non è distinzione tra maiuscole e minuscole.

file_creation_time: str oppure datetime

Necessario

Tempo di creazione per il valore predefinito del file: ora.

file_last_write_time: str oppure datetime

Necessario

Ultima ora di scrittura per il valore predefinito del file: ora.

file_permission: str

Necessario

Se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory/file. Questa intestazione può essere usata se le dimensioni dell'autorizzazione sono <= 8 KB, è necessario usare l'intestazione x-ms-file-permission-key. Valore predefinito: Eredita. Se SDDL viene specificato come input, deve avere proprietario, gruppo e dacl. Nota: è necessario specificare una sola delle autorizzazioni x-ms-file-permission o x-ms-file-permission-key.

permission_key: str

Necessario

Chiave dell'autorizzazione da impostare per la directory/file. Nota: è necessario specificare una sola delle autorizzazioni x-ms-file-permission o x-ms-file-permission-key.

file_change_time: str oppure datetime

Modificare il tempo per il file. Se non specificato, l'ora di modifica verrà impostata sulla data/ora corrente.

Novità nella versione 12.8.0: questo parametro è stato introdotto nell'API versione '2021-06-08'.

content_settings: ContentSettings

Oggetto ContentSettings usato per impostare le proprietà dei file. Usato per impostare il tipo di contenuto, la codifica, la lingua, l'eliminazione, md5 e il controllo cache.

metadata: dict(str,str)

Coppie nome-valore associate al file come metadati.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità nella versione 12.1.0.

timeout: int

Restituisce

Proprietà aggiornata del file (Etag e ultima modifica).

Tipo restituito

dict(str, Any)

Esempio

Creare un file.


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

delete_file

Contrassegna il file specificato per l'eliminazione. Il file viene eliminato successivamente durante la Garbage Collection.

delete_file(**kwargs: Any) -> None

Parametri

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità nella versione 12.1.0.

timeout: int

Tipo restituito

None

Esempio

Consente di eliminare un file.


   my_file.delete_file()

download_file

Scarica un file in StorageStreamDownloader. Il metodo readall() deve essere usato per leggere tutto il contenuto o readinto() deve essere usato per scaricare il file in un flusso. L'uso di blocchi() restituisce un iteratore che consente all'utente di eseguire l'iterazione del contenuto in blocchi.

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

Parametri

offset: int

Necessario

Inizio dell'intervallo di byte da usare per il download di una sezione del file. Deve essere impostato se viene specificata la lunghezza.

length: int

Necessario

Numero di byte da leggere dal flusso. Questo è facoltativo, ma deve essere fornito per prestazioni ottimali.

max_concurrency: int

Numero massimo di connessioni parallele da usare.

validate_content: bool

Se true, calcola un hash MD5 per ogni blocco del file. Il servizio di archiviazione controlla l'hash del contenuto che è arrivato con l'hash inviato. Questo è principalmente utile per rilevare bitflips sul cavo se si usa http anziché https come https (impostazione predefinita) già convalida. Si noti che questo hash MD5 non viene archiviato con il file. Si noti anche che, se abilitato, l'algoritmo di caricamento efficiente per la memoria non verrà usato, perché l'elaborazione dell'hash MD5 richiede il buffering di tutti i blocchi e in questo modo lo scopo dell'algoritmo efficiente per la memoria.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità nella versione 12.1.0.

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

Callback per tenere traccia dello stato di avanzamento di un download a esecuzione prolungata. La firma è function(current: int, total: int) dove corrente è il numero di byte trasferiti finora e il totale è la dimensione totale del download.

timeout: int

Restituisce

Oggetto di streaming (StorageStreamDownloader)

Tipo restituito

<xref:azure.storage.fileshare.StorageStreamDownloader>

Esempio

Scaricare un file.


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

from_connection_string

Creare ShareFileClient da una stringa di connessione.

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

Parametri

conn_str: str

Necessario

Un stringa di connessione a un account di archiviazione di Azure.

share_name: str

Necessario

Nome della condivisione.

file_path: str

Necessario

Percorso del file.

snapshot: str

valore predefinito: None

Snapshot di file facoltativo su cui funzionare. Questa può essere la stringa ID snapshot o la risposta restituita da create_snapshot.

credential

valore predefinito: None

tranne nel caso di AzureSasCredential, in cui i token sas in conflitto genereranno un valoreError. Se si usa un'istanza di AzureNamedKeyCredential, "name" deve essere il nome dell'account di archiviazione e "key" deve essere la chiave dell'account di archiviazione.

audience: str

Restituisce

Client file.

Tipo restituito

ShareFileClient

Esempio

Crea il client di file con stringa di connessione.


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

from_file_url

Un client per interagire con un file specifico, anche se tale file potrebbe non esistere ancora.

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

Parametri

file_url: str

Necessario

URI completo del file.

snapshot: str

valore predefinito: None

Snapshot di file facoltativo su cui funzionare. Questa può essere la stringa ID snapshot o la risposta restituita da create_snapshot.

credential

valore predefinito: None

tranne nel caso di AzureSasCredential, in cui i token sas in conflitto genereranno un valoreError. Se si usa un'istanza di AzureNamedKeyCredential, "name" deve essere il nome dell'account di archiviazione e "key" deve essere la chiave dell'account di archiviazione.

audience: str

Restituisce

Client file.

Tipo restituito

ShareFileClient

get_file_properties

Restituisce tutti i metadati definiti dall'utente, le proprietà HTTP standard e le proprietà di sistema per il file.

get_file_properties(**kwargs: Any) -> FileProperties

Parametri

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità nella versione 12.1.0.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

Proprietà file

Tipo restituito

FileProperties

get_ranges

Restituisce l'elenco di intervalli di pagine validi per un file o uno snapshot di un file.

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

Parametri

offset: int

Necessario

Specifica l'offset iniziale dei byte su cui ottenere gli intervalli.

length: int

Necessario

Numero di byte da usare per ottenere intervalli.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità della versione 12.1.0.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

Elenco di intervalli validi.

Tipo restituito

List[dict[str, int]]

get_ranges_diff

Restituisce l'elenco di intervalli di pagine validi per un file o uno snapshot di un file.

Novità nella versione 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]]]

Parametri

offset: int

Necessario

Specifica l'offset iniziale dei byte su cui ottenere gli intervalli.

length: int

Necessario

Numero di byte da usare per ottenere intervalli.

previous_sharesnapshot: str

Necessario

Parametro diff dello snapshot che contiene un valore DateTime opaco che specifica uno snapshot di file precedente da confrontare con uno snapshot più recente o il file corrente.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

Tupla di due elenchi di intervalli di file come dizionari con chiavi "start" e "end". Il primo elemento è costituito da intervalli di file riempiti, il secondo elemento viene cancellato.

Tipo restituito

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

list_handles

Elenca gli handle per il file.

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

Parametri

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

Iterabile di paging automatico di Handle

Tipo restituito

ItemPaged[Handle]

rename_file

Rinominare il file di origine.

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

Ora di creazione per il file.

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

Ora dell'ultima scrittura per il file.

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

Modifica dell'ora per il file. Se non specificato, l'ora di modifica verrà impostata sulla data/ora corrente.

Novità nella versione 12.8.0: questo parametro è stato introdotto nella versione DELL'API '2021-06-08'.

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

Parametri

content_type: str

Tipo di contenuto del nuovo file.

Novità nella versione 12.8.0: questo parametro è stato introdotto nella versione DELL'API '2021-06-08'.

metadata: Dict[str,str]

Coppia nome-valore da associare a un oggetto di archiviazione file.

source_lease: ShareLeaseClient oppure str

Obbligatorio se il file di origine ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

destination_lease: ShareLeaseClient oppure str

Obbligatorio se il file di destinazione ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Restituisce

Nuovo client file.

Tipo restituito

ShareFileClient

resize_file

Imposta un file sulle dimensioni specificate.

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

Parametri

size: int

Necessario

Dimensioni per ridimensionare il file in (in byte)

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità della versione 12.1.0.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

Dict della proprietà aggiornata dai file (Etag e ultima modifica).

Tipo restituito

Dict[str, Any]

set_file_metadata

Imposta i metadati definiti dall'utente per il file specificato come una o più coppie nome-valore.

Ogni chiamata a questa operazione sostituisce tutti i metadati esistenti collegati al file. Per rimuovere tutti i metadati dal file, chiamare questa operazione senza dict di metadati.

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

Parametri

metadata: dict(str, str)

Necessario

Coppie nome-valore associate al file come metadati.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità della versione 12.1.0.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

Dict della proprietà aggiornata dai file (Etag e ultima modifica).

Tipo restituito

dict(str, Any)

set_http_headers

Imposta le intestazioni HTTP nel file.

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]

Parametri

content_settings: ContentSettings

Necessario

Oggetto ContentSettings utilizzato per impostare le proprietà del file. Usato per impostare il tipo di contenuto, la codifica, la lingua, l'eliminazione, md5 e il controllo della cache.

file_attributes: NTFSAttributes

Necessario

Attributi del file system per file e directory. Se non impostato, indica la conservazione dei valori esistenti. Di seguito è riportato un esempio di quando il tipo var è str: 'Temporary|Archivio'

file_creation_time: str oppure datetime

Necessario

Ora di creazione per il valore predefinito del file: Mantieni.

file_last_write_time: str oppure datetime

Necessario

Ora dell'ultima scrittura per il valore predefinito del file: Mantieni.

file_permission: str

Necessario

Se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory o il file. Questa intestazione può essere usata se le dimensioni dell'autorizzazione sono <= 8 KB, altrimenti è necessario usare l'intestazione x-ms-file-permission-key. Valore predefinito: Eredita. Se SDDL viene specificato come input, deve avere proprietario, gruppo e dacl. Nota: deve essere specificato solo uno dei valori x-ms-file-permission o x-ms-file-permission-key.

permission_key: str

Necessario

Chiave dell'autorizzazione da impostare per la directory o il file. Nota: deve essere specificato solo uno dei valori x-ms-file-permission o x-ms-file-permission-key.

file_change_time: str oppure datetime

Modifica dell'ora per il file. Se non specificato, l'ora di modifica verrà impostata sulla data/ora corrente.

Novità nella versione 12.8.0: questo parametro è stato introdotto nella versione DELL'API '2021-06-08'.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità della versione 12.1.0.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

Dict della proprietà aggiornata dai file (Etag e ultima modifica).

Tipo restituito

dict(str, Any)

start_copy_from_url

Avvia la copia dei dati da un URL di origine nel file a cui fa riferimento il client.

Lo stato di questa operazione di copia è disponibile usando il metodo get_properties .

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

Parametri

source_url: str

Necessario

Specifica l'URL del file di origine.

file_permission: str

Se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory/file. Questo valore può essere impostato su "source" per copiare il descrittore di sicurezza dal file di origine. In caso contrario, questo valore verrà usato per eseguire l'override del valore di origine. Se non è impostato, il valore dell'autorizzazione viene ereditato dalla directory padre del file di destinazione. Questa impostazione può essere usata se la dimensione dell'autorizzazione è <= 8 KB, in caso contrario, permission_key deve essere usata. Se SDDL viene specificato come input, deve avere proprietario, gruppo e dacl. Nota: deve essere specificato solo uno dei file_permission o permission_key.

Novità nella versione 12.1.0: questo parametro è stato introdotto nella versione API '2019-07-07'.

permission_key: str

Chiave dell'autorizzazione da impostare per la directory/file. Questo valore può essere impostato su "source" per copiare il descrittore di sicurezza dal file di origine. In caso contrario, questo valore verrà usato per eseguire l'override del valore di origine. Se non è impostato, il valore dell'autorizzazione viene ereditato dalla directory padre del file di destinazione. Nota: deve essere specificato solo uno dei file_permission o permission_key.

Novità nella versione 12.1.0: questo parametro è stato introdotto nella versione API '2019-07-07'.

file_attributes: NTFSAttributes

Questo valore può essere impostato su "source" per copiare gli attributi di file dal file di origine al file di destinazione oppure per cancellare tutti gli attributi, può essere impostato su "Nessuno". In caso contrario, può essere impostato su un elenco di attributi da impostare nel file di destinazione. Se non è impostato, il valore predefinito è "Archivio".

Novità nella versione 12.1.0: questo parametro è stato introdotto nella versione API '2019-07-07'.

file_creation_time: str oppure datetime

Questo valore può essere impostato su "source" per copiare l'ora di creazione dal file di origine al file di destinazione oppure una datatime da impostare come ora di creazione nel file di destinazione. Potrebbe anche essere una stringa in formato ISO 8601. Se non è impostato, l'ora di creazione verrà impostata sul valore dell'ora di data della creazione (o quando è stato sovrascritto) del file di destinazione dal motore di copia.

Novità nella versione 12.1.0: questo parametro è stato introdotto nella versione API '2019-07-07'.

file_last_write_time: str oppure datetime

Questo valore può essere impostato su "source" per copiare l'ultima ora di scrittura dal file di origine al file di destinazione oppure una datatime da impostare come ultima ora di scrittura nel file di destinazione. Potrebbe anche essere una stringa in formato ISO 8601. Se non è impostato, il valore sarà l'ultima volta di scrittura nel file dal motore di copia.

Novità nella versione 12.1.0: questo parametro è stato introdotto nella versione API '2019-07-07'.

file_change_time: str oppure datetime

Modificare il tempo per il file. Se non specificato, l'ora di modifica verrà impostata sulla data/ora corrente.

Novità nella versione 12.9.0: questo parametro è stato introdotto nella versione API '2021-06-08'.

ignore_read_only: bool

Specifica l'opzione per sovrascrivere il file di destinazione se esiste già e ha un set di attributi di sola lettura.

Novità nella versione 12.1.0: questo parametro è stato introdotto nella versione API '2019-07-07'.

set_archive_attribute: bool

Specifica l'opzione per impostare l'attributo di archivio nel file di destinazione. True significa che l'attributo di archivio verrà impostato nel file di destinazione nonostante gli overridi degli attributi o lo stato del file di origine.

Novità nella versione 12.1.0: questo parametro è stato introdotto nella versione API '2019-07-07'.

metadata

Coppie nome-valore associate al file come metadati.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità nella versione 12.1.0.

timeout: int

Tipo restituito

dict(str, Any)

Esempio

Copiare un file da un URL


   destination_file.start_copy_from_url(source_url=source_url)

upload_file

Carica un nuovo file.

dati param: contenuto del file.

param int length: lunghezza del file in byte. Specificare le dimensioni massime fino a 1 TiB.

param file_attributes: attributi del file system per file e directory. Se non è impostato, il valore predefinito sarà "Nessuno" e gli attributi verranno impostati su "Archivio". Ecco un esempio per quando il tipo var è str: 'Temporary|Archivio'. file_attributes valore non è distinzione tra maiuscole e minuscole.

tipo file_attributes: str o ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: tempo di creazione per il valore predefinito del file: ora.

tipo file_creation_time: str o ~datetime.datetime

param file_last_write_time: ultima ora di scrittura per il valore predefinito del file: ora.

tipo file_last_write_time: str o ~datetime.datetime

param file_permission: se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory/file. Questa intestazione può essere usata se le dimensioni dell'autorizzazione sono <= 8 KB, è necessario usare l'intestazione x-ms-file-permission-key. Valore predefinito: Eredita. Se SDDL viene specificato come input, deve avere proprietario, gruppo e dacl. Nota: è necessario specificare una sola delle autorizzazioni x-ms-file-permission o x-ms-file-permission-key.

tipo file_permission: str

param permission_key: chiave dell'autorizzazione da impostare per la directory/file. Nota: è necessario specificare una sola delle autorizzazioni x-ms-file-permission o x-ms-file-permission-key.

tipo 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]

Parametri

file_change_time

Modificare il tempo per il file. Se non specificato, l'ora di modifica verrà impostata sulla data/ora corrente.

Novità nella versione 12.8.0: questo parametro è stato introdotto nell'API versione '2021-06-08'.

paramtype file_change_time: str o ~datetime.datetime

metadati della parola chiave dict(str,str): coppie nome-valore associate al file come metadati.

parola chiave ~azure.storage.fileshare.ContentSettings content_settings: oggetto ContentSettings usato per impostare le proprietà dei file. Usato per impostare il tipo di contenuto, la codifica, la lingua, l'eliminazione, md5 e il controllo cache.

parola chiave bool validate_content: se true, calcola un hash MD5 per ogni intervallo del file. Il servizio di archiviazione controlla l'hash del contenuto che è arrivato con l'hash inviato. Questo è principalmente utile per rilevare bitflips sul cavo se si usa http anziché https come https (impostazione predefinita) già convalida. Si noti che questo hash MD5 non viene archiviato con il file.

parola chiave int max_concurrency: numero massimo di connessioni parallele da usare.

lease delle parole chiave: obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità nella versione 12.1.0.

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

parola chiave progress_hook: callback per tenere traccia dello stato di avanzamento di un caricamento a esecuzione prolungata. La firma è function(current: int, total: Optional[int]) dove current è il numero di byte trasferiti finora e il totale è la dimensione del BLOB o Nessuno se la dimensione è sconosciuta.

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

parola chiave int timeout: imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

codifica str della parola chiave: impostazione predefinita su UTF-8.

restituisce: proprietà aggiornata file dict (Etag e ultima modifica).

rtype: dict(str, Any)

Esempio:Caricare un file.


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

upload_range

Caricare un intervallo di byte in un file.

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

Parametri

data: bytes

Necessario

Dati da caricare.

offset: int

Necessario

Inizio dell'intervallo di byte da usare per il caricamento di una sezione del file. L'intervallo può essere fino a 4 MB di dimensioni.

length: int

Necessario

Numero di byte da usare per il caricamento di una sezione del file. L'intervallo può avere dimensioni fino a 4 MB.

validate_content: bool

Se true, calcola un hash MD5 del contenuto della pagina. Il servizio di archiviazione controlla l'hash del contenuto che è arrivato con l'hash inviato. Questo è particolarmente utile per rilevare bitflips in transito se si usa http anziché https come https (impostazione predefinita) verrà già convalidata. Si noti che questo hash MD5 non viene archiviato con il file .

file_last_write_mode: Literal["preserve", "now"]

Se l'ora dell'ultima scrittura del file deve essere mantenuta o sovrascritta. I valori possibili sono "preserve" o "now". Se non specificato, l'ora dell'ultima scrittura del file verrà modificata in data/ora corrente.

Novità nella versione 12.8.0: questo parametro è stato introdotto nella versione DELL'API '2021-06-08'.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità della versione 12.1.0.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

encoding: str

Il valore predefinito è UTF-8.

Restituisce

Dict della proprietà aggiornata dai file (Etag e ultima modifica).

Tipo restituito

Dict[str, Any]

upload_range_from_url

Scrive i byte da un endpoint file di Azure nell'intervallo specificato di un altro endpoint file di Azure.

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

Parametri

offset: int

Necessario

Inizio dell'intervallo di byte da usare per l'aggiornamento di una sezione del file. L'intervallo può avere dimensioni fino a 4 MB.

length: int

Necessario

Numero di byte da utilizzare per l'aggiornamento di una sezione del file. L'intervallo può avere dimensioni fino a 4 MB.

source_url: str

Necessario

URL di lunghezza massima di 2 KB che specifica un file o un BLOB di Azure. La codifica del valore deve essere di tipo URL in quanto viene visualizzato in un URI di richiesta. Se l'origine si trova in un altro account, l'origine deve essere pubblica o deve essere autenticata tramite una firma di accesso condiviso. Se l'origine è pubblica, non è necessaria alcuna autenticazione. Esempi: https://myaccount.file.core.windows.net/myshare/mydir/myfile https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken

source_offset: int

Necessario

Indica l'inizio dell'intervallo di byte (inclusi) che deve essere tratto dall'origine della copia. Il servizio leggerà lo stesso numero di byte dell'intervallo di destinazione (offset di lunghezza).

source_if_modified_since: datetime

Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione condizionale per copiare il Blob solo se il Blob di origine è stato modificato dopo la data e l'ora specificate.

source_if_unmodified_since: datetime

Valore DateTime. Azure prevede che il valore della data passato sia UTC. Se il fuso orario è incluso, le datetime non UTC verranno convertite in formato UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC. Specificare questa intestazione condizionale per copiare il Blob solo se il Blob di origine non è stato modificato dopo la data e l'ora specificate.

source_etag: str

Valore ETag di origine o carattere jolly (*). Usato per verificare se la risorsa è stata modificata e agire in base alla condizione specificata dal parametro match_condition .

source_match_condition: MatchConditions

Condizione di corrispondenza di origine da utilizzare sull'etag.

file_last_write_mode: Literal["preserve", "now"]

Novità nella versione 12.8.0: questo parametro è stato introdotto nella versione DELL'API '2021-06-08'.

lease: ShareLeaseClient oppure str

Obbligatorio se il file ha un lease attivo. Il valore può essere un oggetto ShareLeaseClient o l'ID lease come stringa.

Novità della versione 12.1.0.

timeout: int

Imposta il timeout lato server per l'operazione in secondi. Per informazioni dettagliate, vedere https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Questo valore non viene rilevato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

source_authorization: str

Eseguire l'autenticazione come entità servizio usando un segreto client per accedere a un BLOB di origine. Assicurarsi che "bearer" sia il prefisso della stringa source_authorization.

Attributi

api_version

Versione dell'API di archiviazione usata per le richieste.

location_mode

Modalità percorso attualmente usata dal client.

Per impostazione predefinita, questo sarà "primario". Le opzioni includono "primary" e "secondary".

primary_endpoint

URL dell'endpoint primario completo.

primary_hostname

Nome host dell'endpoint primario.

secondary_endpoint

URL dell'endpoint secondario completo se configurato.

Se non è disponibile, verrà generato un valore ValueError. Per specificare in modo esplicito un nome host secondario, usare l'argomento della parola chiave facoltativo secondary_hostname nell'istanza.

Eccezioni

ValueError

secondary_hostname

Nome host dell'endpoint secondario.

Se non è disponibile, questo sarà Nessuno. Per specificare in modo esplicito un nome host secondario, usare l'argomento della parola chiave facoltativo secondary_hostname nell'istanza.

url

URL completo dell'endpoint per questa entità, incluso il token di firma di accesso condiviso se usato.

Questo potrebbe essere l'endpoint primario o l'endpoint secondario a seconda dell'oggetto corrente location_mode. :restituisce: URL completo dell'endpoint per questa entità, incluso il token di firma di accesso condiviso se usato. :rtype: str

Condividi tramite

ShareFileClient Classe

Costruttore

Parametri

Metodi

abort_copy

Parametri

Tipo restituito

acquire_lease

Parametri

Restituisce

Tipo restituito

Esempio

clear_range

Parametri

Restituisce

Tipo restituito

close

close_all_handles

Parametri

Restituisce

Tipo restituito

close_handle

Parametri

Restituisce

Tipo restituito

create_file

Parametri

Restituisce

Tipo restituito

Esempio

delete_file

Parametri

Tipo restituito

Esempio

download_file

Parametri

Restituisce

Tipo restituito

Esempio

from_connection_string

Parametri

Restituisce

Tipo restituito

Esempio

from_file_url

Parametri

Restituisce

Tipo restituito

get_file_properties

Parametri

Restituisce

Tipo restituito

get_ranges

Parametri

Restituisce

Tipo restituito

get_ranges_diff

Parametri

Restituisce

Tipo restituito

list_handles

Parametri

Restituisce

Tipo restituito

rename_file

Parametri

Restituisce

Tipo restituito

resize_file

Parametri

Restituisce

Tipo restituito

set_file_metadata

Parametri

Restituisce

Tipo restituito

set_http_headers

Parametri

Restituisce