ShareDirectoryClient Classe

Un client per interagire con una directory specifica, anche se potrebbe non esistere ancora.

Per le operazioni relative a una sottodirectory o a un file specifico in questa condivisione, è anche possibile recuperare i client per tali entità usando le get_subdirectory_client funzioni e get_file_client .

Per altre configurazioni facoltative, fare clic qui.

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

Costruttore

ShareDirectoryClient(account_url: str, share_name: str, directory_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 alla directory, usare il from_directory_url metodo classmethod.

share_name
str
Necessario

Nome della condivisione per la directory.

directory_path
str
Necessario

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

snapshot
str
valore predefinito: None

Snapshot di condivisione facoltativo in cui operare. Può trattarsi della stringa dell'ID snapshot o della risposta restituita da create_snapshot.

credential
valore predefinito: None

Credenziali con cui eseguire l'autenticazione. Questa opzione è facoltativa se l'URL dell'account ha già un token di firma di accesso condiviso. Il valore può essere una stringa di token di firma di accesso condiviso, un'istanza di AzureSasCredential o AzureNamedKeyCredential da azure.core.credentials, 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, verrà ignorato a favore di una credenziale esplicita

  • tranne nel caso di AzureSasCredential, in cui i token di firma di accesso condiviso 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 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 di file/directory vengono ignorati e vengono concesse autorizzazioni complete. L'utente deve avere anche l'autorizzazione controllo degli accessi in base al ruolo 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à della versione 12.1.0.

secondary_hostname
str

Nome host dell'endpoint secondario.

max_range_size
int

Dimensione massima dell'intervallo utilizzata per un caricamento di file. Il valore predefinito è 4*1024*1024.

audience
str

Destinatari da usare quando si richiedono token per l'autenticazione di Azure Active Directory. Ha effetto solo quando la credenziale è di tipo TokenCredential. Il valore può essere https://storage.azure.com/ (predefinito) o https://.file.core.windows.net.

Metodi

close

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

close_all_handles

Chiudere eventuali handle di file aperti.

Questa operazione verrà bloccata fino a quando il servizio non ha chiuso tutti gli handle aperti.

close_handle

Chiudere un handle di file aperto.

create_directory

Crea una nuova directory nella directory a cui fa riferimento il client.

create_subdirectory

Crea una nuova sottodirectory e restituisce un client per interagire con la sottodirectory.

delete_directory

Contrassegna la directory per l'eliminazione. La directory viene eliminata successivamente durante la Garbage Collection.

delete_file

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

delete_subdirectory

Elimina una sottodirectory.

exists

Restituisce True se esiste una directory e restituisce False in caso contrario.

from_connection_string

Creare ShareDirectoryClient da una stringa di connessione.

from_directory_url

Creare un oggetto ShareDirectoryClient da un URL della directory.

get_directory_properties

Restituisce tutti i metadati e le proprietà di sistema definiti dall'utente per la directory specificata. I dati restituiti non includono l'elenco dei file della directory.

get_file_client

Ottenere un client per interagire con un file specifico.

Il file non esiste già.

get_subdirectory_client

Ottenere un client per interagire con una sottodirectory specifica.

La sottodirectory non esiste già.

list_directories_and_files

Elenca tutte le directory e i file nella directory.

list_handles

Elenca gli handle aperti in una directory o in un file nella directory.

rename_directory

Rinominare la directory di origine.

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

Ora di creazione per la directory.

: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 la directory. 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'.

set_directory_metadata

Imposta i metadati per la directory.

Ogni chiamata a questa operazione sostituisce tutti i metadati esistenti collegati alla directory. Per rimuovere tutti i metadati dalla directory, chiamare questa operazione con un dict di metadati vuoto.

set_http_headers

Imposta le intestazioni HTTP nella directory.

upload_file

Crea un nuovo file nella directory e restituisce un oggetto ShareFileClient per interagire con il file.

close

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

close()

close_all_handles

Chiudere eventuali handle di file aperti.

Questa operazione verrà bloccata fino a quando il servizio non ha chiuso tutti gli handle aperti.

close_all_handles(recursive: bool = False, **kwargs: Any) -> Dict[str, int]

Parametri

recursive
bool
Necessario

Valore booleano che specifica se l'operazione deve essere applicata alla directory specificata dal client, dai relativi file, dalle relative sottodirectory e dai relativi file. Il valore predefinito è False.

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

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

Tipo restituito

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

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

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

Tipo restituito

create_directory

Crea una nuova directory nella directory a cui fa riferimento il client.

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

Parametri

file_attributes
NTFSAttributes

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

file_creation_time
str oppure datetime

Ora di creazione per la directory. Valore predefinito: "now".

file_last_write_time
str oppure datetime

Ora dell'ultima scrittura per la directory. Valore predefinito: "now".

file_permission
str

Se è stata specificata l'autorizzazione (descrittore di sicurezza) deve essere impostata per la directory o il file. Questa intestazione può essere usata se la dimensione dell'autorizzazione è <= 8 KB, verrà usata l'intestazione file-permission-key. Valore predefinito: Eredita. Se SDDL viene specificato come input, deve avere proprietario, gruppo e dacl. Nota: è necessario specificare solo una delle autorizzazioni file o della chiave di autorizzazione file.

file_permission_key
str

Chiave dell'autorizzazione da impostare per la directory o il file. Nota: è necessario specificare solo una delle autorizzazioni file o della chiave di autorizzazione file.

file_change_time
str oppure datetime

Modifica dell'ora per la directory. 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'.

metadata
dict(str,str)

Coppie nome-valore associate alla directory come metadati.

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 dalla directory (Etag e ultima modifica).

Tipo restituito

Esempio

Crea una directory.


   my_directory.create_directory()

create_subdirectory

Crea una nuova sottodirectory e restituisce un client per interagire con la sottodirectory.

create_subdirectory(directory_name: str, **kwargs) -> ShareDirectoryClient

Parametri

directory_name
str
Necessario

Nome della sottodirectory.

metadata
dict(str,str)

Coppie nome-valore associate alla sottodirectory come metadati.

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.

Restituisce

ShareDirectoryClient

Tipo restituito

Esempio

Creare una sottodirectory.


   # Create the directory
   parent_dir.create_directory()

   # Create a subdirectory
   subdir = parent_dir.create_subdirectory("subdir")

delete_directory

Contrassegna la directory per l'eliminazione. La directory viene eliminata successivamente durante la Garbage Collection.

delete_directory(**kwargs: Any) -> None

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 monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Tipo restituito

Esempio

Elimina una directory.


   my_directory.delete_directory()

delete_file

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

delete_file(file_name: str, **kwargs: Any | None) -> None

Parametri

file_name
str
Necessario

Nome del file da eliminare.

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

Esempio

Eliminare un file in una directory.


   # Delete the file in the directory
   my_directory.delete_file(file_name="sample")

delete_subdirectory

Elimina una sottodirectory.

delete_subdirectory(directory_name: str, **kwargs) -> None

Parametri

directory_name
str
Necessario

Nome della sottodirectory.

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

Esempio

Eliminare una sottodirectory.


   parent_dir.delete_subdirectory("subdir")

exists

Restituisce True se esiste una directory e restituisce False in caso contrario.

exists(**kwargs: Any) -> bool

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 monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

True se la directory esiste, False in caso contrario.

Tipo restituito

from_connection_string

Creare ShareDirectoryClient da una stringa di connessione.

from_connection_string(conn_str: str, share_name: str, directory_path: str, 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.

directory_path
str
Necessario

Percorso della directory.

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.
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.

Restituisce

Un client di directory.

Tipo restituito

from_directory_url

Creare un oggetto ShareDirectoryClient da un URL della directory.

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

Parametri

directory_url
str
Necessario

URI completo della directory.

snapshot
str
valore predefinito: None

Snapshot di condivisione facoltativo su cui operare. 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.
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.

Restituisce

Un client di directory.

Tipo restituito

get_directory_properties

Restituisce tutti i metadati e le proprietà di sistema definiti dall'utente per la directory specificata. I dati restituiti non includono l'elenco dei file della directory.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

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 monitorato o convalidato nel client. Per configurare i timeout di rete lato client, vedere qui.

Restituisce

DirectoryProperties

Tipo restituito

get_file_client

Ottenere un client per interagire con un file specifico.

Il file non esiste già.

get_file_client(file_name: str, **kwargs: Any) -> ShareFileClient

Parametri

file_name
str
Necessario

Nome del file.

Restituisce

Un client di file.

Tipo restituito

get_subdirectory_client

Ottenere un client per interagire con una sottodirectory specifica.

La sottodirectory non esiste già.

get_subdirectory_client(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

Parametri

directory_name
str
Necessario

Nome della sottodirectory.

Restituisce

Client directory.

Tipo restituito

Esempio

Ottiene il client di sottodirectory.


   # Get a directory client and create the directory
   parent = share.get_directory_client("dir1")
   parent.create_directory()

   # Get a subdirectory client and create the subdirectory "dir1/dir2"
   subdirectory = parent.get_subdirectory_client("dir2")
   subdirectory.create_directory()

list_directories_and_files

Elenca tutte le directory e i file nella directory.

list_directories_and_files(name_starts_with: str | None = None, **kwargs: Any) -> ItemPaged

Parametri

name_starts_with
str
Necessario

Filtra i risultati per restituire solo entità i cui nomi iniziano con il prefisso specificato.

include
list[str]

Includere questo parametro per specificare uno o più set di dati da includere nella risposta. I valori str possibili sono "timestamp", "Etag", "Attributes", "PermissionKey".

Novità nella versione 12.6.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-10-02'.

include_extended_info
bool

Se questa impostazione è impostata su true, l'ID file verrà restituito nei risultati elencati.

Novità nella versione 12.6.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-10-02'.

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.

Restituisce

Iterabile di paging automatico di proprietà directory e proprietà file

Tipo restituito

Esempio

Elencare directory e file.


   # List the directories and files under the parent directory
   my_list = list(parent_dir.list_directories_and_files())
   print(my_list)

list_handles

Elenca gli handle aperti in una directory o in un file nella directory.

list_handles(recursive: bool = False, **kwargs: Any) -> ItemPaged[Handle]

Parametri

recursive
bool
Necessario

Boolean che specifica se l'operazione deve essere applicata alla directory specificata dal client, ai relativi file, alle relative sottodirectory e ai relativi file. Il valore predefinito è False.

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.

Restituisce

Iterabile a paging automatico di Handle

Tipo restituito

rename_directory

Rinominare la directory di origine.

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

Ora di creazione per la directory.

: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 la directory. 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_directory(new_name: str, **kwargs: Any) -> ShareDirectoryClient

Parametri

metadata
Dict[str,str]

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

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 directory.

Tipo restituito

set_directory_metadata

Imposta i metadati per la directory.

Ogni chiamata a questa operazione sostituisce tutti i metadati esistenti collegati alla directory. Per rimuovere tutti i metadati dalla directory, chiamare questa operazione con un dict di metadati vuoto.

set_directory_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parametri

metadata
dict(str, str)
Necessario

Coppie nome-valore associate alla directory come metadati.

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 dalla directory (Etag e ultima modifica).

Tipo restituito

set_http_headers

Imposta le intestazioni HTTP nella directory.

set_http_headers(file_attributes: str | NTFSAttributes = 'none', 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

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 la directory. 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'.

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

upload_file

Crea un nuovo file nella directory e restituisce un oggetto ShareFileClient per interagire con il file.

upload_file(file_name: str, data: bytes | str | Iterable | IO, length: int | None = None, **kwargs) -> ShareFileClient

Parametri

file_name
str
Necessario

Nome del file.

data
Necessario

Contenuto del file,

length
int
Necessario

Lunghezza del file in byte. Specificare la dimensione massima, fino a 1 TiB.

metadata
dict(str,str)

Coppie nome-valore associate al file come metadati.

content_settings
ContentSettings

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.

validate_content
bool

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 è 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 .

max_concurrency
int

Numero massimo di connessioni parallele da usare.

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

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.

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

ShareFileClient

Tipo restituito

Esempio

Caricare un file in una directory.


   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source:
       my_directory.upload_file(file_name="sample", data=source)

Attributi

api_version

Versione dell'API di archiviazione usata per le richieste.

location_mode

Modalità di posizione attualmente usata dal client.

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

primary_endpoint

URL completo dell'endpoint primario.

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 facoltativo secondary_hostname parola chiave nella creazione di istanze.

Eccezioni

secondary_hostname

Nome host dell'endpoint secondario.

Se non disponibile, non sarà disponibile. Per specificare in modo esplicito un nome host secondario, usare l'argomento facoltativo secondary_hostname parola chiave nella creazione di istanze.

url

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

Può trattarsi dell'endpoint primario o dell'endpoint secondario a seconda dell'oggetto corrente location_mode. :returns: URL completo dell'endpoint per questa entità, incluso il token di firma di accesso condiviso, se usato. :rtype: str