ShareClient Classe

Riferimento

Un client che interagisce con una condivisione specifica, anche se tale condivisione potrebbe non esistere ancora.

Per le operazioni relative a una directory o a un file specifico in questa condivisione, i client per tali entità possono essere recuperati anche usando le get_directory_client funzioni e get_file_client .

Per altre configurazioni facoltative, fare clic qui.

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

ShareClient

Costruttore

ShareClient(account_url: str, share_name: 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 condivisione, usare il from_share_url metodo classmethod.

share_name: str

Necessario

Nome della condivisione con cui interagire.

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.

Metodi

acquire_lease	Richiede un nuovo lease. Se la condivisione non dispone di un lease attivo, il servizio di condivisione crea un lease nella condivisione e restituisce un nuovo lease. Novità nella versione 12.5.0.
close	Questo metodo consiste nel chiudere i socket aperti dal client. Non è necessario usarlo quando si usa con un gestore di contesto.
create_directory	Crea una directory nella condivisione e restituisce un client per interagire con la directory.
create_permission_for_share	Creare un'autorizzazione (descrittore di sicurezza) a livello di condivisione. Questa "autorizzazione" può essere usata per i file/directory nella condivisione. Se esiste già un'autorizzazione, restituirà la chiave, altrimenti crea una nuova autorizzazione a livello di condivisione e ne restituisce la chiave.
create_share	Crea una nuova condivisione nell'account. Se esiste già una condivisione con lo stesso nome, l'operazione ha esito negativo.
create_snapshot	Crea uno snapshot della condivisione. Uno snapshot è una versione di sola lettura di una condivisione che viene eseguita in un momento. Può essere letto, copiato o eliminato, ma non modificato. Gli snapshot offrono un modo per eseguire il backup di una condivisione come viene visualizzato al momento. Uno snapshot di una condivisione ha lo stesso nome della condivisione di base da cui viene eseguito lo snapshot, con un valore DateTime aggiunto per indicare l'ora in cui è stato eseguito lo snapshot.
delete_directory	Contrassegna la directory per l'eliminazione. La directory viene eliminata successivamente durante la Garbage Collection.
delete_share	Contrassegna la condivisione specificata per l'eliminazione. La condivisione viene eliminata successivamente durante la Garbage Collection.
from_connection_string	Creare ShareClient da una stringa di connessione.
from_share_url
get_directory_client	Ottenere un client per interagire con la directory specificata. La directory non esiste già.
get_file_client	Ottenere un client per interagire con il file specificato. Il file non esiste già.
get_permission_for_share	Ottenere un'autorizzazione (descrittore di sicurezza) per una determinata chiave. Questa 'autorizzazione' può essere usata per i file/directory nella condivisione.
get_share_access_policy	Ottiene le autorizzazioni per la condivisione. Le autorizzazioni indicano se i file in una condivisione possono essere accessibili pubblicamente.
get_share_properties	Restituisce tutti i metadati e le proprietà di sistema definiti dall'utente per la condivisione specificata. I dati restituiti non includono l'elenco di file o directory delle condivisioni.
get_share_stats	Ottiene le dimensioni approssimative dei dati archiviati nella condivisione in byte. Si noti che questo valore potrebbe non includere tutti i file creati di recente o ridimensionati di recente.
list_directories_and_files	Elenca le directory e i file nella condivisione.
set_share_access_policy	Imposta le autorizzazioni per la condivisione o i criteri di accesso archiviati che possono essere usati con firme di accesso condiviso. Le autorizzazioni indicano se i file in una condivisione possono essere accessibili pubblicamente.
set_share_metadata	Imposta i metadati per la condivisione. Ogni chiamata a questa operazione sostituisce tutti i metadati esistenti collegati alla condivisione. Per rimuovere tutti i metadati dalla condivisione, chiamare questa operazione senza metadati.
set_share_properties	Imposta le proprietà della condivisione. Novità nella versione 12.4.0.
set_share_quota	Imposta la quota per la condivisione.

acquire_lease

Richiede un nuovo lease.

Se la condivisione non dispone di un lease attivo, il servizio di condivisione crea un lease nella condivisione e restituisce un nuovo lease.

Novità nella versione 12.5.0.

acquire_lease(**kwargs: Any) -> ShareLeaseClient

Parametri

lease_duration: int

Specifica la durata del lease, in secondi, o un uno negativo (-1) per un lease che non scade mai. Un lease non infinito può essere compreso tra 15 e 60 secondi. Non è possibile modificare una durata del lease usando il rinnovo o la modifica. Il valore predefinito è -1 (lease infinito).

lease_id: str

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

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

Oggetto ShareLeaseClient.

Tipo restituito

ShareLeaseClient

Esempio

Acquisizione di un lease su una condivisione.


   share.create_directory("mydir")
   lease = share.acquire_lease()
   share.get_share_properties(lease=lease)
   share.delete_share(lease=lease)

close

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

close()

create_directory

Crea una directory nella condivisione e restituisce un client per interagire con la directory.

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

Parametri

directory_name: str

Necessario

Nome della directory.

metadata

Coppie nome-valore associate alla directory come metadati.

timeout: int

Restituisce

ShareDirectoryClient

Tipo restituito

ShareDirectoryClient

Creare un'autorizzazione (descrittore di sicurezza) a livello di condivisione.

Questa "autorizzazione" può essere usata per i file/directory nella condivisione. Se esiste già un'autorizzazione, restituirà la chiave, altrimenti crea una nuova autorizzazione a livello di condivisione e ne restituisce la chiave.

create_permission_for_share(file_permission: str, **kwargs: Any) -> str

Parametri

file_permission: str

Necessario

Autorizzazione per i file, un FILE SDDL portatile

timeout: int

Restituisce

Una chiave di autorizzazione file

Tipo restituito

str

Crea una nuova condivisione nell'account. Se esiste già una condivisione con lo stesso nome, l'operazione ha esito negativo.

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

Parametri

metadata: dict(str,str)

Coppie nome-valore associate alla condivisione come metadati.

quota: int

Quota da assegnare.

access_tier

Specifica il livello di accesso della condivisione. Valori possibili: 'TransactionOptimized', 'Hot', 'Cool'

timeout: int

protocols: str oppure ShareProtocols

Protocolli da abilitare nella condivisione. Nella condivisione è possibile abilitare un solo protocollo.

root_squash: str oppure ShareRootSquash

Root squash da impostare sulla condivisione. Valido solo per le condivisioni NFS. I valori possibili includono: 'NoRootSquash', 'RootSquash', 'AllSquash'.

Restituisce

Dict della proprietà aggiornata di condivisione (Etag e ultima modifica).

Tipo restituito

Dict[str, Any]

Esempio

Crea una condivisione file.


   # Create share with Access Tier set to Hot
   share.create_share(access_tier=ShareAccessTier("Hot"))

create_snapshot

Crea uno snapshot della condivisione.

Uno snapshot è una versione di sola lettura di una condivisione che viene eseguita in un momento. Può essere letto, copiato o eliminato, ma non modificato. Gli snapshot offrono un modo per eseguire il backup di una condivisione come viene visualizzato al momento.

Uno snapshot di una condivisione ha lo stesso nome della condivisione di base da cui viene eseguito lo snapshot, con un valore DateTime aggiunto per indicare l'ora in cui è stato eseguito lo snapshot.

create_snapshot(**kwargs: Any | None) -> Dict[str, Any]

Parametri

metadata: dict(str,str)

Coppie nome-valore associate alla condivisione 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

Proprietà aggiornata di condivisione (ID snapshot, Etag e ultima modifica).

Tipo restituito

dict[str, Any]

Esempio

Crea uno snapshot della condivisione file.


   share.create_snapshot()

delete_directory

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

delete_directory(directory_name: str, **kwargs: Any) -> None

Parametri

directory_name: str

Necessario

Nome della directory.

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

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

delete_share(delete_snapshots: bool | None = False, **kwargs) -> None

Parametri

delete_snapshots: bool

Necessario

Indica se gli snapshot devono essere eliminati.

lease

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

Novità nella versione 12.5.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-08-04'.

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.

Esempio

Elimina la condivisione e tutti gli snapshot.


   share.delete_share(delete_snapshots=True)

from_connection_string

Creare ShareClient da una stringa di connessione.

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

Stringa di connessione a un account di archiviazione di Azure.

share_name: str

Necessario

Nome della condivisione.

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.

Restituisce

Client di condivisione.

Tipo restituito

ShareClient

Esempio

Ottiene il client di condivisione dalla stringa di connessione.


   from azure.storage.fileshare import ShareClient
   share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")

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

Parametri

share_url: str

Necessario

URI completo della condivisione.

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

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.

Restituisce

Client di condivisione.

Tipo restituito

ShareClient

get_directory_client

Ottenere un client per interagire con la directory specificata. La directory non esiste già.

get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient

Parametri

directory_path: str

valore predefinito: None

Percorso della directory specificata.

Restituisce

Client directory.

Tipo restituito

ShareDirectoryClient

get_file_client

Ottenere un client per interagire con il file specificato. Il file non esiste già.

get_file_client(file_path: str) -> ShareFileClient

Parametri

file_path: str

Necessario

Percorso del file specificato.

Restituisce

Un client di file.

Tipo restituito

ShareFileClient

Ottenere un'autorizzazione (descrittore di sicurezza) per una determinata chiave.

Questa 'autorizzazione' può essere usata per i file/directory nella condivisione.

get_permission_for_share(permission_key: str, **kwargs: Any) -> str

Parametri

permission_key: str

Necessario

Chiave dell'autorizzazione del file da recuperare

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

Autorizzazione file (sdDL portatile)

Tipo restituito

str

Ottiene le autorizzazioni per la condivisione. Le autorizzazioni indicano se i file in una condivisione possono essere accessibili pubblicamente.

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

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.

lease

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

Novità nella versione 12.5.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-08-04'.

Restituisce

Accedere alle informazioni sui criteri in un dict.

Tipo restituito

dict[str, Any]

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

get_share_properties(**kwargs: Any) -> ShareProperties

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.

lease

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

Novità nella versione 12.5.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-08-04'.

Restituisce

Proprietà di condivisione.

Tipo restituito

ShareProperties

Esempio

Ottiene le proprietà della condivisione.


   properties = share.get_share_properties()

Ottiene le dimensioni approssimative dei dati archiviati nella condivisione in byte.

Si noti che questo valore potrebbe non includere tutti i file creati di recente o ridimensionati di recente.

get_share_stats(**kwargs: Any) -> int

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.

lease

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

Novità nella versione 12.5.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-08-04'.

Restituisce

Dimensioni approssimative dei dati (in byte) archiviati nella condivisione.

Tipo restituito

int

list_directories_and_files

Elenca le directory e i file nella condivisione.

list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]

Parametri

directory_name: str

Necessario

Nome di una directory.

name_starts_with: str

Necessario

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

marker: str

Necessario

Token di continuazione opaco. Questo valore può essere recuperato dal campo next_marker di un oggetto generatore precedente. Se specificato, questo generatore inizierà a restituire i risultati da questo punto.

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

Iterable[Dict[str,str]]

Esempio

Elencare directory e file nella condivisione.


   # Create a directory in the share
   dir_client = share.create_directory("mydir")

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

   # List files in the directory
   my_files = list(share.list_directories_and_files(directory_name="mydir"))
   print(my_files)

Imposta le autorizzazioni per la condivisione o i criteri di accesso archiviati che possono essere usati con firme di accesso condiviso. Le autorizzazioni indicano se i file in una condivisione possono essere accessibili pubblicamente.

set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]

Parametri

signed_identifiers: dict(str, AccessPolicy)

Necessario

Dizionario dei criteri di accesso da associare alla condivisione. Il dizionario può contenere fino a 5 elementi. Un dizionario vuoto cancella i criteri di accesso impostati nel servizio.

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.

lease

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

Novità nella versione 12.5.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-08-04'.

Restituisce

Proprietà aggiornata di condivisione (Etag e ultima modifica).

Tipo restituito

dict(str, Any)

Imposta i metadati per la condivisione.

Ogni chiamata a questa operazione sostituisce tutti i metadati esistenti collegati alla condivisione. Per rimuovere tutti i metadati dalla condivisione, chiamare questa operazione senza metadati.

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

Parametri

metadata: dict(str, str)

Necessario

Coppie nome-valore associate alla condivisione 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.

lease

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

Novità nella versione 12.5.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-08-04'.

Restituisce

Proprietà aggiornata di condivisione (Etag e ultima modifica).

Tipo restituito

dict(str, Any)

Esempio

Imposta i metadati di condivisione.


   data = {'category': 'test'}
   share.set_share_metadata(metadata=data)

Imposta le proprietà della condivisione.

Novità nella versione 12.4.0.

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

Parametri

access_tier: str oppure <xref:azure.storage.fileshare.models.ShareAccessTier>

Specifica il livello di accesso della condivisione. Valori possibili: 'TransactionOptimized', 'Hot' e 'Cool'

quota: int

Specifica le dimensioni massime in gigabyte della condivisione. Deve essere maggiore di 0 e minore o uguale a 5 TB.

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.

root_squash: str oppure ShareRootSquash

Squash radice da impostare sulla condivisione. Valido solo per le condivisioni NFS. I valori possibili includono: 'NoRootSquash', 'RootSquash', 'AllSquash'.

lease

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

Restituisce

Proprietà aggiornata di condivisione (Etag e ultima modifica).

Tipo restituito

dict(str, Any)

Esempio

Imposta le proprietà della condivisione.


   # Set the tier for the first share to Hot
   share1.set_share_properties(access_tier="Hot")
   # Set the quota for the first share to 3
   share1.set_share_properties(quota=3)
   # Set the tier for the second share to Cool and quota to 2
   share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)

   # Get the shares' properties
   print(share1.get_share_properties().access_tier)
   print(share1.get_share_properties().quota)
   print(share2.get_share_properties().access_tier)
   print(share2.get_share_properties().quota)

Imposta la quota per la condivisione.

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

Parametri

quota: int

Necessario

Specifica le dimensioni massime in gigabyte della condivisione. Deve essere maggiore di 0 e minore o uguale a 5 TB.

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.

lease

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

Novità nella versione 12.5.0.

Questo argomento della parola chiave è stato introdotto nella versione api '2020-08-04'.

Restituisce

Proprietà aggiornata di condivisione (Etag e ultima modifica).

Tipo restituito

dict(str, Any)

Esempio

Imposta la quota di condivisione.


   # Set the quota for the share to 1GB
   share.set_share_quota(quota=1)

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

ValueError

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