ShareClient class
Een ShareClient vertegenwoordigt een URL naar de Azure Storage-share, zodat u de mappen en bestanden kunt bewerken.
- Uitbreiding
-
StorageClient
Constructors
Share |
Hiermee maakt u een exemplaar van ShareClient. |
Share |
Hiermee maakt u een exemplaar van ShareClient. |
Share |
Eigenschappen
name | De naam van de share |
root |
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
account |
|
url | Waarde van URL-tekenreeks. |
Methoden
create(Share |
Hiermee maakt u een nieuwe share onder het opgegeven account. Als de share met dezelfde naam al bestaat, mislukt de bewerking. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-share |
create |
Hiermee maakt u een nieuwe submap onder deze share. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory |
create |
Hiermee maakt u een nieuw bestand of vervangt u een bestand in de hoofdmap van deze share. Houd er rekening mee dat het bestand alleen wordt geïnitialiseerd zonder inhoud. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-file |
create |
Hiermee maakt u een nieuwe share onder het opgegeven account. Als de share met dezelfde naam al bestaat, wordt deze niet gewijzigd. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-share |
create |
Hiermee maakt u een bestandsmachtiging (een beveiligingsdescriptor) op het niveau van de share. De gemaakte security descriptor kan worden gebruikt voor de bestanden/mappen in de share. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission |
create |
Hiermee maakt u een alleen-lezen momentopname van een share. |
delete(Share |
Hiermee wordt de opgegeven share gemarkeerd voor verwijdering. De share en alle mappen of bestanden die erin zijn opgenomen, worden later verwijderd tijdens de garbagecollection. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share |
delete |
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://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory |
delete |
Hiermee verwijdert u een bestand in 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 verwijderd uit de service tijdens de garbagecollection. Bestand verwijderen mislukt met statuscode 409 (conflict) en foutcode 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 ( Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2 |
delete |
Markeert de opgegeven share voor verwijdering als deze bestaat. De share en eventuele mappen of bestanden die erin zijn opgenomen, worden later verwijderd tijdens de garbagecollection. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share |
exists(Share |
Retourneert true als de Azrue-shareresource die wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie zorgvuldig omdat een bestaande share mogelijk door andere clients of toepassingen wordt verwijderd. Omgekeerd kunnen nieuwe shares worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid. |
generate |
Alleen beschikbaar voor ShareClient die is samengesteld met een gedeelde sleutelreferentie. Genereert 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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Hiermee haalt u de machtigingen voor de opgegeven share op. De machtigingen geven aan of sharegegevens openbaar kunnen worden geopend. WAARSCHUWING: JavaScript-datum kan de precisie verliezen bij het parseren van de begin- en verlooptekenreeks. Nieuwe Date("2018-12-31T03:44:23.8827891Z"). toISOString() krijgt bijvoorbeeld '2018-12-31T03:44:23.882Z'. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl |
get |
Hiermee maakt u een ShareDirectoryClient-object . |
get |
Hiermee haalt u de SDDL (Security Descriptor Definition Language) op voor een bepaalde bestandsmachtigingssleutel die een beveiligingsdescriptor aangeeft. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission |
get |
Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven share. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties WAARSCHUWING: het |
get |
Hiermee haalt u statistieken op met betrekking tot de share. |
set |
Hiermee stelt u de machtigingen voor de opgegeven share. 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 shared access signature die is gekoppeld aan het opgeslagen toegangsbeleid met statuscode 403 (Verboden), totdat het toegangsbeleid actief wordt. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl |
set |
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://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata |
set |
Hiermee stelt u de eigenschappen van de share in. |
set |
Hiermee stelt u het quotum voor de opgegeven share in. |
with |
Hiermee maakt u een nieuw ShareClient-object dat identiek is aan de bron, maar met het opgegeven tijdstempel van de momentopname. Geef de momentopname op en retourneert een URL naar de basisshare. |
Constructordetails
ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)
Hiermee maakt u een exemplaar van ShareClient.
new ShareClient(url: string, credential?: Credential_2 | 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
Zoals AnonymousCredential of StorageSharedKeyCredential. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
- options
- ShareClientOptions
Optioneel. Opties voor het configureren van de HTTP-pijplijn.
ShareClient(string, Pipeline, ShareClientConfig)
Hiermee maakt u een exemplaar van ShareClient.
new ShareClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)
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".
- pipeline
- Pipeline
Roep newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.
- options
- ShareClientConfig
ShareClient(string, string, ShareClientOptions)
new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)
Parameters
- connectionString
-
string
Account connection string of een SAS-connection string van een Azure-opslagaccount.
[ Opmerking: account connection string kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Voorbeeld van SAS-connection string -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 van share.
- options
- ShareClientOptions
Optioneel. Opties voor het configureren van de HTTP-pijplijn.
Eigenschapdetails
name
De naam van de share
string name
Waarde van eigenschap
string
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.
ShareDirectoryClient rootDirectoryClient
Waarde van eigenschap
Details van overgenomen eigenschap
accountName
accountName: string
Waarde van eigenschap
string
Overgenomen van StorageClient.accountName
url
Waarde van URL-tekenreeks.
url: string
Waarde van eigenschap
string
Overgenomen van StorageClient.url
Methodedetails
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://docs.microsoft.com/en-us/rest/api/storageservices/create-share
function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>
Parameters
- options
- ShareCreateOptions
Opties voor de bewerking Share Create.
Retouren
Promise<ShareCreateResponse>
Antwoordgegevens voor de bewerking Share Maken.
createDirectory(string, DirectoryCreateOptions)
Hiermee maakt u een nieuwe submap onder deze share.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>
Parameters
- directoryName
-
string
- options
- DirectoryCreateOptions
Opties voor de bewerking Directory maken.
Retouren
Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>
Antwoordgegevens voor het maken van mappen en de bijbehorende directoryclient.
createFile(string, number, FileCreateOptions)
Hiermee maakt u een nieuw bestand of vervangt u een bestand in de hoofdmap van deze share. Houd er rekening mee dat het bestand alleen wordt geïnitialiseerd zonder inhoud.
Zie https://docs.microsoft.com/en-us/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 op, maximaal 4 TB.
- options
- FileCreateOptions
Opties voor de bewerking Bestand maken.
Retouren
Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>
Antwoordgegevens voor het maken van bestanden en de bijbehorende bestandsclient.
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://docs.microsoft.com/en-us/rest/api/storageservices/create-share
function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>
Parameters
- options
- ShareCreateOptions
Retouren
Promise<ShareCreateIfNotExistsResponse>
createPermission(string, ShareCreatePermissionOptions)
Hiermee maakt u een bestandsmachtiging (een beveiligingsdescriptor) op het niveau van de share. De gemaakte security descriptor kan worden gebruikt voor de bestanden/mappen in de share.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission
function createPermission(filePermission: string, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>
Parameters
- filePermission
-
string
Bestandsmachtiging die wordt beschreven in de SDDL
- options
- ShareCreatePermissionOptions
Opties voor de bewerking Machtiging delen.
Retouren
Promise<ShareCreatePermissionResponse>
createSnapshot(ShareCreateSnapshotOptions)
Hiermee maakt u een alleen-lezen momentopname van een share.
function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>
Parameters
- options
- ShareCreateSnapshotOptions
Opties voor de bewerking Momentopname maken delen.
Retouren
Promise<ShareCreateSnapshotResponse>
Antwoordgegevens voor de bewerking Momentopname delen.
delete(ShareDeleteMethodOptions)
Hiermee wordt de opgegeven share gemarkeerd voor verwijdering. De share en alle mappen of bestanden die erin zijn opgenomen, worden later verwijderd tijdens de garbagecollection.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share
function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>
Parameters
- options
- ShareDeleteMethodOptions
Opties voor de bewerking Delen verwijderen.
Retouren
Promise<ShareDeleteResponse>
Antwoordgegevens voor de bewerking Delen verwijderen.
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://docs.microsoft.com/en-us/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.
deleteFile(string, FileDeleteOptions)
Hiermee verwijdert u een bestand in 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 verwijderd uit de service 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://docs.microsoft.com/en-us/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>
Antwoordgegevens voor het verwijderen van het Promise-bestand.
deleteIfExists(ShareDeleteMethodOptions)
Markeert de opgegeven share voor verwijdering als deze bestaat. De share en eventuele mappen of bestanden die erin zijn opgenomen, worden later verwijderd tijdens de garbagecollection.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share
function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>
Parameters
- options
- ShareDeleteMethodOptions
Retouren
Promise<ShareDeleteIfExistsResponse>
exists(ShareExistsOptions)
Retourneert true als de Azrue-shareresource die wordt vertegenwoordigd door deze client bestaat; anders onwaar.
OPMERKING: gebruik deze functie zorgvuldig omdat een bestaande share mogelijk door andere clients of toepassingen wordt verwijderd. 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 de bewerking Exists.
Retouren
Promise<boolean>
generateSasUrl(ShareGenerateSasUrlOptions)
Alleen beschikbaar voor ShareClient die is samengesteld met een gedeelde sleutelreferentie.
Genereert 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://docs.microsoft.com/en-us/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 naar de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.
getAccessPolicy(ShareGetAccessPolicyOptions)
Hiermee haalt u de machtigingen voor de opgegeven share op. De machtigingen geven aan of sharegegevens openbaar kunnen worden geopend.
WAARSCHUWING: JavaScript-datum kan de precisie verliezen bij het parseren van de begin- en verlooptekenreeks. Nieuwe Date("2018-12-31T03:44:23.8827891Z"). toISOString() krijgt bijvoorbeeld '2018-12-31T03:44:23.882Z'.
Zie https://docs.microsoft.com/en-us/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.
getDirectoryClient(string)
Hiermee maakt u een ShareDirectoryClient-object .
function getDirectoryClient(directoryName: string): ShareDirectoryClient
Parameters
- directoryName
-
string
Een mapnaam
Retouren
Het ShareDirectoryClient-object voor de opgegeven mapnaam.
getPermission(string, ShareGetPermissionOptions)
Hiermee haalt u de SDDL (Security Descriptor Definition Language) op voor een bepaalde bestandsmachtigingssleutel die een beveiligingsdescriptor aangeeft.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission
function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>
Parameters
- filePermissionKey
-
string
Bestandsmachtigingssleutel die de beveiligingsdescriptor van de machtiging aangeeft.
- options
- ShareGetPermissionOptions
Opties voor het delen van de bewerking Machtiging maken.
Retouren
Promise<ShareGetPermissionResponse>
getProperties(ShareGetPropertiesOptions)
Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor de opgegeven share.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties
WAARSCHUWING: het metadata
object dat in het antwoord wordt geretourneerd, heeft 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 includeMetadata
optie, die hun oorspronkelijke hoofdletters behouden.
function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>
Parameters
- options
- ShareGetPropertiesOptions
Retouren
Promise<ShareGetPropertiesResponse>
Antwoordgegevens voor de bewerking Eigenschappen ophalen delen.
getStatistics(ShareGetStatisticsOptions)
Hiermee haalt u statistieken op met betrekking tot de share.
function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>
Parameters
- options
- ShareGetStatisticsOptions
Retouren
Promise<ShareGetStatisticsResponse>
Antwoordgegevens voor de bewerking Statistieken delen.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)
Hiermee stelt u de machtigingen voor de opgegeven share. 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 shared access signature die is gekoppeld aan het opgeslagen toegangsbeleid met statuscode 403 (Verboden), totdat het toegangsbeleid actief wordt.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl
function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>
Parameters
- shareAcl
Matrix met ondertekende id's, elk met een unieke id en details van het toegangsbeleid.
- options
- ShareSetAccessPolicyOptions
Retouren
Promise<ShareSetAccessPolicyResponse>
Antwoordgegevens voor de bewerking Toegangsbeleid delen instellen.
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://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata
function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>
Parameters
- metadata
- Metadata
Als er geen metagegevens zijn opgegeven, worden alle bestaande metagegevens van de map verwijderd.
- options
- ShareSetMetadataOptions
Retouren
Promise<ShareSetMetadataResponse>
Antwoordgegevens voor de bewerking Metagegevens van set delen.
setProperties(ShareSetPropertiesOptions)
Hiermee stelt u de eigenschappen van de share in.
function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>
Parameters
- options
- ShareSetPropertiesOptions
Retouren
Promise<ShareSetPropertiesResponse>
Antwoordgegevens voor de bewerking Eigenschappen van shareset.
setQuota(number, ShareSetQuotaOptions)
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 delen.
withSnapshot(string)
Hiermee maakt u een nieuw ShareClient-object dat identiek is aan de bron, maar met het opgegeven tijdstempel van de momentopname. Geef de momentopname op en retourneert een URL naar de basisshare.
function withSnapshot(snapshot: string): ShareClient
Parameters
- snapshot
-
string
Het tijdstempel van de momentopname.
Retouren
Een nieuw ShareClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel van de momentopname