Delen via

ShareClient Klas

  • Referentie

Een client om te communiceren met een specifieke share, hoewel die share mogelijk nog niet bestaat.

Voor bewerkingen die betrekking hebben op een specifieke map of bestand in deze share, kunnen de clients voor die entiteiten ook worden opgehaald met behulp van de get_directory_client functies en get_file_client .

Klik hier voor meer optionele configuratie.

Overname
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin
ShareClient

Constructor

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)

Parameters

account_url
str
Vereist

De URI naar het opslagaccount. Als u een client wilt maken op basis van de volledige URI voor de share, gebruikt u de from_share_url klassemethode.

share_name
str
Vereist

De naam van de share waarmee u wilt communiceren.

snapshot
str
standaardwaarde: None

Een optionele momentopname van de share waarop moet worden uitgevoerd. Dit kan de tekenreeks van de momentopname-id zijn of het antwoord dat wordt geretourneerd door create_snapshot.

credential
standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor een account of een exemplaar van een TokenCredentials-klasse van azure.identity. Als de resource-URI al een SAS-token bevat, wordt dit genegeerd ten gunste van een expliciete referentie

  • behalve in het geval van AzureSasCredential, waarbij de conflicterende SAS-tokens een ValueError genereren. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'naam' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.
token_intent
Literal['backup']

Vereist bij gebruik van TokenCredential voor verificatie en genegeerd voor andere vormen van verificatie. Hiermee geeft u de intentie voor alle aanvragen bij het gebruik van TokenCredential-verificatie . Mogelijke waarden zijn:

back-up: hiermee geeft u aan dat aanvragen zijn bedoeld voor back-up-/beheerbewerkingen, wat betekent dat alle ACL's voor bestanden/mappen worden overgeslagen en dat volledige machtigingen worden verleend. De gebruiker moet ook de vereiste RBAC-machtiging hebben.

allow_trailing_dot
bool

Als dit waar is, wordt de afsluitende punt niet afgekapt van de doel-URI.

allow_source_trailing_dot
bool

Als dit waar is, wordt de afsluitende stip niet afgekapt vanuit de bron-URI.

api_version
str

De storage-API-versie die moet worden gebruikt voor aanvragen. De standaardwaarde is de meest recente serviceversie die compatibel is met de huidige SDK. Instellen op een oudere versie kan leiden tot verminderde compatibiliteit van functies.

Nieuw in versie 12.1.0.

secondary_hostname
str

De hostnaam van het secundaire eindpunt.

max_range_size
int

De maximale bereikgrootte die wordt gebruikt voor het uploaden van een bestand. De standaardwaarde is 4*1024*1024.

Methoden

acquire_lease

Vraagt een nieuwe lease aan.

Als de share geen actieve lease heeft, maakt de Share-service een lease voor de share en retourneert een nieuwe lease.

Nieuw in versie 12.5.0.
close

Deze methode is om de sockets te sluiten die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met contextbeheer.
create_directory

Hiermee maakt u een map in de share en retourneert u een client om met de map te communiceren.
create_permission_for_share

Maak een machtiging (een beveiligingsdescriptor) op shareniveau.

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

Hiermee maakt u een nieuwe share onder het account. Als er al een share met dezelfde naam bestaat, mislukt de bewerking.
create_snapshot

Hiermee maakt u een momentopname van de share.

Een momentopname is een alleen-lezen versie van een share die op een bepaald moment is gemaakt. Deze kan worden gelezen, gekopieerd of verwijderd, maar niet worden gewijzigd. Momentopnamen bieden een manier om een back-up te maken van een share zoals deze op een bepaald moment wordt weergegeven.

Een momentopname van een share heeft dezelfde naam als de basisshare van waaruit de momentopname wordt gemaakt, waarbij een Datum/tijd-waarde is toegevoegd om aan te geven op welk tijdstip de momentopname is gemaakt.
delete_directory

Markeert de map voor verwijdering. De map wordt later verwijderd tijdens de garbagecollection.
delete_share

Hiermee wordt de opgegeven share gemarkeerd voor verwijdering. De share wordt later verwijderd tijdens de garbagecollection.
from_connection_string

Maak ShareClient op basis van een verbindingsreeks.
from_share_url
get_directory_client

Vraag een client om te communiceren met de opgegeven map. De map hoeft nog niet te bestaan.
get_file_client

Vraag een client om te communiceren met het opgegeven bestand. Het bestand hoeft nog niet te bestaan.
get_permission_for_share

Een machtiging (een beveiligingsdescriptor) ophalen voor een bepaalde sleutel.

Deze machtiging kan worden gebruikt voor de bestanden/mappen in de share.
get_share_access_policy

Hiermee haalt u de machtigingen voor de share op. De machtigingen geven aan of bestanden in een share openbaar kunnen worden geopend.
get_share_properties

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

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

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

Hiermee worden de mappen en bestanden onder de share weergegeven.
set_share_access_policy

Hiermee stelt u de machtigingen voor de share in of het opgeslagen toegangsbeleid dat kan worden gebruikt met Shared Access Signatures. De machtigingen geven aan of bestanden in een share openbaar kunnen worden geopend.
set_share_metadata

Hiermee stelt u de metagegevens voor de share in.

Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de share zijn gekoppeld. Als u alle metagegevens uit de share wilt verwijderen, roept u deze bewerking aan zonder metagegevensdict.
set_share_properties

Hiermee stelt u de share-eigenschappen in.

Nieuw in versie 12.4.0.
set_share_quota

Hiermee stelt u het quotum voor de share in.

acquire_lease

Vraagt een nieuwe lease aan.

Als de share geen actieve lease heeft, maakt de Share-service een lease voor de share en retourneert een nieuwe lease.

Nieuw in versie 12.5.0.

acquire_lease(**kwargs: Any) -> ShareLeaseClient

Parameters

lease_duration
int

Hiermee geeft u de duur van de lease op, in seconden, of negatief (-1) voor een lease die nooit verloopt. Een niet-oneindige lease kan tussen 15 en 60 seconden duren. Een leaseduur kan niet worden gewijzigd met behulp van vernieuwen of wijzigen. De standaardwaarde is -1 (oneindige lease).

lease_id
str

Voorgestelde lease-id, in een GUID-tekenreeksindeling. De shareservice retourneert 400 (ongeldige aanvraag) als de voorgestelde lease-id niet de juiste indeling heeft.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een ShareLeaseClient-object.

Retourtype

ShareLeaseClient

Voorbeelden

Het verkrijgen van een lease op een aandeel.


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

close

Deze methode is om de sockets te sluiten die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met contextbeheer.

close()

create_directory

Hiermee maakt u een map in de share en retourneert u een client om met de map te communiceren.

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

Parameters

directory_name
str
Vereist

De naam van de map.

metadata

Naam-waardeparen die als metagegevens aan de map zijn gekoppeld.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

ShareDirectoryClient

Retourtype

ShareDirectoryClient

create_permission_for_share

Maak een machtiging (een beveiligingsdescriptor) op shareniveau.

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

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

Parameters

file_permission
str
Vereist

Bestandsmachtiging, een draagbare SDDL

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een bestandsmachtigingssleutel

Retourtype

str

create_share

Hiermee maakt u een nieuwe share onder het account. Als er al een share met dezelfde naam bestaat, mislukt de bewerking.

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

Parameters

metadata
dict(str,str)

Naam-waardeparen die als metagegevens aan de share zijn gekoppeld.

quota
int

Het quotum dat moet worden toegewezen.

access_tier

Hiermee geeft u de toegangslaag van de share op. Mogelijke waarden: 'TransactionOptimized', 'Hot', 'Cool'

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

protocols
str of ShareProtocols

Protocollen die moeten worden ingeschakeld op de share. Er kan slechts één protocol worden ingeschakeld voor de share.

root_squash
str of ShareRootSquash

Root squash om in te stellen op de share. Alleen geldig voor NFS-shares. Mogelijke waarden zijn: 'NoRootSquash', 'RootSquash', 'AllSquash'.

Retouren

Bijgewerkte eigenschapsdict (Etag en laatst gewijzigd).

Retourtype

Dict[str, Any]

Voorbeelden

Hiermee maakt u een bestandsshare.


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

create_snapshot

Hiermee maakt u een momentopname van de share.

Een momentopname is een alleen-lezen versie van een share die op een bepaald moment is gemaakt. Deze kan worden gelezen, gekopieerd of verwijderd, maar niet worden gewijzigd. Momentopnamen bieden een manier om een back-up te maken van een share zoals deze op een bepaald moment wordt weergegeven.

Een momentopname van een share heeft dezelfde naam als de basisshare van waaruit de momentopname wordt gemaakt, waarbij een Datum/tijd-waarde is toegevoegd om aan te geven op welk tijdstip de momentopname is gemaakt.

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

Parameters

metadata
dict(str,str)

Naam-waardeparen die als metagegevens aan de share zijn gekoppeld.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Bijgewerkt eigenschapsdict (momentopname-id, Etag en laatst gewijzigd).

Retourtype

dict[str, Any]

Voorbeelden

Hiermee maakt u een momentopname van de bestandsshare.


   share.create_snapshot()

delete_directory

Markeert de map voor verwijdering. De map wordt later verwijderd tijdens de garbagecollection.

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

Parameters

directory_name
str
Vereist

De naam van de map.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retourtype

None

delete_share

Hiermee wordt de opgegeven share gemarkeerd voor verwijdering. De share wordt later verwijderd tijdens de garbagecollection.

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

Parameters

delete_snapshots
bool
Vereist

Geeft aan of momentopnamen moeten worden verwijderd.

lease

Vereist als de share een actieve lease heeft. Waarde kan een ShareLeaseClient-object zijn of de lease-id als een tekenreeks.

Nieuw in versie 12.5.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-08-04'.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Voorbeelden

Hiermee verwijdert u de share en eventuele momentopnamen.


   share.delete_share(delete_snapshots=True)

from_connection_string

Maak ShareClient op basis van een verbindingsreeks.

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

Parameters

conn_str
str
Vereist

Een connection string naar een Azure Storage-account.

share_name
str
Vereist

De naam van de share.

snapshot
str
standaardwaarde: None

De optionele momentopname van de share waarop moet worden uitgevoerd. Dit kan de tekenreeks van de momentopname-id zijn of het antwoord dat wordt geretourneerd door create_snapshot.

credential
standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor een account of een exemplaar van een TokenCredentials-klasse van azure.identity. Als de resource-URI al een SAS-token bevat, wordt dit genegeerd ten gunste van een expliciete referentie

  • behalve in het geval van AzureSasCredential, waarbij de conflicterende SAS-tokens een ValueError genereren. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'naam' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

Retouren

Een shareclient.

Retourtype

ShareClient

Voorbeelden

Hiermee haalt u de shareclient op uit connection string.


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

from_share_url 

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

Parameters

share_url
str
Vereist

De volledige URI naar de share.

snapshot
str
standaardwaarde: None

Een optionele momentopname van de share waarop moet worden uitgevoerd. Dit kan de tekenreeks van de momentopname-id zijn of het antwoord dat wordt geretourneerd door create_snapshot.

credential
standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor een account of een exemplaar van een TokenCredentials-klasse van azure.identity. Als de resource-URI al een SAS-token bevat, wordt dit genegeerd ten gunste van een expliciete referentie

  • behalve in het geval van AzureSasCredential, waarbij de conflicterende SAS-tokens een ValueError genereren. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'naam' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

Retouren

Een shareclient.

Retourtype

ShareClient

get_directory_client

Vraag een client om te communiceren met de opgegeven map. De map hoeft nog niet te bestaan.

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

Parameters

directory_path
str
standaardwaarde: None

Pad naar de opgegeven map.

Retouren

Een directoryclient.

Retourtype

ShareDirectoryClient

get_file_client

Vraag een client om te communiceren met het opgegeven bestand. Het bestand hoeft nog niet te bestaan.

get_file_client(file_path: str) -> ShareFileClient

Parameters

file_path
str
Vereist

Pad naar het opgegeven bestand.

Retouren

Een bestandsclient.

Retourtype

ShareFileClient

get_permission_for_share

Een machtiging (een beveiligingsdescriptor) ophalen voor een bepaalde sleutel.

Deze machtiging kan worden gebruikt voor de bestanden/mappen in de share.

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

Parameters

permission_key
str
Vereist

Sleutel van de bestandsmachtiging om op te halen

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een bestandsmachtiging (een draagbare SDDL)

Retourtype

str

get_share_access_policy

Hiermee haalt u de machtigingen voor de share op. De machtigingen geven aan of bestanden in een share openbaar kunnen worden geopend.

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

Parameters

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

lease

Vereist als de share een actieve lease heeft. Waarde kan een ShareLeaseClient-object zijn of de lease-id als een tekenreeks.

Nieuw in versie 12.5.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-08-04'.

Retouren

Toegang tot beleidsinformatie in een dict.

Retourtype

dict[str, Any]

get_share_properties

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

get_share_properties(**kwargs: Any) -> ShareProperties

Parameters

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

lease

Vereist als de share een actieve lease heeft. Waarde kan een ShareLeaseClient-object zijn of de lease-id als een tekenreeks.

Nieuw in versie 12.5.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-08-04'.

Retouren

De eigenschappen van de share.

Retourtype

ShareProperties

Voorbeelden

Hiermee haalt u de eigenschappen van de share op.


   properties = share.get_share_properties()

get_share_stats

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

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

get_share_stats(**kwargs: Any) -> int

Parameters

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

lease

Vereist als de share een actieve lease heeft. Waarde kan een ShareLeaseClient-object zijn of de lease-id als een tekenreeks.

Nieuw in versie 12.5.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-08-04'.

Retouren

De geschatte grootte van de gegevens (in bytes) die zijn opgeslagen op de share.

Retourtype

int

list_directories_and_files

Hiermee worden de mappen en bestanden onder de share weergegeven.

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

Parameters

directory_name
str
Vereist

Naam van een map.

name_starts_with
str
Vereist

Filtert de resultaten om alleen mappen te retourneren waarvan de naam begint met het opgegeven voorvoegsel.

marker
str
Vereist

Een ondoorzichtig vervolgtoken. Deze waarde kan worden opgehaald uit het next_marker veld van een eerder generatorobject. Indien opgegeven, begint deze generator met het retourneren van resultaten vanaf dit punt.

include
list[str]

Neem deze parameter op om een of meer gegevenssets op te geven die moeten worden opgenomen in het antwoord. Mogelijke str-waarden zijn 'timestamps', 'Etag', 'Attributes', 'PermissionKey'.

Nieuw in versie 12.6.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-10-02'.

include_extended_info
bool

Als dit is ingesteld op true, wordt de bestands-id geretourneerd in de lijst met resultaten.

Nieuw in versie 12.6.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-10-02'.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

Retouren

Een automatische paging-iterable van dict-achtige DirectoryEigenschappen en Bestandseigenschappen

Retourtype

Iterable[Dict[str,str]]

Voorbeelden

Mappen en bestanden in de share weergeven.


   # 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)

set_share_access_policy

Hiermee stelt u de machtigingen voor de share in of het opgeslagen toegangsbeleid dat kan worden gebruikt met Shared Access Signatures. De machtigingen geven aan of bestanden in een share openbaar kunnen worden geopend.

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

Parameters

signed_identifiers
dict(str, AccessPolicy)
Vereist

Een woordenlijst met toegangsbeleidsregels die aan de share moeten worden gekoppeld. De woordenlijst kan maximaal 5 elementen bevatten. Met een lege woordenlijst wordt het toegangsbeleid dat voor de service is ingesteld, gewist.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

lease

Vereist als de share een actieve lease heeft. Waarde kan een ShareLeaseClient-object zijn of de lease-id als een tekenreeks.

Nieuw in versie 12.5.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-08-04'.

Retouren

Bijgewerkte eigenschapsdict (Etag en laatst gewijzigd).

Retourtype

dict(str, Any)

set_share_metadata

Hiermee stelt u de metagegevens voor de share in.

Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de share zijn gekoppeld. Als u alle metagegevens uit de share wilt verwijderen, roept u deze bewerking aan zonder metagegevensdict.

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

Parameters

metadata
dict(str, str)
Vereist

Naam-waardeparen die als metagegevens aan de share zijn gekoppeld.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

lease

Vereist als de share een actieve lease heeft. Waarde kan een ShareLeaseClient-object zijn of de lease-id als een tekenreeks.

Nieuw in versie 12.5.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-08-04'.

Retouren

Bijgewerkte eigenschapsdict (Etag en laatst gewijzigd).

Retourtype

dict(str, Any)

Voorbeelden

Hiermee stelt u de metagegevens van de share in.


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

set_share_properties

Hiermee stelt u de share-eigenschappen in.

Nieuw in versie 12.4.0.

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

Parameters

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

Hiermee geeft u de toegangslaag van de share op. Mogelijke waarden: 'TransactionOptimized', 'Hot' en 'Cool'

quota
int

Hiermee geeft u de maximale grootte van de share, in gigabytes. Moet groter zijn dan 0 en kleiner dan of gelijk aan 5 TB.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

root_squash
str of ShareRootSquash

Root squash om in te stellen op de share. Alleen geldig voor NFS-shares. Mogelijke waarden zijn: 'NoRootSquash', 'RootSquash', 'AllSquash'.

lease

Vereist als de share een actieve lease heeft. Waarde kan een ShareLeaseClient-object zijn of de lease-id als een tekenreeks.

Retouren

Bijgewerkte eigenschapsdict (Etag en laatst gewijzigd).

Retourtype

dict(str, Any)

Voorbeelden

Hiermee stelt u de share-eigenschappen in.


   # 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)

set_share_quota

Hiermee stelt u het quotum voor de share in.

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

Parameters

quota
int
Vereist

Hiermee geeft u de maximale grootte van de share, in gigabytes. Moet groter zijn dan 0 en kleiner dan of gelijk aan 5 TB.

timeout
int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.

lease

Vereist als de share een actieve lease heeft. Waarde kan een ShareLeaseClient-object zijn of de lease-id als een tekenreeks.

Nieuw in versie 12.5.0.

Dit trefwoordargument is geïntroduceerd in API-versie '2020-08-04'.

Retouren

Bijgewerkte eigenschapsdict (Etag en laatst gewijzigd).

Retourtype

dict(str, Any)

Voorbeelden

Hiermee stelt u het quotum voor de share in.


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

Kenmerken

api_version

De versie van de Storage-API die wordt gebruikt voor aanvragen.

location_mode

De locatiemodus die de client momenteel gebruikt.

Dit is standaard 'primair'. Opties zijn 'primair' en 'secundair'.

primary_endpoint

De volledige URL van het primaire eindpunt.

primary_hostname

De hostnaam van het primaire eindpunt.

secondary_endpoint

De volledige URL van het secundaire eindpunt, indien geconfigureerd.

Als dit niet beschikbaar is, wordt er een ValueError gegenereerd. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname sleutelwoordargument bij instantiëring.

Uitzonderingen

ValueError

secondary_hostname

De hostnaam van het secundaire eindpunt.

Als dit niet beschikbaar is, is dit Geen. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname sleutelwoordargument bij instantiëring.

url

De volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt.

Dit kan het primaire eindpunt of het secundaire eindpunt zijn, afhankelijk van de huidige location_mode. :retourneert: de volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt. :rtype: str