ShareClient class

Referens

Paket:: @azure/storage-file-share

En ShareClient representerar en URL till Azure Storage-resursen så att du kan ändra dess kataloger och filer.

Extends: StorageClient

Konstruktorer

ShareClient(string, Credential_2 \| TokenCredential, ShareClientOptions)	Skapar en instans av ShareClient.
ShareClient(string, Pipeline, ShareClientConfig)	Skapar en instans av ShareClient.
ShareClient(string, string, ShareClientOptions)

Egenskaper

name

Resursens namn

rootDirectoryClient

Hämtar katalogklienten för resursens rotkatalog. Observera att rotkatalogen alltid finns och inte kan tas bort.

Ett nytt ShareDirectoryClient-objekt för rotkatalogen.

Ärvda egenskaper

accountName
url	URL-strängvärde.

Metoder

create(ShareCreateOptions)	Skapar en ny resurs under det angivna kontot. Om resursen med samma namn redan finns misslyckas åtgärden. Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	Skapar en ny underkatalog under den här resursen. Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	Skapar en ny fil eller ersätter en fil under resursens rotkatalog. Observera att den endast initierar filen utan innehåll. Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-file
createIfNotExists(ShareCreateOptions)	Skapar en ny resurs under det angivna kontot. Om resursen med samma namn redan finns ändras den inte. Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
createPermission(string, ShareCreatePermissionOptions)	Skapar en filbehörighet (en säkerhetsbeskrivning) på resursnivå. Den skapade säkerhetsbeskrivningen kan användas för filerna/katalogerna i resursen. Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission
createSnapshot(ShareCreateSnapshotOptions)	Skapar en skrivskyddad ögonblicksbild av en resurs.
delete(ShareDeleteMethodOptions)	Markerar den angivna resursen för borttagning. Resursen och eventuella kataloger eller filer som finns i den tas senare bort under skräpinsamlingen. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	Tar bort den angivna tomma underkatalogen under den här resursen. Observera att katalogen måste vara tom innan den kan tas bort. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	Tar bort en fil under rotkatalogen för den här resursen från lagringskontot. När en fil har tagits bort tas den omedelbart bort från lagringskontots index och är inte längre tillgänglig för klienter. Filens data tas senare bort från tjänsten under skräpinsamlingen. Ta bort fil misslyckas med statuskod 409 (konflikt) och felkod `SharingViolation` om filen är öppen på en SMB-klient. Ta bort fil stöds inte på en resursögonblicksbild, vilket är en skrivskyddad kopia av en resurs. Ett försök att utföra den här åtgärden på en resursögonblicksbild misslyckas med 400 (`InvalidQueryParameterValue`) Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	Markerar den angivna resursen för borttagning om den finns. Resursen och eventuella kataloger eller filer som finns i den tas senare bort under skräpinsamlingen. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	Returnerar sant om Azrue-resursen som representeras av den här klienten finns. annars falskt. Obs! Använd den här funktionen med försiktighet eftersom en befintlig resurs kan tas bort av andra klienter eller program. Vice versa nya resurser kan läggas till av andra klienter eller program när den här funktionen har slutförts.
generateSasUrl(ShareGenerateSasUrlOptions)	Endast tillgängligt för ShareClient som skapats med autentiseringsuppgifter för delad nyckel. Genererar en SAS-URI (Service Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ShareGetAccessPolicyOptions)	Hämtar behörigheterna för den angivna resursen. Behörigheterna anger om delningsdata kan kommas åt offentligt. VARNING! JavaScript-datum kan förlora precision vid parsning av start- och utgångssträng. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z". Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	Skapar ett ShareDirectoryClient-objekt .
getPermission(string, ShareGetPermissionOptions)	Hämtar SDDL (Security Descriptor Definition Language) för en viss filbehörighetsnyckel som anger en säkerhetsbeskrivning. Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission
getProperties(ShareGetPropertiesOptions)	Returnerar alla användardefinierade metadata och systemegenskaper för den angivna resursen. Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties VARNING! Objektet `metadata` som returnerades i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av `listShares` metoden ShareServiceClient med hjälp `includeMetadata` av alternativet , som behåller sitt ursprungliga hölje.
getStatistics(ShareGetStatisticsOptions)	Hämtar statistik relaterad till resursen.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	Anger behörigheterna för den angivna resursen. Behörigheterna anger om kataloger eller filer i en resurs kan kommas åt offentligt. När du anger behörigheter för en resurs ersätts de befintliga behörigheterna. Om ingen shareAcl har angetts tas den befintliga resurs-ACL:en bort. När du upprättar en lagrad åtkomstprincip på en resurs kan det ta upp till 30 sekunder innan den börjar gälla. Under det här intervallet misslyckas en signatur för delad åtkomst som är associerad med den lagrade åtkomstprincipen med statuskod 403 (Förbjuden) tills åtkomstprincipen blir aktiv. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl
setMetadata(Metadata, ShareSetMetadataOptions)	Anger ett eller flera användardefinierade namn/värde-par för den angivna resursen. Om inget alternativ har angetts eller inga metadata definierats i alternativparametern tas resursmetadata bort. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata
setProperties(ShareSetPropertiesOptions)	Anger resursens egenskaper.
setQuota(number, ShareSetQuotaOptions)	Anger kvoten för den angivna resursen.
withSnapshot(string)	Skapar ett nytt ShareClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilden. Ange "" tar bort ögonblicksbilden och returnerar en URL till basresursen.

Konstruktorinformation

Skapar en instans av ShareClient.

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

Parametrar

url: string

En URL-sträng som pekar på Azure Storage-filresursen, till exempel "https://myaccount.file.core.windows.net/share". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.file.core.windows.net/share?sasString".

credential: Credential | TokenCredential

Till exempel AnonymousCredential eller StorageSharedKeyCredential. Om inget anges används AnonymousCredential.

options: ShareClientOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

Skapar en instans av ShareClient.

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

Parametrar

url: string

pipeline: Pipeline

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

options: ShareClientConfig

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

Parametrar

connectionString: string

Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto. [ Obs! – Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net EXEMPEL på SAS-anslutningssträng – 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

Resursnamn.

options: ShareClientOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

Egenskapsinformation

Resursens namn

string name

Egenskapsvärde

string

Hämtar katalogklienten för resursens rotkatalog. Observera att rotkatalogen alltid finns och inte kan tas bort.

Ett nytt ShareDirectoryClient-objekt för rotkatalogen.

ShareDirectoryClient rootDirectoryClient

Egenskapsvärde

ShareDirectoryClient

Information om ärvda egenskaper

accountName: string

Egenskapsvärde

string

Ärvd från StorageClient.accountName

URL-strängvärde.

url: string

Egenskapsvärde

string

Ärvd från StorageClient.url

Metodinformation

Skapar en ny resurs under det angivna kontot. Om resursen med samma namn redan finns misslyckas åtgärden.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-share

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

Parametrar

options: ShareCreateOptions

Alternativ för att dela åtgärden Skapa.

Returer

Promise<ShareCreateResponse>

Svarsdata för åtgärden Dela skapa.

Skapar en ny underkatalog under den här resursen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory

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

Parametrar

directoryName: string

options: DirectoryCreateOptions

Alternativ för åtgärden Skapa katalog.

Returer

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

Svarsdata för skapande av katalog och motsvarande katalogklient.

Skapar en ny fil eller ersätter en fil under resursens rotkatalog. Observera att den endast initierar filen utan innehåll.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-file

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

Parametrar

fileName: string

size: number

Anger den maximala storleken i byte för filen, upp till 4 TB.

options: FileCreateOptions

Alternativ för åtgärden Skapa fil.

Returer

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

Svarsdata för att skapa filer och motsvarande filklient.

Skapar en ny resurs under det angivna kontot. Om resursen med samma namn redan finns ändras den inte.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-share

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

Parametrar

options: ShareCreateOptions

Returer

Promise<ShareCreateIfNotExistsResponse>

Skapar en filbehörighet (en säkerhetsbeskrivning) på resursnivå. Den skapade säkerhetsbeskrivningen kan användas för filerna/katalogerna i resursen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission

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

Parametrar

filePermission: string

Filbehörighet som beskrivs i SDDL

options: ShareCreatePermissionOptions

Alternativ för att dela åtgärden Skapa behörighet.

Returer

Promise<ShareCreatePermissionResponse>

Skapar en skrivskyddad ögonblicksbild av en resurs.

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

Parametrar

options: ShareCreateSnapshotOptions

Alternativ för att dela åtgärden Skapa ögonblicksbild.

Returer

Promise<ShareCreateSnapshotResponse>

Svarsdata för åtgärden Skapa ögonblicksbild av resurs.

Markerar den angivna resursen för borttagning. Resursen och eventuella kataloger eller filer som finns i den tas senare bort under skräpinsamlingen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share

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

Parametrar

options: ShareDeleteMethodOptions

Alternativ för att dela borttagningsåtgärden.

Returer

Promise<ShareDeleteResponse>

Svarsdata för åtgärden Dela borttagning.

Tar bort den angivna tomma underkatalogen under den här resursen. Observera att katalogen måste vara tom innan den kan tas bort.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory

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

Parametrar

directoryName: string

options: DirectoryDeleteOptions

Alternativ för åtgärden Ta bort katalog.

Returer

Promise<DirectoryDeleteResponse>

Svarsdata för katalogborttagning.

Tar bort en fil under rotkatalogen för den här resursen från lagringskontot. När en fil har tagits bort tas den omedelbart bort från lagringskontots index och är inte längre tillgänglig för klienter. Filens data tas senare bort från tjänsten under skräpinsamlingen.

Ta bort fil misslyckas med statuskod 409 (konflikt) och felkod SharingViolation om filen är öppen på en SMB-klient.

Ta bort fil stöds inte på en resursögonblicksbild, vilket är en skrivskyddad kopia av en resurs. Ett försök att utföra den här åtgärden på en resursögonblicksbild misslyckas med 400 (InvalidQueryParameterValue)

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

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

Parametrar

fileName: string

options: FileDeleteOptions

Alternativ för åtgärden Filborttagning.

Returer

Promise<FileDeleteResponse>

Promise File Delete-svarsdata.

Markerar den angivna resursen för borttagning om den finns. Resursen och eventuella kataloger eller filer som finns i den tas senare bort under skräpinsamlingen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share

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

Parametrar

options: ShareDeleteMethodOptions

Returer

Promise<ShareDeleteIfExistsResponse>

Returnerar sant om Azrue-resursen som representeras av den här klienten finns. annars falskt.

Obs! Använd den här funktionen med försiktighet eftersom en befintlig resurs kan tas bort av andra klienter eller program. Vice versa nya resurser kan läggas till av andra klienter eller program när den här funktionen har slutförts.

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

Parametrar

options: ShareExistsOptions

alternativ för åtgärden Finns.

Returer

Promise<boolean>

Endast tillgängligt för ShareClient som skapats med autentiseringsuppgifter för delad nyckel.

Genererar en SAS-URI (Service Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parametrar

options: ShareGenerateSasUrlOptions

Valfria parametrar.

Returer

string

SAS-URI:n som består av URI:n till resursen som representeras av den här klienten, följt av den genererade SAS-token.

Hämtar behörigheterna för den angivna resursen. Behörigheterna anger om delningsdata kan kommas åt offentligt.

VARNING! JavaScript-datum kan förlora precision vid parsning av start- och utgångssträng. Till exempel får nya Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl

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

Parametrar

options: ShareGetAccessPolicyOptions

Returer

Promise<ShareGetAccessPolicyResponse>

Svarsdata för åtgärden Dela hämta åtkomstprincip.

Skapar ett ShareDirectoryClient-objekt .

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parametrar

directoryName: string

Ett katalognamn

Returer

ShareDirectoryClient

ShareDirectoryClient-objektet för det angivna katalognamnet.

Hämtar SDDL (Security Descriptor Definition Language) för en viss filbehörighetsnyckel som anger en säkerhetsbeskrivning.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission

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

Parametrar

filePermissionKey: string

Filbehörighetsnyckel som anger behörighetens säkerhetsbeskrivning.

options: ShareGetPermissionOptions

Alternativ för att dela åtgärden Skapa behörighet.

Returer

Promise<ShareGetPermissionResponse>

Returnerar alla användardefinierade metadata och systemegenskaper för den angivna resursen.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties

VARNING! Objektet metadata som returnerades i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av listShares metoden ShareServiceClient med hjälp includeMetadata av alternativet , som behåller sitt ursprungliga hölje.

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

Parametrar

options: ShareGetPropertiesOptions

Returer

Promise<ShareGetPropertiesResponse>

Svarsdata för åtgärden Dela hämta egenskaper.

Hämtar statistik relaterad till resursen.

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

Parametrar

options: ShareGetStatisticsOptions

Returer

Promise<ShareGetStatisticsResponse>

Svarsdata för åtgärden Dela hämta statistik.

Anger behörigheterna för den angivna resursen. Behörigheterna anger om kataloger eller filer i en resurs kan kommas åt offentligt.

När du anger behörigheter för en resurs ersätts de befintliga behörigheterna. Om ingen shareAcl har angetts tas den befintliga resurs-ACL:en bort.

När du upprättar en lagrad åtkomstprincip på en resurs kan det ta upp till 30 sekunder innan den börjar gälla. Under det här intervallet misslyckas en signatur för delad åtkomst som är associerad med den lagrade åtkomstprincipen med statuskod 403 (Förbjuden) tills åtkomstprincipen blir aktiv.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl

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

Parametrar

shareAcl: SignedIdentifier[]

Matris med signerade identifierare, var och en har ett unikt ID och information om åtkomstprincip.

options: ShareSetAccessPolicyOptions

Returer

Promise<ShareSetAccessPolicyResponse>

Svarsdata för åtgärden Resursuppsättningsåtkomstprincip.

Anger ett eller flera användardefinierade namn/värde-par för den angivna resursen.

Om inget alternativ har angetts eller inga metadata definierats i alternativparametern tas resursmetadata bort.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata

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

Parametrar

metadata: Metadata

Om inga metadata anges tas alla befintliga katalogmetadata bort.

options: ShareSetMetadataOptions

Returer

Promise<ShareSetMetadataResponse>

Svarsdata för åtgärden Resursuppsättningsmetadata.

Anger resursens egenskaper.

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

Parametrar

options: ShareSetPropertiesOptions

Returer

Promise<ShareSetPropertiesResponse>

Svarsdata för åtgärden Egenskaper för resursuppsättning.

Varning

Det här API:et är nu inaktuellt.

Use setProperties instead.

Anger kvoten för den angivna resursen.

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

Parametrar

quotaInGB: number

Anger den maximala storleken på resursen i gigabyte

options: ShareSetQuotaOptions

Returer

Promise<ShareSetQuotaResponse>

Svarsdata för åtgärden Dela hämta kvot.

Skapar ett nytt ShareClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilden. Ange "" tar bort ögonblicksbilden och returnerar en URL till basresursen.

function withSnapshot(snapshot: string): ShareClient

Parametrar

snapshot: string

Tidsstämpeln för ögonblicksbilden.

Returer

ShareClient

Ett nytt ShareClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för ögonblicksbilden

Dela via

ShareClient class

Konstruktorer

Egenskaper

Ärvda egenskaper

Metoder

Konstruktorinformation

ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Parametrar

ShareClient(string, Pipeline, ShareClientConfig)

Parametrar

ShareClient(string, string, ShareClientOptions)

Parametrar

Egenskapsinformation

name

Egenskapsvärde

rootDirectoryClient

Egenskapsvärde

Information om ärvda egenskaper

accountName

Egenskapsvärde

url

Egenskapsvärde

Metodinformation

create(ShareCreateOptions)

Parametrar

Returer

createDirectory(string, DirectoryCreateOptions)

Parametrar

Returer

createFile(string, number, FileCreateOptions)

Parametrar

Returer

createIfNotExists(ShareCreateOptions)

Parametrar

Returer

createPermission(string, ShareCreatePermissionOptions)

Parametrar

Returer

createSnapshot(ShareCreateSnapshotOptions)

Parametrar

Returer

delete(ShareDeleteMethodOptions)

Parametrar

Returer

deleteDirectory(string, DirectoryDeleteOptions)

Parametrar

Returer

deleteFile(string, FileDeleteOptions)

Parametrar

Returer

deleteIfExists(ShareDeleteMethodOptions)

Parametrar

Returer

exists(ShareExistsOptions)

Parametrar

Returer

generateSasUrl(ShareGenerateSasUrlOptions)

Parametrar

Returer

getAccessPolicy(ShareGetAccessPolicyOptions)

Parametrar

Returer

getDirectoryClient(string)

Parametrar

Returer

getPermission(string, ShareGetPermissionOptions)

Parametrar

Returer

getProperties(ShareGetPropertiesOptions)

Parametrar

Returer

getStatistics(ShareGetStatisticsOptions)

Parametrar

Returer

setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)

Parametrar

Returer

setMetadata(Metadata, ShareSetMetadataOptions)

Parametrar