ShareClient class

Csomag:: @azure/storage-file-share

A ShareClient az Azure Storage-megosztás URL-címét jelöli, amely lehetővé teszi a címtárak és fájlok manipulálását.

Extends: StorageClient

Konstruktorok

ShareClient(string, Credential \| TokenCredential, ShareClientOptions)	Létrehozza a ShareClient egy példányát.
ShareClient(string, Pipeline, ShareClientConfig)	Létrehozza a ShareClient egy példányát.
ShareClient(string, string, ShareClientOptions)

Tulajdonságok

name

A megosztás neve

rootDirectoryClient

Lekéri a megosztás gyökérkönyvtárának címtárügyfélét. Vegye figyelembe, hogy a gyökérkönyvtár mindig létezik, és nem törölhető.

A gyökérkönyvtár új ShareDirectoryClient objektuma.

Örökölt tulajdonságok

accountName
url	URL-sztring értéke.

Metódusok

create(ShareCreateOptions)	Új megosztást hoz létre a megadott fiók alatt. Ha az azonos nevű megosztás már létezik, a művelet meghiúsul. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	Létrehoz egy új alkönyvtárat a megosztás alatt. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	Létrehoz egy új fájlt, vagy lecserél egy fájlt a megosztás gyökérkönyvtára alatt. Vegye figyelembe, hogy csak tartalom nélkül inicializálja a fájlt. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-file
createIfNotExists(ShareCreateOptions)	Új megosztást hoz létre a megadott fiók alatt. Ha az azonos nevű megosztás már létezik, az nem módosul. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-share
createPermission(string \| SharePermission, ShareCreatePermissionOptions)	Fájlengedélyt (biztonsági leírót) hoz létre a megosztás szintjén. A létrehozott biztonsági leíró a megosztásban lévő fájlokhoz/könyvtárakhoz használható. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-permission
createSnapshot(ShareCreateSnapshotOptions)	Egy megosztás írásvédett pillanatképét hozza létre.
delete(ShareDeleteMethodOptions)	Megjelöli a megadott megosztást törlésre. A megosztás és a benne található könyvtárak vagy fájlok később törlődnek a szemétgyűjtés során. Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	Eltávolítja a megosztás alatt megadott üres alkönyvtárat. Vegye figyelembe, hogy a címtárnak üresnek kell lennie ahhoz, hogy törölhető legyen. Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	Eltávolít egy fájlt a megosztás gyökérkönyvtára alatt a tárfiókból. Ha egy fájl sikeresen törölve van, a rendszer azonnal eltávolítja a tárfiók indexéből, és többé nem érhető el az ügyfelek számára. A fájl adatai később törlődnek a szolgáltatásból a szemétgyűjtés során. A fájl törlése sikertelen lesz a 409-ben (ütközés) és `SharingViolation` hibakóddal, ha a fájl SMB-ügyfélen van megnyitva. A fájl törlése nem támogatott megosztási pillanatképek esetén, amely egy megosztás írásvédett másolata. A művelet megosztási pillanatképen való végrehajtásának kísérlete 400(`InvalidQueryParameterValue`) Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	Megjelöli a megadott megosztást törlésre, ha létezik. A megosztás és a benne található könyvtárak vagy fájlok később törlődnek a szemétgyűjtés során. Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	Igaz értéket ad vissza, ha az ügyfél által képviselt Azrue-megosztási erőforrás létezik; máskülönben hamis. MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő megosztást más ügyfelek vagy alkalmazások törölnek. Fordítva, a függvény befejezése után más ügyfelek vagy alkalmazások új megosztásokat adhatnak hozzá.
generateSasStringToSign(ShareGenerateSasUrlOptions)	Csak megosztott kulcsú hitelesítő adatokkal létrehozott ShareClient esetén érhető el. Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ShareGenerateSasUrlOptions)	Csak megosztott kulcsú hitelesítő adatokkal létrehozott ShareClient esetén érhető el. Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ShareGetAccessPolicyOptions)	Lekéri a megadott megosztás engedélyeit. Az engedélyek azt jelzik, hogy a megosztási adatok nyilvánosan elérhetők-e. FIGYELMEZTETÉS: A JavaScript-dátum a kezdő és a lejárati sztring elemzésekor elveszhet a pontossága. Például az új Date("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z". Lásd: https://learn.microsoft.com/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	Létrehoz egy ShareDirectoryClient objektumot.
getPermission(string, ShareGetPermissionOptions)	Lekéri a biztonsági leíró definíciós nyelvét (SDDL) egy adott fájlengedélykulcshoz, amely egy biztonsági leírót jelez. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-permission
getProperties(ShareGetPropertiesOptions)	A megadott megosztás felhasználó által definiált metaadatait és rendszertulajdonságait adja vissza. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-share-properties FIGYELMEZTETÉS: A válaszban visszaadott `metadata` objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a ShareServiceClient `listShares` metódusa által visszaadott metaadatkulcsoktól a `includeMetadata` beállítással, amely megőrzi az eredeti burkolatot.
getShareLeaseClient(string)	Szerezz be egy ShareLeaseClient, amely kezeli a fájl bérleteit.
getStatistics(ShareGetStatisticsOptions)	Lekéri a megosztással kapcsolatos statisztikákat.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	Beállítja a megadott megosztás engedélyeit. Az engedélyek azt jelzik, hogy egy megosztás címtárai vagy fájljai nyilvánosan elérhetők-e. Ha engedélyeket állít be egy megosztáshoz, a rendszer lecseréli a meglévő engedélyeket. Ha nincs megadva shareAcl, a meglévő megosztási ACL el lesz távolítva. Ha egy megosztáson tárolt hozzáférési szabályzatot hoz létre, az akár 30 másodpercig is eltarthat. Ebben az intervallumban a tárolt hozzáférési szabályzathoz társított közös hozzáférésű jogosultságkód a 403-as (Tiltott) állapotkóddal meghiúsul, amíg a hozzáférési szabályzat aktívvá nem válik. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-share-acl
setMetadata(Metadata, ShareSetMetadataOptions)	Beállít egy vagy több felhasználó által definiált név-érték párot a megadott megosztáshoz. Ha nincs megadva lehetőség, vagy a beállításparaméterben nem definiált metaadatok, a megosztási metaadatok el lesznek távolítva. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-share-metadata
setProperties(ShareSetPropertiesOptions)	Beállítja a megosztás tulajdonságait.
setQuota(number, ShareSetQuotaOptions)	A megadott megosztás kvótájának beállítása.
withSnapshot(string)	Létrehoz egy új ShareClient-objektumot, amely megegyezik a forrással, de a megadott pillanatkép-időbélyeggel. A "" megadása eltávolítja a pillanatképet, és egy URL-címet ad vissza az alapmegosztásnak.

Konstruktor adatai

Létrehozza a ShareClient egy példányát.

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

Paraméterek

url: string

Egy Azure Storage-fájlmegosztásra mutató URL-sztring, például "https://myaccount.file.core.windows.net/share". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.file.core.windows.net/share?sasString".

credential: Credential | TokenCredential

Ilyen például a AnonymousCredential vagy a StorageSharedKeyCredential. Ha nincs megadva, az AnonymousCredential lesz használva.

options: ShareClientOptions

Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Létrehozza a ShareClient egy példányát.

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

Paraméterek

url: string

pipeline: Pipeline

A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.

options: ShareClientConfig

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

Paraméterek

connectionString: string

Fiókkapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztringje. [ Megjegyzés – A fiókkapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Példa fiókkapcsolati sztringre – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS kapcsolati sztring példa – 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

Név megosztása

options: ShareClientOptions

Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Tulajdonság adatai

A megosztás neve

string name

Tulajdonság értéke

string

Lekéri a megosztás gyökérkönyvtárának címtárügyfélét. Vegye figyelembe, hogy a gyökérkönyvtár mindig létezik, és nem törölhető.

A gyökérkönyvtár új ShareDirectoryClient objektuma.

ShareDirectoryClient rootDirectoryClient

Tulajdonság értéke

ShareDirectoryClient

Örökölt tulajdonság részletei

accountName: string

Tulajdonság értéke

string

örökölt StorageClient.accountName

URL-sztring értéke.

url: string

Tulajdonság értéke

string

örökölt StorageClient.url-címről

Metódus adatai

Új megosztást hoz létre a megadott fiók alatt. Ha az azonos nevű megosztás már létezik, a művelet meghiúsul.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-share

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

Paraméterek

options: ShareCreateOptions

A létrehozási művelet megosztásának beállításai.

Válaszok

Promise<ShareCreateResponse>

Válaszadatok a Megosztás létrehozása művelethez.

Létrehoz egy új alkönyvtárat a megosztás alatt.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-directory

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

Paraméterek

directoryName: string

options: DirectoryCreateOptions

A címtár-létrehozási művelet beállításai.

Válaszok

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

A címtárlétrehozási válaszadatok és a megfelelő címtárügyfél.

Létrehoz egy új fájlt, vagy lecserél egy fájlt a megosztás gyökérkönyvtára alatt. Vegye figyelembe, hogy csak tartalom nélkül inicializálja a fájlt.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-file

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

Paraméterek

fileName: string

size: number

A fájl maximális méretét adja meg bájtban, legfeljebb 4 TB-ig.

options: FileCreateOptions

A Fájl létrehozása művelet beállításai.

Válaszok

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

Fájllétrehozási válaszadatok és a megfelelő fájlügyfél.

Új megosztást hoz létre a megadott fiók alatt. Ha az azonos nevű megosztás már létezik, az nem módosul.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-share

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

Paraméterek

options: ShareCreateOptions

Válaszok

Promise<ShareCreateIfNotExistsResponse>

Fájlengedélyt (biztonsági leírót) hoz létre a megosztás szintjén. A létrehozott biztonsági leíró a megosztásban lévő fájlokhoz/könyvtárakhoz használható.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-permission

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

Paraméterek

filePermission: string | SharePermission

Az SDDL-ben leírt fájlengedély

options: ShareCreatePermissionOptions

A Létrehozási engedély művelet megosztásának beállításai.

Válaszok

Promise<ShareCreatePermissionResponse>

Egy megosztás írásvédett pillanatképét hozza létre.

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

Paraméterek

options: ShareCreateSnapshotOptions

A Pillanatkép létrehozása művelet megosztásának lehetőségei.

Válaszok

Promise<ShareCreateSnapshotResponse>

A Pillanatkép létrehozása művelet válaszadatai.

Megjelöli a megadott megosztást törlésre. A megosztás és a benne található könyvtárak vagy fájlok később törlődnek a szemétgyűjtés során.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-share

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

Paraméterek

options: ShareDeleteMethodOptions

A Törlési művelet megosztásának beállításai.

Válaszok

Promise<ShareDeleteResponse>

Válaszadatok a Megosztás törlése művelethez.

Eltávolítja a megosztás alatt megadott üres alkönyvtárat. Vegye figyelembe, hogy a címtárnak üresnek kell lennie ahhoz, hogy törölhető legyen.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-directory

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

Paraméterek

directoryName: string

options: DirectoryDeleteOptions

A címtártörlési művelet beállításai.

Válaszok

Promise<DirectoryDeleteResponse>

Címtártörlési válaszadatok.

Eltávolít egy fájlt a megosztás gyökérkönyvtára alatt a tárfiókból. Ha egy fájl sikeresen törölve van, a rendszer azonnal eltávolítja a tárfiók indexéből, és többé nem érhető el az ügyfelek számára. A fájl adatai később törlődnek a szolgáltatásból a szemétgyűjtés során.

A fájl törlése sikertelen lesz a 409-ben (ütközés) és SharingViolation hibakóddal, ha a fájl SMB-ügyfélen van megnyitva.

A fájl törlése nem támogatott megosztási pillanatképek esetén, amely egy megosztás írásvédett másolata. A művelet megosztási pillanatképen való végrehajtásának kísérlete 400(InvalidQueryParameterValue)

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-file2

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

Paraméterek

fileName: string

options: FileDeleteOptions

Fájltörlési művelet beállításai.

Válaszok

Promise<FileDeleteResponse>

Promise<FileDeleteResponse> File Válaszadatok törlése.

Megjelöli a megadott megosztást törlésre, ha létezik. A megosztás és a benne található könyvtárak vagy fájlok később törlődnek a szemétgyűjtés során.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-share

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

Paraméterek

options: ShareDeleteMethodOptions

Válaszok

Promise<ShareDeleteIfExistsResponse>

Igaz értéket ad vissza, ha az ügyfél által képviselt Azrue-megosztási erőforrás létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő megosztást más ügyfelek vagy alkalmazások törölnek. Fordítva, a függvény befejezése után más ügyfelek vagy alkalmazások új megosztásokat adhatnak hozzá.

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

Paraméterek

options: ShareExistsOptions

beállítási lehetőségeket a Exists művelethez.

Válaszok

Promise<boolean>

Csak megosztott kulcsú hitelesítő adatokkal létrehozott ShareClient esetén érhető el.

Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

Paraméterek

options: ShareGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

Csak megosztott kulcsú hitelesítő adatokkal létrehozott ShareClient esetén érhető el.

Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Paraméterek

options: ShareGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

Lekéri a megadott megosztás engedélyeit. Az engedélyek azt jelzik, hogy a megosztási adatok nyilvánosan elérhetők-e.

FIGYELMEZTETÉS: A JavaScript-dátum a kezdő és a lejárati sztring elemzésekor elveszhet a pontossága. Például az új Date("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z".

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-share-acl

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

Paraméterek

options: ShareGetAccessPolicyOptions

Válaszok

Promise<ShareGetAccessPolicyResponse>

Válaszadatok a Hozzáférési szabályzat lekérése művelethez.

Létrehoz egy ShareDirectoryClient objektumot.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Paraméterek

directoryName: string

Könyvtárnév

Válaszok

ShareDirectoryClient

A megadott könyvtárnév ShareDirectoryClient objektuma.

Lekéri a biztonsági leíró definíciós nyelvét (SDDL) egy adott fájlengedélykulcshoz, amely egy biztonsági leírót jelez.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-permission

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

Paraméterek

filePermissionKey: string

Fájlengedélykulcs, amely az engedély biztonsági leíróját jelzi.

options: ShareGetPermissionOptions

A Létrehozási engedély művelet megosztásának beállításai.

Válaszok

Promise<ShareGetPermissionResponse>

A megadott megosztás felhasználó által definiált metaadatait és rendszertulajdonságait adja vissza.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-share-properties

FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a ShareServiceClient listShares metódusa által visszaadott metaadatkulcsoktól a includeMetadata beállítással, amely megőrzi az eredeti burkolatot.

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

Paraméterek

options: ShareGetPropertiesOptions

Válaszok

Promise<ShareGetPropertiesResponse>

A Tulajdonságok megosztása művelet válaszadatai.

Szerezz be egy ShareLeaseClient, amely kezeli a fájl bérleteit.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Paraméterek

proposeLeaseId: string

Kezdeti javasolt bérletazonosító.

Válaszok

ShareLeaseClient

Új ShareLeaseClient-objektum a fájl bérleteinek kezeléséhez.

Lekéri a megosztással kapcsolatos statisztikákat.

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

Paraméterek

options: ShareGetStatisticsOptions

Válaszok

Promise<ShareGetStatisticsResponse>

A Share Get Statistics művelet válaszadatai.

Beállítja a megadott megosztás engedélyeit. Az engedélyek azt jelzik, hogy egy megosztás címtárai vagy fájljai nyilvánosan elérhetők-e.

Ha engedélyeket állít be egy megosztáshoz, a rendszer lecseréli a meglévő engedélyeket. Ha nincs megadva shareAcl, a meglévő megosztási ACL el lesz távolítva.

Ha egy megosztáson tárolt hozzáférési szabályzatot hoz létre, az akár 30 másodpercig is eltarthat. Ebben az intervallumban a tárolt hozzáférési szabályzathoz társított közös hozzáférésű jogosultságkód a 403-as (Tiltott) állapotkóddal meghiúsul, amíg a hozzáférési szabályzat aktívvá nem válik.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-share-acl

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

Paraméterek

shareAcl: SignedIdentifier[]

Aláírt azonosítók tömbje, amelyek mindegyike egyedi azonosítóval és a hozzáférési szabályzat részleteivel rendelkezik.

options: ShareSetAccessPolicyOptions

Válaszok

Promise<ShareSetAccessPolicyResponse>

Válaszadatok a Share Set Access Policy művelethez.

Beállít egy vagy több felhasználó által definiált név-érték párot a megadott megosztáshoz.

Ha nincs megadva lehetőség, vagy a beállításparaméterben nem definiált metaadatok, a megosztási metaadatok el lesznek távolítva.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-share-metadata

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

Paraméterek

metadata: Metadata

Ha nem ad meg metaadatokat, az összes meglévő címtár-metaadat el lesz távolítva.

options: ShareSetMetadataOptions

Válaszok

Promise<ShareSetMetadataResponse>

Válaszadatok a Metaadatok megosztása művelethez.

Beállítja a megosztás tulajdonságait.

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

Paraméterek

options: ShareSetPropertiesOptions

Válaszok

Promise<ShareSetPropertiesResponse>

Válaszadatok a Megosztáskészlet tulajdonságai művelethez.

Figyelmeztetés

Ez az API már elavult.

Use setProperties instead.

A megadott megosztás kvótájának beállítása.

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

Paraméterek

quotaInGB: number

A megosztás maximális méretét adja meg gigabájtban

options: ShareSetQuotaOptions

Válaszok

Promise<ShareSetQuotaResponse>

A Kvóta lekérése művelet válaszadatai.

Létrehoz egy új ShareClient-objektumot, amely megegyezik a forrással, de a megadott pillanatkép-időbélyeggel. A "" megadása eltávolítja a pillanatképet, és egy URL-címet ad vissza az alapmegosztásnak.

function withSnapshot(snapshot: string): ShareClient

Paraméterek

snapshot: string

A pillanatkép időbélyege.

Válaszok

ShareClient

Egy új ShareClient-objektum, amely megegyezik a forrással, de a megadott pillanatkép-időbélyeggel

Megosztás a következőn keresztül:

ShareClient class

Konstruktorok

Tulajdonságok

Örökölt tulajdonságok

Metódusok

Konstruktor adatai

ShareClient(string, Credential | TokenCredential, ShareClientOptions)

Paraméterek

ShareClient(string, Pipeline, ShareClientConfig)

Paraméterek

ShareClient(string, string, ShareClientOptions)

Paraméterek

Tulajdonság adatai

name

Tulajdonság értéke

rootDirectoryClient

Tulajdonság értéke

Örökölt tulajdonság részletei

accountName

Tulajdonság értéke

url

Tulajdonság értéke

Metódus adatai

create(ShareCreateOptions)

Paraméterek

Válaszok

createDirectory(string, DirectoryCreateOptions)

Paraméterek

Válaszok

createFile(string, number, FileCreateOptions)

Paraméterek

Válaszok

createIfNotExists(ShareCreateOptions)

Paraméterek

Válaszok

createPermission(string | SharePermission, ShareCreatePermissionOptions)

Paraméterek

Válaszok

createSnapshot(ShareCreateSnapshotOptions)

Paraméterek

Válaszok

delete(ShareDeleteMethodOptions)

Paraméterek

Válaszok

deleteDirectory(string, DirectoryDeleteOptions)

Paraméterek

Válaszok

deleteFile(string, FileDeleteOptions)

Paraméterek

Válaszok

deleteIfExists(ShareDeleteMethodOptions)

Paraméterek

Válaszok

exists(ShareExistsOptions)

Paraméterek

Válaszok

generateSasStringToSign(ShareGenerateSasUrlOptions)

Paraméterek

Válaszok

generateSasUrl(ShareGenerateSasUrlOptions)

Paraméterek

Válaszok

getAccessPolicy(ShareGetAccessPolicyOptions)

Paraméterek

Válaszok

getDirectoryClient(string)

Paraméterek

Válaszok

getPermission(string, ShareGetPermissionOptions)

Paraméterek

Válaszok

getProperties(ShareGetPropertiesOptions)

Paraméterek

Válaszok

getShareLeaseClient(string)

Paraméterek

Válaszok

getStatistics(ShareGetStatisticsOptions)

Paraméterek