ShareClient Klass
En klient för att interagera med en viss resurs, även om den resursen kanske inte finns ännu.
För åtgärder som rör en specifik katalog eller fil i den här resursen kan klienterna för dessa entiteter också hämtas med hjälp av get_directory_client funktionerna och get_file_client .
Klicka här om du vill ha mer valfri konfiguration.
- Arv
-
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixinShareClient
Konstruktor
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)
Parametrar
- account_url
- str
URI:n till lagringskontot. Använd classmethod för att skapa en klient som tilldelats den fullständiga URI:n till resursen from_share_url .
- snapshot
- str
En valfri resursögonblicksbild som ska användas. Det kan vara strängen för ögonblicksbilds-ID eller svaret som returneras från create_snapshot.
- credential
De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift
- utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "name" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.
- token_intent
- Literal['backup']
Krävs vid användning av TokenCredential för autentisering och ignoreras för andra former av autentisering. Anger avsikten för alla begäranden när du använder TokenCredential-autentisering . Möjliga värden:
backup – Anger att begäranden är avsedda för säkerhetskopierings-/administratörstypåtgärder, vilket innebär att alla fil-/katalog-ACL:er kringgås och fullständiga behörigheter beviljas. Användaren måste också ha nödvändig RBAC-behörighet.
- allow_trailing_dot
- bool
Om det är sant kommer den avslutande punkten inte att trimmas från mål-URI:n.
- allow_source_trailing_dot
- bool
Om det är sant kommer den avslutande punkten inte att trimmas från käll-URI:n.
- api_version
- str
Den Storage API-version som ska användas för begäranden. Standardvärdet är den senaste tjänstversionen som är kompatibel med aktuell SDK. Om du anger en äldre version kan funktionskompatibiliteten minska.
Ny i version 12.1.0.
- secondary_hostname
- str
Värdnamnet för den sekundära slutpunkten.
- max_range_size
- int
Den maximala intervallstorleken som används för en filuppladdning. Standardvärdet är 4*1024*1024
.
Metoder
acquire_lease |
Begär ett nytt lån. Om resursen inte har ett aktivt lån skapar Share Service ett lån för resursen och returnerar ett nytt lån. Ny i version 12.5.0. |
close |
Den här metoden är att stänga de sockets som öppnas av klienten. Den behöver inte användas när du använder med en kontexthanterare. |
create_directory |
Skapar en katalog i resursen och returnerar en klient för att interagera med katalogen. |
create_permission_for_share |
Skapa en behörighet (en säkerhetsbeskrivning) på resursnivå. Den här behörigheten kan användas för filerna/katalogerna i resursen. Om det redan finns ett "tillstånd" ska det returnera nyckeln till det, annars skapas ett nytt tillstånd på resursnivå och dess nyckel returneras. |
create_share |
Skapar en ny resurs under kontot. Om det redan finns en resurs med samma namn misslyckas åtgärden. |
create_snapshot |
Skapar en ögonblicksbild av resursen. En ögonblicksbild är en skrivskyddad version av en resurs som tas vid en tidpunkt. Den kan läsas, kopieras eller tas bort, men inte ändras. Ögonblicksbilder är ett sätt att säkerhetskopiera en resurs så som den visas just nu. En ögonblicksbild av en resurs har samma namn som basresursen som ögonblicksbilden tas från, med ett DateTime-värde som anger tidpunkten då ögonblicksbilden togs. |
delete_directory |
Markerar katalogen för borttagning. Katalogen tas senare bort under skräpinsamlingen. |
delete_share |
Markerar den angivna resursen för borttagning. Resursen tas senare bort under skräpinsamlingen. |
from_connection_string |
Skapa ShareClient från en anslutningssträng. |
from_share_url | |
get_directory_client |
Få en klient att interagera med den angivna katalogen. Katalogen behöver inte redan finnas. |
get_file_client |
Hämta en klient för att interagera med den angivna filen. Filen behöver inte redan finnas. |
get_permission_for_share |
Hämta en behörighet (en säkerhetsbeskrivning) för en viss nyckel. Den här behörigheten kan användas för filerna/katalogerna i resursen. |
get_share_access_policy |
Hämtar behörigheterna för resursen. Behörigheterna anger om filer i en resurs kan nås offentligt. |
get_share_properties |
Returnerar alla användardefinierade metadata och systemegenskaper för den angivna resursen. De data som returneras innehåller inte resursernas lista över filer eller kataloger. |
get_share_stats |
Hämtar den ungefärliga storleken på data som lagras på resursen i byte. Observera att det här värdet kanske inte innehåller alla nyligen skapade eller nyligen omstorade filer. |
list_directories_and_files |
Visar en lista över kataloger och filer under resursen. |
set_share_access_policy |
Anger behörigheter för resursen eller lagrade åtkomstprinciper som kan användas med signaturer för delad åtkomst. Behörigheterna anger om filer i en resurs kan kommas åt offentligt. |
set_share_metadata |
Anger metadata för resursen. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till resursen. Om du vill ta bort alla metadata från resursen anropar du den här åtgärden utan metadatadikt. |
set_share_properties |
Anger resursegenskaperna. Ny i version 12.4.0. |
set_share_quota |
Anger resursens kvot. |
acquire_lease
Begär ett nytt lån.
Om resursen inte har ett aktivt lån skapar Share Service ett lån för resursen och returnerar ett nytt lån.
Ny i version 12.5.0.
acquire_lease(**kwargs: Any) -> ShareLeaseClient
Parametrar
- lease_duration
- int
Anger lånets varaktighet, i sekunder eller negativt (-1) för ett lån som aldrig upphör att gälla. Ett icke-oändligt lån kan vara mellan 15 och 60 sekunder. Det går inte att ändra en lånetid med hjälp av förnyelse eller ändring. Standardvärdet är -1 (oändligt lån).
- lease_id
- str
Föreslaget låne-ID i ett GUID-strängformat. Share Service returnerar 400 (ogiltig begäran) om det föreslagna låne-ID:t inte har rätt format.
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
Returer
Ett ShareLeaseClient-objekt.
Returtyp
Exempel
Skaffa ett lån på en resurs.
share.create_directory("mydir")
lease = share.acquire_lease()
share.get_share_properties(lease=lease)
share.delete_share(lease=lease)
close
Den här metoden är att stänga de sockets som öppnas av klienten. Den behöver inte användas när du använder med en kontexthanterare.
close()
create_directory
Skapar en katalog i resursen och returnerar en klient för att interagera med katalogen.
create_directory(directory_name: str, **kwargs: Any) -> ShareDirectoryClient
Parametrar
- metadata
Namn/värde-par som är associerade med katalogen som metadata.
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
Returer
ShareDirectoryClient
Returtyp
create_permission_for_share
Skapa en behörighet (en säkerhetsbeskrivning) på resursnivå.
Den här behörigheten kan användas för filerna/katalogerna i resursen. Om det redan finns ett "tillstånd" ska det returnera nyckeln till det, annars skapas ett nytt tillstånd på resursnivå och dess nyckel returneras.
create_permission_for_share(file_permission: str, **kwargs: Any) -> str
Parametrar
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
Returer
En filbehörighetsnyckel
Returtyp
create_share
Skapar en ny resurs under kontot. Om det redan finns en resurs med samma namn misslyckas åtgärden.
create_share(**kwargs: Any) -> Dict[str, Any]
Parametrar
- quota
- int
Den kvot som ska tilldelas.
- access_tier
Anger resursens åtkomstnivå. Möjliga värden: TransactionOptimized, Hot, Cool
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
- protocols
- str eller ShareProtocols
Protokoll som ska aktiveras på resursen. Endast ett protokoll kan aktiveras på resursen.
- root_squash
- str eller ShareRootSquash
Rot squash för att ställa in på resursen. Gäller endast för NFS-resurser. Möjliga värden är: NoRootSquash, RootSquash, AllSquash.
Returer
Delningsuppdaterad egenskapsdikt (Etag och senast ändrad).
Returtyp
Exempel
Skapar en filresurs.
# Create share with Access Tier set to Hot
share.create_share(access_tier=ShareAccessTier("Hot"))
create_snapshot
Skapar en ögonblicksbild av resursen.
En ögonblicksbild är en skrivskyddad version av en resurs som tas vid en tidpunkt. Den kan läsas, kopieras eller tas bort, men inte ändras. Ögonblicksbilder är ett sätt att säkerhetskopiera en resurs så som den visas just nu.
En ögonblicksbild av en resurs har samma namn som basresursen som ögonblicksbilden tas från, med ett DateTime-värde som anger tidpunkten då ögonblicksbilden togs.
create_snapshot(**kwargs: Any | None) -> Dict[str, Any]
Parametrar
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
Returer
Share-updated property dict (Snapshot ID, Etag och senast ändrad).
Returtyp
Exempel
Skapar en ögonblicksbild av filresursen.
share.create_snapshot()
delete_directory
Markerar katalogen för borttagning. Katalogen tas senare bort under skräpinsamlingen.
delete_directory(directory_name: str, **kwargs: Any) -> None
Parametrar
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
Returtyp
delete_share
Markerar den angivna resursen för borttagning. Resursen tas senare bort under skräpinsamlingen.
delete_share(delete_snapshots: bool | None = False, **kwargs) -> None
Parametrar
- lease
Krävs om resursen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.
Nytt i version 12.5.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-08-04".
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
Exempel
Tar bort resursen och eventuella ögonblicksbilder.
share.delete_share(delete_snapshots=True)
from_connection_string
Skapa ShareClient från en anslutningssträng.
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
Parametrar
- snapshot
- str
Den valfria resursögonblicksbild som ska användas. Detta kan vara ögonblicksbildens ID-sträng eller svaret som returneras från create_snapshot.
- credential
De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift
- utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.
Returer
En resursklient.
Returtyp
Exempel
Hämtar resursklienten från anslutningssträngen.
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
Parametrar
- snapshot
- str
En valfri resursögonblicksbild som ska användas. Detta kan vara ögonblicksbildens ID-sträng eller svaret som returneras från create_snapshot.
- credential
De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift
- utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.
Returer
En resursklient.
Returtyp
get_directory_client
Få en klient att interagera med den angivna katalogen. Katalogen behöver inte redan finnas.
get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient
Parametrar
Returer
En katalogklient.
Returtyp
get_file_client
Hämta en klient för att interagera med den angivna filen. Filen behöver inte redan finnas.
get_file_client(file_path: str) -> ShareFileClient
Parametrar
Returer
En filklient.
Returtyp
get_permission_for_share
Hämta en behörighet (en säkerhetsbeskrivning) för en viss nyckel.
Den här behörigheten kan användas för filerna/katalogerna i resursen.
get_permission_for_share(permission_key: str, **kwargs: Any) -> str
Parametrar
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
Returer
En filbehörighet (en bärbar SDDL)
Returtyp
get_share_access_policy
Hämtar behörigheterna för resursen. Behörigheterna anger om filer i en resurs kan nås offentligt.
get_share_access_policy(**kwargs: Any) -> Dict[str, Any]
Parametrar
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
- lease
Krävs om resursen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.
Nytt i version 12.5.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-08-04".
Returer
Få åtkomst till principinformation i en dikta.
Returtyp
get_share_properties
Returnerar alla användardefinierade metadata och systemegenskaper för den angivna resursen. De data som returneras innehåller inte resursernas lista över filer eller kataloger.
get_share_properties(**kwargs: Any) -> ShareProperties
Parametrar
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
- lease
Krävs om resursen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.
Nytt i version 12.5.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-08-04".
Returer
Resursegenskaperna.
Returtyp
Exempel
Hämtar resursegenskaperna.
properties = share.get_share_properties()
get_share_stats
Hämtar den ungefärliga storleken på data som lagras på resursen i byte.
Observera att det här värdet kanske inte innehåller alla nyligen skapade eller nyligen omstorade filer.
get_share_stats(**kwargs: Any) -> int
Parametrar
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
- lease
Krävs om resursen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.
Nytt i version 12.5.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-08-04".
Returer
Den ungefärliga storleken på data (i byte) som lagras på resursen.
Returtyp
list_directories_and_files
Visar en lista över kataloger och filer under resursen.
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]]
Parametrar
- name_starts_with
- str
Filtrerar resultatet så att endast kataloger vars namn börjar med det angivna prefixet returneras.
- marker
- str
En täckande fortsättningstoken. Det här värdet kan hämtas från fältet next_marker i ett tidigare generatorobjekt. Om den här generatorn anges börjar den returnera resultat från den här punkten.
Inkludera den här parametern för att ange en eller flera datauppsättningar som ska ingå i svaret. Möjliga str-värden är "timestamps", "Etag", "Attributes", "PermissionKey".
Ny i version 12.6.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-10-02".
- include_extended_info
- bool
Om detta är inställt på true returneras fil-ID i resultat i listan.
Ny i version 12.6.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-10-02".
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
Returer
En automatisk sidindelning som kan iterera diktaliknande DirectoryProperties och FileProperties
Returtyp
Exempel
Lista kataloger och filer i resursen.
# 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
Anger behörigheter för resursen eller lagrade åtkomstprinciper som kan användas med signaturer för delad åtkomst. Behörigheterna anger om filer i en resurs kan kommas åt offentligt.
set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]
Parametrar
- signed_identifiers
- dict(str, AccessPolicy)
En ordlista med åtkomstprinciper som ska associeras med resursen. Ordlistan kan innehålla upp till 5 element. En tom ordlista rensar de åtkomstprinciper som angetts för tjänsten.
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
- lease
Krävs om resursen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.
Ny i version 12.5.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-08-04".
Returer
Delningsuppdaterad egenskapsdikt (Etag och senast ändrad).
Returtyp
set_share_metadata
Anger metadata för resursen.
Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till resursen. Om du vill ta bort alla metadata från resursen anropar du den här åtgärden utan metadatadikt.
set_share_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Parametrar
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
- lease
Krävs om resursen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.
Ny i version 12.5.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-08-04".
Returer
Delningsuppdaterad egenskapsdikt (Etag och senast ändrad).
Returtyp
Exempel
Anger resursmetadata.
data = {'category': 'test'}
share.set_share_metadata(metadata=data)
set_share_properties
Anger resursegenskaperna.
Ny i version 12.4.0.
set_share_properties(**kwargs: Any) -> Dict[str, Any]
Parametrar
- access_tier
- str eller <xref:azure.storage.fileshare.models.ShareAccessTier>
Anger resursens åtkomstnivå. Möjliga värden: TransactionOptimized, Hot och Cool
- quota
- int
Anger den maximala storleken för resursen i gigabyte. Måste vara större än 0 och mindre än eller lika med 5 TB.
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
- root_squash
- str eller ShareRootSquash
Rot squash för att ställa in på resursen. Gäller endast för NFS-resurser. Möjliga värden är: NoRootSquash, RootSquash, AllSquash.
- lease
Krävs om resursen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.
Returer
Delningsuppdaterad egenskapsdikt (Etag och senast ändrad).
Returtyp
Exempel
Anger resursegenskaperna.
# 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
Anger resursens kvot.
set_share_quota(quota: int, **kwargs: Any) -> Dict[str, Any]
Parametrar
- quota
- int
Anger den maximala storleken för resursen i gigabyte. Måste vara större än 0 och mindre än eller lika med 5 TB.
- timeout
- int
Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.
- lease
Krävs om resursen har ett aktivt lån. Värdet kan vara ett ShareLeaseClient-objekt eller låne-ID:t som en sträng.
Ny i version 12.5.0.
Det här nyckelordsargumentet introducerades i API-versionen "2020-08-04".
Returer
Delningsuppdaterad egenskapsdikt (Etag och senast ändrad).
Returtyp
Exempel
Anger resurskvoten.
# Set the quota for the share to 1GB
share.set_share_quota(quota=1)
Attribut
api_version
Den version av Storage-API:et som används för begäranden.
location_mode
Det platsläge som klienten använder för närvarande.
Som standard är detta "primärt". Alternativen är "primär" och "sekundär".
primary_endpoint
Den fullständiga primära slutpunkts-URL:en.
primary_hostname
Värdnamnet för den primära slutpunkten.
secondary_endpoint
Den fullständiga sekundära slutpunkts-URL:en om den har konfigurerats.
Om den inte är tillgänglig utlöses en ValueError. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.
Undantag
secondary_hostname
Värdnamnet för den sekundära slutpunkten.
Om det inte är tillgängligt blir detta Ingen. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.
url
Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används.
Detta kan vara antingen den primära slutpunkten eller den sekundära slutpunkten beroende på aktuell location_mode. :returns: Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används. :rtype: str
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för