ShareClient class

Pakket:: @azure/storage-file-share

Een ShareClient vertegenwoordigt een URL naar de Azure Storage-share, zodat u de mappen en bestanden ervan kunt bewerken.

Uitbreiding: StorageClient

Constructors

ShareClient(string, Credential \| TokenCredential, ShareClientOptions)	Hiermee maakt u een exemplaar van ShareClient.
ShareClient(string, Pipeline, ShareClientConfig)	Hiermee maakt u een exemplaar van ShareClient.
ShareClient(string, string, ShareClientOptions)

Eigenschappen

name

De naam van de share

rootDirectoryClient

Hiermee haalt u de mapclient op voor de hoofdmap van deze share. Houd er rekening mee dat de hoofdmap altijd bestaat en niet kan worden verwijderd.

Een nieuw ShareDirectoryClient-object voor de hoofdmap.

Overgenomen eigenschappen

accountName
url	URL-tekenreekswaarde.

Methoden

create(ShareCreateOptions)	Hiermee maakt u een nieuwe share onder het opgegeven account. Als de share met dezelfde naam al bestaat, mislukt de bewerking. Zie https://learn.microsoft.com/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	Hiermee maakt u een nieuwe submap onder deze share. Zie https://learn.microsoft.com/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	Hiermee maakt u een nieuw bestand of vervangt u een bestand onder de hoofdmap van deze share. Houd er rekening mee dat het bestand alleen wordt geïnitialiseerd zonder inhoud. Zie https://learn.microsoft.com/rest/api/storageservices/create-file
createIfNotExists(ShareCreateOptions)	Hiermee maakt u een nieuwe share onder het opgegeven account. Als de share met dezelfde naam al bestaat, wordt deze niet gewijzigd. Zie https://learn.microsoft.com/rest/api/storageservices/create-share
createPermission(string \| SharePermission, ShareCreatePermissionOptions)	Hiermee maakt u een bestandsmachtiging (een beveiligingsdescriptor) op shareniveau. De gemaakte beveiligingsdescriptor kan worden gebruikt voor de bestanden/mappen in de share. Zie https://learn.microsoft.com/rest/api/storageservices/create-permission
createSnapshot(ShareCreateSnapshotOptions)	Hiermee maakt u een alleen-lezen momentopname van een share.
delete(ShareDeleteMethodOptions)	Markeert de opgegeven share voor verwijdering. De share en eventuele mappen of bestanden in de share worden later verwijderd tijdens de garbagecollection. Zie https://learn.microsoft.com/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	Hiermee verwijdert u de opgegeven lege submap onder deze share. Houd er rekening mee dat de map leeg moet zijn voordat deze kan worden verwijderd. Zie https://learn.microsoft.com/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	Hiermee verwijdert u een bestand onder de hoofdmap van deze share uit het opslagaccount. Wanneer een bestand is verwijderd, wordt het onmiddellijk verwijderd uit de index van het opslagaccount en is het niet meer toegankelijk voor clients. De gegevens van het bestand worden later uit de service verwijderd tijdens de garbagecollection. Bestand verwijderen mislukt met statuscode 409 (Conflict) en foutcode `SharingViolation` als het bestand is geopend op een SMB-client. Bestand verwijderen wordt niet ondersteund op een momentopname van een share. Dit is een alleen-lezen kopie van een share. Een poging om deze bewerking uit te voeren op een momentopname van een share mislukt met 400 (`InvalidQueryParameterValue`) Zie https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	Markeert de opgegeven share voor verwijdering als deze bestaat. De share en eventuele mappen of bestanden in de share worden later verwijderd tijdens de garbagecollection. Zie https://learn.microsoft.com/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	Retourneert waar als de Azrue-shareresource bestaat die wordt vertegenwoordigd door deze client; anders onwaar. OPMERKING: gebruik deze functie met zorg omdat een bestaande share mogelijk wordt verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe shares worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
generateSasStringToSign(ShareGenerateSasUrlOptions)	Alleen beschikbaar voor ShareClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ShareGenerateSasUrlOptions)	Alleen beschikbaar voor ShareClient die is samengesteld met een gedeelde sleutelreferentie. Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)	Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de invoer van de sleutelinloggegevens van de gebruiker die de sleutel delegeerd. Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)	Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de invoer van de sleutelinloggegevens van de gebruiker die de sleutel delegeerd. Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ShareGetAccessPolicyOptions)	Hiermee haalt u de machtigingen voor de opgegeven share op. De machtigingen geven aan of gegevens openbaar kunnen worden geopend. WAARSCHUWING: JavaScript-datum kan verloren precisie gaan bij het parseren van de begin- en vervaldatumtekenreeks. Nieuwe datum("2018-12-31T03:44:23.8827891Z").toISOString() krijgt bijvoorbeeld '2018-12-31T03:44:23.882Z'. Zie https://learn.microsoft.com/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	Hiermee maakt u een ShareDirectoryClient--object.
getPermission(string, ShareGetPermissionOptions)	Hiermee haalt u de SECURITY Descriptor Definition Language (SDDL) op voor een bepaalde bestandsmachtigingssleutel die een beveiligingsdescriptor aangeeft. Zie https://learn.microsoft.com/rest/api/storageservices/get-permission
getProperties(ShareGetPropertiesOptions)	Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven share. Zie https://learn.microsoft.com/rest/api/storageservices/get-share-properties WAARSCHUWING: het `metadata` object dat in het antwoord wordt geretourneerd, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de `listShares` methode van ShareServiceClient met behulp van de optie `includeMetadata`, waarmee de oorspronkelijke behuizing wordt behouden.
getShareLeaseClient(string)	Haal een ShareLeaseClient- op waarmee leases op het bestand worden beheerd.
getStatistics(ShareGetStatisticsOptions)	Hiermee worden statistieken opgehaald die betrekking hebben op de share.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	Hiermee stelt u de machtigingen voor de opgegeven share in. De machtigingen geven aan of mappen of bestanden in een share openbaar toegankelijk zijn. Wanneer u machtigingen voor een share instelt, worden de bestaande machtigingen vervangen. Als er geen shareAcl is opgegeven, wordt de bestaande share-ACL verwijderd. Wanneer u een opgeslagen toegangsbeleid instelt voor een share, kan het tot 30 seconden duren voordat het van kracht wordt. Tijdens dit interval mislukt een handtekening voor gedeelde toegang die is gekoppeld aan het opgeslagen toegangsbeleid met statuscode 403 (Verboden), totdat het toegangsbeleid actief wordt. Zie https://learn.microsoft.com/rest/api/storageservices/set-share-acl
setMetadata(Metadata, ShareSetMetadataOptions)	Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven share. Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de optieparameter, worden de metagegevens van de share verwijderd. Zie https://learn.microsoft.com/rest/api/storageservices/set-share-metadata
setProperties(ShareSetPropertiesOptions)	Hiermee stelt u eigenschappen van de share in.
setQuota(number, ShareSetQuotaOptions)	Hiermee stelt u het quotum voor de opgegeven share in.
withSnapshot(string)	Hiermee maakt u een nieuw ShareClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen. Geef '' op, verwijdert de momentopname en retourneert een URL naar de basisshare.

Constructordetails

Hiermee maakt u een exemplaar van ShareClient.

new ShareClient(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions)

Parameters

url: string

Een URL-tekenreeks die verwijst naar de Azure Storage-bestandsshare, zoals 'https://myaccount.file.core.windows.net/share". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.file.core.windows.net/share?sasString".

credential: Credential | TokenCredential

Zoals AnonymousCredential of StorageSharedKeyCredential. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options: ShareClientOptions

Optional. Opties voor het configureren van de HTTP-pijplijn.

Hiermee maakt u een exemplaar van ShareClient.

new ShareClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Parameters

url: string

pipeline: Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of geef een aangepaste pijplijn op.

options: ShareClientConfig

new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)

Parameters

connectionString: string

Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount. [ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-verbindingsreeks - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

name: string

Naam delen.

options: ShareClientOptions

Optional. Opties voor het configureren van de HTTP-pijplijn.

Eigenschapdetails

De naam van de share

string name

Waarde van eigenschap

string

Hiermee haalt u de mapclient op voor de hoofdmap van deze share. Houd er rekening mee dat de hoofdmap altijd bestaat en niet kan worden verwijderd.

Een nieuw ShareDirectoryClient-object voor de hoofdmap.

ShareDirectoryClient rootDirectoryClient

Waarde van eigenschap

ShareDirectoryClient

Details van overgenomen eigenschap

accountName: string

Waarde van eigenschap

string

overgenomen van StorageClient.accountName

URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

overgenomen van StorageClient.url

Methodedetails

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

Zie https://learn.microsoft.com/rest/api/storageservices/create-share

function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

Parameters

options: ShareCreateOptions

Opties voor het maken van een sharebewerking.

Retouren

Promise<ShareCreateResponse>

Antwoordgegevens voor de bewerking Delen maken.

Hiermee maakt u een nieuwe submap onder deze share.

Zie https://learn.microsoft.com/rest/api/storageservices/create-directory

function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Parameters

directoryName: string

options: DirectoryCreateOptions

Opties voor het maken van mappen.

Retouren

Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Antwoordgegevens voor het maken van mappen en de bijbehorende directoryclient.

Hiermee maakt u een nieuw bestand of vervangt u een bestand onder de hoofdmap van deze share. Houd er rekening mee dat het bestand alleen wordt geïnitialiseerd zonder inhoud.

Zie https://learn.microsoft.com/rest/api/storageservices/create-file

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Parameters

fileName: string

size: number

Hiermee geeft u de maximale grootte in bytes voor het bestand, maximaal 4 TB.

options: FileCreateOptions

Opties voor het maken van bestanden.

Retouren

Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Antwoordgegevens voor het maken van bestanden en de bijbehorende bestandsclient.

Hiermee maakt u een nieuwe share onder het opgegeven account. Als de share met dezelfde naam al bestaat, wordt deze niet gewijzigd.

Zie https://learn.microsoft.com/rest/api/storageservices/create-share

function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>

Parameters

options: ShareCreateOptions

Retouren

Promise<ShareCreateIfNotExistsResponse>

Hiermee maakt u een bestandsmachtiging (een beveiligingsdescriptor) op shareniveau. De gemaakte beveiligingsdescriptor kan worden gebruikt voor de bestanden/mappen in de share.

Zie https://learn.microsoft.com/rest/api/storageservices/create-permission

function createPermission(filePermission: string | SharePermission, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

Parameters

filePermission: string | SharePermission

Bestandsmachtiging beschreven in de SDDL

options: ShareCreatePermissionOptions

Opties voor het maken van machtigingen delen.

Retouren

Promise<ShareCreatePermissionResponse>

Hiermee maakt u een alleen-lezen momentopname van een share.

function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

Parameters

options: ShareCreateSnapshotOptions

Opties voor het maken van momentopnamen delen.

Retouren

Promise<ShareCreateSnapshotResponse>

Antwoordgegevens voor de bewerking Momentopname maken van Share.

Markeert de opgegeven share voor verwijdering. De share en eventuele mappen of bestanden in de share worden later verwijderd tijdens de garbagecollection.

Zie https://learn.microsoft.com/rest/api/storageservices/delete-share

function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

Parameters

options: ShareDeleteMethodOptions

Opties voor de bewerking Verwijderen delen.

Retouren

Promise<ShareDeleteResponse>

Antwoordgegevens voor de bewerking Delen verwijderen.

Hiermee verwijdert u de opgegeven lege submap onder deze share. Houd er rekening mee dat de map leeg moet zijn voordat deze kan worden verwijderd.

Zie https://learn.microsoft.com/rest/api/storageservices/delete-directory

function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

Parameters

directoryName: string

options: DirectoryDeleteOptions

Opties voor de bewerking Map verwijderen.

Retouren

Promise<DirectoryDeleteResponse>

Antwoordgegevens voor adreslijstverwijdering.

Hiermee verwijdert u een bestand onder de hoofdmap van deze share uit het opslagaccount. Wanneer een bestand is verwijderd, wordt het onmiddellijk verwijderd uit de index van het opslagaccount en is het niet meer toegankelijk voor clients. De gegevens van het bestand worden later uit de service verwijderd tijdens de garbagecollection.

Bestand verwijderen mislukt met statuscode 409 (Conflict) en foutcode SharingViolation als het bestand is geopend op een SMB-client.

Bestand verwijderen wordt niet ondersteund op een momentopname van een share. Dit is een alleen-lezen kopie van een share. Een poging om deze bewerking uit te voeren op een momentopname van een share mislukt met 400 (InvalidQueryParameterValue)

Zie https://learn.microsoft.com/rest/api/storageservices/delete-file2

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

Parameters

fileName: string

options: FileDeleteOptions

Opties voor de bewerking Bestand verwijderen.

Retouren

Promise<FileDeleteResponse>

Beloof<FileDeleteResponse-bestand> Verwijder reactiegegevens.

Markeert de opgegeven share voor verwijdering als deze bestaat. De share en eventuele mappen of bestanden in de share worden later verwijderd tijdens de garbagecollection.

Zie https://learn.microsoft.com/rest/api/storageservices/delete-share

function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>

Parameters

options: ShareDeleteMethodOptions

Retouren

Promise<ShareDeleteIfExistsResponse>

Retourneert waar als de Azrue-shareresource bestaat die wordt vertegenwoordigd door deze client; anders onwaar.

OPMERKING: gebruik deze functie met zorg omdat een bestaande share mogelijk wordt verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe shares worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.

function exists(options?: ShareExistsOptions): Promise<boolean>

Parameters

options: ShareExistsOptions

opties voor bestaat bewerking.

Retouren

Promise<boolean>

Alleen beschikbaar voor ShareClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

Parameters

options: ShareGenerateSasUrlOptions

Optionele parameters.

Retouren

string

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Alleen beschikbaar voor ShareClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parameters

options: ShareGenerateSasUrlOptions

Optionele parameters.

Retouren

string

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de invoer van de sleutelinloggegevens van de gebruiker die de sleutel delegeerd.

Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: ShareGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parameters

options: ShareGenerateSasUrlOptions

Optionele parameters.

userDelegationKey: UserDelegationKey

gebruikersdelegatiesleutel gebruikt om de SAS URI te ondertekenen

Retouren

string

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationStringToSign(options: ShareGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parameters

options: ShareGenerateSasUrlOptions

Optionele parameters.

userDelegationKey: UserDelegationKey

gebruikersdelegatiesleutel gebruikt om de SAS URI te ondertekenen

Retouren

string

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Hiermee haalt u de machtigingen voor de opgegeven share op. De machtigingen geven aan of gegevens openbaar kunnen worden geopend.

WAARSCHUWING: JavaScript-datum kan verloren precisie gaan bij het parseren van de begin- en vervaldatumtekenreeks. Nieuwe datum("2018-12-31T03:44:23.8827891Z").toISOString() krijgt bijvoorbeeld '2018-12-31T03:44:23.882Z'.

Zie https://learn.microsoft.com/rest/api/storageservices/get-share-acl

function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

Parameters

options: ShareGetAccessPolicyOptions

Retouren

Promise<ShareGetAccessPolicyResponse>

Antwoordgegevens voor de bewerking Toegangsbeleid voor Delen ophalen.

Hiermee maakt u een ShareDirectoryClient--object.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parameters

directoryName: string

Een mapnaam

Retouren

ShareDirectoryClient

Het ShareDirectoryClient-object voor de opgegeven mapnaam.

Hiermee haalt u de SECURITY Descriptor Definition Language (SDDL) op voor een bepaalde bestandsmachtigingssleutel die een beveiligingsdescriptor aangeeft.

Zie https://learn.microsoft.com/rest/api/storageservices/get-permission

function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

Parameters

filePermissionKey: string

Sleutel voor bestandsmachtiging die de beveiligingsdescriptor van de machtiging aangeeft.

options: ShareGetPermissionOptions

Opties voor het maken van machtigingen delen.

Retouren

Promise<ShareGetPermissionResponse>

Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven share.

Zie https://learn.microsoft.com/rest/api/storageservices/get-share-properties

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de listShares methode van ShareServiceClient met behulp van de optie includeMetadata, waarmee de oorspronkelijke behuizing wordt behouden.

function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

Parameters

options: ShareGetPropertiesOptions

Retouren

Promise<ShareGetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen delen ophalen.

Haal een ShareLeaseClient- op waarmee leases op het bestand worden beheerd.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parameters

proposeLeaseId: string

Oorspronkelijke voorgestelde lease-id.

Retouren

ShareLeaseClient

Een nieuw ShareLeaseClient-object voor het beheren van leases op het bestand.

Hiermee worden statistieken opgehaald die betrekking hebben op de share.

function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

Parameters

options: ShareGetStatisticsOptions

Retouren

Promise<ShareGetStatisticsResponse>

Antwoordgegevens voor de bewerking Statistieken delen.

Hiermee stelt u de machtigingen voor de opgegeven share in. De machtigingen geven aan of mappen of bestanden in een share openbaar toegankelijk zijn.

Wanneer u machtigingen voor een share instelt, worden de bestaande machtigingen vervangen. Als er geen shareAcl is opgegeven, wordt de bestaande share-ACL verwijderd.

Wanneer u een opgeslagen toegangsbeleid instelt voor een share, kan het tot 30 seconden duren voordat het van kracht wordt. Tijdens dit interval mislukt een handtekening voor gedeelde toegang die is gekoppeld aan het opgeslagen toegangsbeleid met statuscode 403 (Verboden), totdat het toegangsbeleid actief wordt.

Zie https://learn.microsoft.com/rest/api/storageservices/set-share-acl

function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

Parameters

shareAcl: SignedIdentifier[]

Matrix van ondertekende id's, elk met een unieke id en details van toegangsbeleid.

options: ShareSetAccessPolicyOptions

Retouren

Promise<ShareSetAccessPolicyResponse>

Antwoordgegevens voor de bewerking Toegangsbeleid delen instellen.

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor de opgegeven share.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de optieparameter, worden de metagegevens van de share verwijderd.

Zie https://learn.microsoft.com/rest/api/storageservices/set-share-metadata

function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

Parameters

metadata: Metadata

Als er geen metagegevens worden opgegeven, worden alle bestaande mapmetagegevens verwijderd.

options: ShareSetMetadataOptions

Retouren

Promise<ShareSetMetadataResponse>

Antwoordgegevens voor de bewerking Metagegevens delen instellen.

Hiermee stelt u eigenschappen van de share in.

function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>

Parameters

options: ShareSetPropertiesOptions

Retouren

Promise<ShareSetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen van shareset.

Waarschuwing

Deze API is nu afgeschaft.

Use setProperties instead.

Hiermee stelt u het quotum voor de opgegeven share in.

function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

Parameters

quotaInGB: number

Hiermee geeft u de maximale grootte van de share in gigabytes

options: ShareSetQuotaOptions

Retouren

Promise<ShareSetQuotaResponse>

Antwoordgegevens voor de bewerking Quotum ophalen delen.

Hiermee maakt u een nieuw ShareClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen. Geef '' op, verwijdert de momentopname en retourneert een URL naar de basisshare.

function withSnapshot(snapshot: string): ShareClient

Parameters

snapshot: string

De tijdstempel van de momentopname.

Retouren

ShareClient

Een nieuw ShareClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen

Delen via

ShareClient class

Constructors

Eigenschappen

Overgenomen eigenschappen

Methoden

Constructordetails

ShareClient(string, Credential | TokenCredential, ShareClientOptions)

Parameters

ShareClient(string, Pipeline, ShareClientConfig)

Parameters

ShareClient(string, string, ShareClientOptions)

Parameters

Eigenschapdetails

name

Waarde van eigenschap

rootDirectoryClient

Waarde van eigenschap

Details van overgenomen eigenschap

accountName

Waarde van eigenschap

url

Waarde van eigenschap

Methodedetails

create(ShareCreateOptions)

Parameters

Retouren

createDirectory(string, DirectoryCreateOptions)

Parameters

Retouren

createFile(string, number, FileCreateOptions)

Parameters

Retouren

createIfNotExists(ShareCreateOptions)

Parameters

Retouren

createPermission(string | SharePermission, ShareCreatePermissionOptions)

Parameters

Retouren

createSnapshot(ShareCreateSnapshotOptions)

Parameters

Retouren

delete(ShareDeleteMethodOptions)

Parameters

Retouren

deleteDirectory(string, DirectoryDeleteOptions)

Parameters

Retouren

deleteFile(string, FileDeleteOptions)

Parameters

Retouren

deleteIfExists(ShareDeleteMethodOptions)

Parameters

Retouren

exists(ShareExistsOptions)

Parameters

Retouren

generateSasStringToSign(ShareGenerateSasUrlOptions)

Parameters

Retouren

generateSasUrl(ShareGenerateSasUrlOptions)

Parameters

Retouren

generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)

Parameters

Retouren

generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)

Parameters

Retouren

getAccessPolicy(ShareGetAccessPolicyOptions)

Parameters

Retouren

getDirectoryClient(string)

Parameters

Retouren

getPermission(string, ShareGetPermissionOptions)

Parameters

Retouren

getProperties(ShareGetPropertiesOptions)

Parameters