ShareClient class

Balíček:: @azure/storage-file-share

ShareClient představuje adresu URL sdílené složky Azure Storage, která umožňuje manipulovat s jeho adresáři a soubory.

Extends: StorageClient

Konstruktory

ShareClient(string, Credential \| TokenCredential, ShareClientOptions)	Vytvoří instanci ShareClient.
ShareClient(string, Pipeline, ShareClientConfig)	Vytvoří instanci ShareClient.
ShareClient(string, string, ShareClientOptions)

Vlastnosti

name

Název sdílené složky

rootDirectoryClient

Získá klienta adresáře pro kořenový adresář této sdílené složky. Všimněte si, že kořenový adresář vždy existuje a nelze ho odstranit.

Nový objekt ShareDirectoryClient pro kořenový adresář.

Zděděné vlastnosti

accountName
url	Hodnota řetězce adresy URL.

Metody

create(ShareCreateOptions)	Vytvoří novou sdílenou složku pod zadaným účtem. Pokud sdílená složka se stejným názvem již existuje, operace selže. Viz https://learn.microsoft.com/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	Vytvoří pod touto sdílenou složkou nový podadresář. Viz https://learn.microsoft.com/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	Vytvoří nový soubor nebo nahradí soubor v kořenovém adresáři této sdílené složky. Všimněte si, že inicializuje pouze soubor bez obsahu. Viz https://learn.microsoft.com/rest/api/storageservices/create-file
createIfNotExists(ShareCreateOptions)	Vytvoří novou sdílenou složku pod zadaným účtem. Pokud sdílená složka se stejným názvem již existuje, nezmění se. Viz https://learn.microsoft.com/rest/api/storageservices/create-share
createPermission(string \| SharePermission, ShareCreatePermissionOptions)	Vytvoří oprávnění k souboru (popisovač zabezpečení) na úrovni sdílené složky. Vytvořený popisovač zabezpečení lze použít pro soubory nebo adresáře ve sdílené složce. Viz https://learn.microsoft.com/rest/api/storageservices/create-permission
createSnapshot(ShareCreateSnapshotOptions)	Vytvoří snímek sdílené složky jen pro čtení.
delete(ShareDeleteMethodOptions)	Označí zadanou sdílenou složku pro odstranění. Sdílená složka a všechny adresáře nebo soubory obsažené v ní se později během uvolňování paměti odstraní. Viz https://learn.microsoft.com/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	Odebere zadaný prázdný podadresáři v této sdílené složce. Před odstraněním adresáře musí být adresář prázdný. Viz https://learn.microsoft.com/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	Odebere soubor v kořenovém adresáři této sdílené složky z účtu úložiště. Když se soubor úspěšně odstraní, okamžitě se odebere z indexu účtu úložiště a už není přístupný pro klienty. Data souboru se později ze služby během uvolňování paměti odeberou. Odstranění souboru selže se stavovým kódem 409 (Konflikt) a kód chyby `SharingViolation`, pokud je soubor otevřený v klientovi SMB. Odstranění souboru není podporováno na snímku sdílené složky, což je kopie sdílené složky jen pro čtení. Pokus o provedení této operace na snímku sdílené složky selže se 400 (`InvalidQueryParameterValue`) Viz https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	Označí zadanou sdílenou složku pro odstranění, pokud existuje. Sdílená složka a všechny adresáře nebo soubory obsažené v ní se později během uvolňování paměti odstraní. Viz https://learn.microsoft.com/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	Vrátí hodnotu true, pokud existuje prostředek sdílené složky Azrue reprezentovaný tímto klientem; jinak nepravda. POZNÁMKA: Tuto funkci používejte opatrně, protože existující sdílená složka může být odstraněna jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové sdílené složky přidány jinými klienty nebo aplikacemi.
generateSasStringToSign(ShareGenerateSasUrlOptions)	K dispozici pouze pro ShareClient vytvořené s přihlašovacími údaji sdíleného klíče. Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta. Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ShareGenerateSasUrlOptions)	K dispozici pouze pro ShareClient vytvořené s přihlašovacími údaji sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta. Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ShareGetAccessPolicyOptions)	Získá oprávnění pro zadanou sdílenou složku. Oprávnění označují, jestli se ke sdíleným datům může přistupovat veřejně. UPOZORNĚNÍ: Datum JavaScriptu může při analýze řetězce zahájení a konce platnosti dojít ke ztrátě přesnosti. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z". Viz https://learn.microsoft.com/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	Vytvoří objekt ShareDirectoryClient.
getPermission(string, ShareGetPermissionOptions)	Získá jazyk SDDL (Security Descriptor Definition Language) pro daný klíč oprávnění souboru, který označuje popisovač zabezpečení. Viz https://learn.microsoft.com/rest/api/storageservices/get-permission
getProperties(ShareGetPropertiesOptions)	Vrátí všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadanou sdílenou složku. Viz https://learn.microsoft.com/rest/api/storageservices/get-share-properties UPOZORNĚNÍ: Objekt `metadata` vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodou `listShares`ShareServiceClient pomocí možnosti `includeMetadata`, která zachová původní velikost skříně.
getShareLeaseClient(string)	Získejte ShareLeaseClient, který spravuje zapůjčení souboru.
getStatistics(ShareGetStatisticsOptions)	Načte statistiky související se sdílenou složkou.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	Nastaví oprávnění pro zadanou sdílenou složku. Oprávnění označují, jestli se k adresářům nebo souborům ve sdílené složce můžou přistupovat veřejně. Když nastavíte oprávnění pro sdílenou složku, nahradí se stávající oprávnění. Pokud není k dispozici žádný seznam ShareAcl, odebere se stávající seznam ACL sdílené složky. Když vytvoříte uložené zásady přístupu ve sdílené složce, může trvat až 30 sekund, než se projeví. Během tohoto intervalu sdílený přístupový podpis přidružený k uloženým zásadám přístupu selže se stavovým kódem 403 (Zakázáno), dokud zásady přístupu nebudou aktivní. Viz https://learn.microsoft.com/rest/api/storageservices/set-share-acl
setMetadata(Metadata, ShareSetMetadataOptions)	Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadanou sdílenou složku. Pokud není k dispozici žádná možnost nebo v parametru možnosti nejsou definována žádná metadata, odeberou se metadata sdílené složky. Viz https://learn.microsoft.com/rest/api/storageservices/set-share-metadata
setProperties(ShareSetPropertiesOptions)	Nastaví vlastnosti sdílené složky.
setQuota(number, ShareSetQuotaOptions)	Nastaví kvótu pro zadanou sdílenou složku.
withSnapshot(string)	Vytvoří nový objekt ShareClient shodný se zdrojem, ale se zadaným časovým razítkem snímku. Zadejte "" odebere snímek a vrátí adresu URL základní sdílené složky.

Podrobnosti konstruktoru

Vytvoří instanci ShareClient.

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

Parametry

url: string

Řetězec adresy URL odkazující na sdílenou složku Azure Storage, například "https://myaccount.file.core.windows.net/share". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.file.core.windows.net/share?sasString".

credential: Credential | TokenCredential

Například AnonymousCredential nebo StorageSharedKeyCredential. Pokud není zadáno, použije se anonymnícredential.

options: ShareClientOptions

Optional. Možnosti konfigurace kanálu HTTP

Vytvoří instanci ShareClient.

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

Parametry

url: string

pipeline: Pipeline

Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený kanál.

options: ShareClientConfig

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

Parametry

connectionString: string

Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure. [ Poznámka: Připojovací řetězec účtu lze použít pouze v NODE.JS modulu runtime. ] Příklad připojovacího řetězce účtu – Příklad připojovacího řetězce SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net – 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ázev sdílené složky

options: ShareClientOptions

Optional. Možnosti konfigurace kanálu HTTP

Podrobnosti vlastnosti

Název sdílené složky

string name

Hodnota vlastnosti

string

Získá klienta adresáře pro kořenový adresář této sdílené složky. Všimněte si, že kořenový adresář vždy existuje a nelze ho odstranit.

Nový objekt ShareDirectoryClient pro kořenový adresář.

ShareDirectoryClient rootDirectoryClient

Hodnota vlastnosti

ShareDirectoryClient

Podrobnosti zděděných vlastností

accountName: string

Hodnota vlastnosti

string

zděděno ze StorageClient.accountName

Hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

zděděno ze StorageClient.url

Podrobnosti metody

Vytvoří novou sdílenou složku pod zadaným účtem. Pokud sdílená složka se stejným názvem již existuje, operace selže.

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

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

Parametry

options: ShareCreateOptions

Možnosti operace Vytvoření sdílené složky

Návraty

Promise<ShareCreateResponse>

Data odpovědí pro operaci Vytvoření sdílené složky

Vytvoří pod touto sdílenou složkou nový podadresář.

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

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

Parametry

directoryName: string

options: DirectoryCreateOptions

Možnosti operace vytvoření adresáře

Návraty

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

Data odpovědi na vytvoření adresáře a odpovídajícího klienta adresáře.

Vytvoří nový soubor nebo nahradí soubor v kořenovém adresáři této sdílené složky. Všimněte si, že inicializuje pouze soubor bez obsahu.

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

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

Parametry

fileName: string

size: number

Určuje maximální velikost v bajtech souboru až do 4 TB.

options: FileCreateOptions

Možnosti operace Vytvoření souboru

Návraty

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

Data odpovědi na vytvoření souboru a odpovídající klient souborů.

Vytvoří novou sdílenou složku pod zadaným účtem. Pokud sdílená složka se stejným názvem již existuje, nezmění se.

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

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

Parametry

options: ShareCreateOptions

Návraty

Promise<ShareCreateIfNotExistsResponse>

Vytvoří oprávnění k souboru (popisovač zabezpečení) na úrovni sdílené složky. Vytvořený popisovač zabezpečení lze použít pro soubory nebo adresáře ve sdílené složce.

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

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

Parametry

filePermission: string | SharePermission

Oprávnění k souboru popsanému v SDDL

options: ShareCreatePermissionOptions

Možnosti operace Sdílet vytvořit oprávnění

Návraty

Promise<ShareCreatePermissionResponse>

Vytvoří snímek sdílené složky jen pro čtení.

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

Parametry

options: ShareCreateSnapshotOptions

Možnosti operace vytvoření snímku sdílené složky

Návraty

Promise<ShareCreateSnapshotResponse>

Data odpovědí pro operaci Vytvoření snímku sdílené složky

Označí zadanou sdílenou složku pro odstranění. Sdílená složka a všechny adresáře nebo soubory obsažené v ní se později během uvolňování paměti odstraní.

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

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

Parametry

options: ShareDeleteMethodOptions

Možnosti operace Sdílení odstranění

Návraty

Promise<ShareDeleteResponse>

Data odpovědí pro operaci Odstranění sdílené složky.

Odebere zadaný prázdný podadresáři v této sdílené složce. Před odstraněním adresáře musí být adresář prázdný.

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

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

Parametry

directoryName: string

options: DirectoryDeleteOptions

Možnosti operace odstranění adresáře

Návraty

Promise<DirectoryDeleteResponse>

Data odpovědi na odstranění adresáře

Odebere soubor v kořenovém adresáři této sdílené složky z účtu úložiště. Když se soubor úspěšně odstraní, okamžitě se odebere z indexu účtu úložiště a už není přístupný pro klienty. Data souboru se později ze služby během uvolňování paměti odeberou.

Odstranění souboru selže se stavovým kódem 409 (Konflikt) a kód chyby SharingViolation, pokud je soubor otevřený v klientovi SMB.

Odstranění souboru není podporováno na snímku sdílené složky, což je kopie sdílené složky jen pro čtení. Pokus o provedení této operace na snímku sdílené složky selže se 400 (InvalidQueryParameterValue)

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

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

Parametry

fileName: string

options: FileDeleteOptions

Možnosti operace odstranění souboru

Návraty

Promise<FileDeleteResponse>

Slib<FileDeleteResponse> Soubor Odstranění dat odpovědi.

Označí zadanou sdílenou složku pro odstranění, pokud existuje. Sdílená složka a všechny adresáře nebo soubory obsažené v ní se později během uvolňování paměti odstraní.

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

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

Parametry

options: ShareDeleteMethodOptions

Návraty

Promise<ShareDeleteIfExistsResponse>

Vrátí hodnotu true, pokud existuje prostředek sdílené složky Azrue reprezentovaný tímto klientem; jinak nepravda.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující sdílená složka může být odstraněna jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové sdílené složky přidány jinými klienty nebo aplikacemi.

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

Parametry

options: ShareExistsOptions

možnosti pro operaci Existuje.

Návraty

Promise<boolean>

K dispozici pouze pro ShareClient vytvořené s přihlašovacími údaji sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

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

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

Parametry

options: ShareGenerateSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

K dispozici pouze pro ShareClient vytvořené s přihlašovacími údaji sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

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

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parametry

options: ShareGenerateSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

Získá oprávnění pro zadanou sdílenou složku. Oprávnění označují, jestli se ke sdíleným datům může přistupovat veřejně.

UPOZORNĚNÍ: Datum JavaScriptu může při analýze řetězce zahájení a konce platnosti dojít ke ztrátě přesnosti. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z".

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

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

Parametry

options: ShareGetAccessPolicyOptions

Návraty

Promise<ShareGetAccessPolicyResponse>

Data odpovědí pro operaci Zásady získání přístupu pro sdílenou složku

Vytvoří objekt ShareDirectoryClient.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parametry

directoryName: string

Název adresáře

Návraty

ShareDirectoryClient

Objekt ShareDirectoryClient pro daný název adresáře.

Získá jazyk SDDL (Security Descriptor Definition Language) pro daný klíč oprávnění souboru, který označuje popisovač zabezpečení.

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

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

Parametry

filePermissionKey: string

Klíč oprávnění souboru, který označuje popisovač zabezpečení oprávnění.

options: ShareGetPermissionOptions

Možnosti operace Sdílet vytvořit oprávnění

Návraty

Promise<ShareGetPermissionResponse>

Vrátí všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadanou sdílenou složku.

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

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodou listSharesShareServiceClient pomocí možnosti includeMetadata, která zachová původní velikost skříně.

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

Parametry

options: ShareGetPropertiesOptions

Návraty

Promise<ShareGetPropertiesResponse>

Data odpovědí pro operaci Získání vlastností sdílené složky

Získejte ShareLeaseClient, který spravuje zapůjčení souboru.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parametry

proposeLeaseId: string

Počáteční navrhované ID zapůjčení

Návraty

ShareLeaseClient

Nový objekt ShareLeaseClient pro správu zapůjčení v souboru.

Načte statistiky související se sdílenou složkou.

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

Parametry

options: ShareGetStatisticsOptions

Návraty

Promise<ShareGetStatisticsResponse>

Data odpovědí pro operaci Získání statistiky sdílené složky.

Nastaví oprávnění pro zadanou sdílenou složku. Oprávnění označují, jestli se k adresářům nebo souborům ve sdílené složce můžou přistupovat veřejně.

Když nastavíte oprávnění pro sdílenou složku, nahradí se stávající oprávnění. Pokud není k dispozici žádný seznam ShareAcl, odebere se stávající seznam ACL sdílené složky.

Když vytvoříte uložené zásady přístupu ve sdílené složce, může trvat až 30 sekund, než se projeví. Během tohoto intervalu sdílený přístupový podpis přidružený k uloženým zásadám přístupu selže se stavovým kódem 403 (Zakázáno), dokud zásady přístupu nebudou aktivní.

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

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

Parametry

shareAcl: SignedIdentifier[]

Pole podepsaných identifikátorů, z nichž každá má jedinečné ID a podrobnosti o zásadách přístupu.

options: ShareSetAccessPolicyOptions

Návraty

Promise<ShareSetAccessPolicyResponse>

Data odpovědí pro operaci zásady přístupu sady sdílených složek.

Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadanou sdílenou složku.

Pokud není k dispozici žádná možnost nebo v parametru možnosti nejsou definována žádná metadata, odeberou se metadata sdílené složky.

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

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

Parametry

metadata: Metadata

Pokud nejsou k dispozici žádná metadata, odeberou se všechna existující metadata adresáře.

options: ShareSetMetadataOptions

Návraty

Promise<ShareSetMetadataResponse>

Data odpovědí pro operaci metadat sady sdílených složek

Nastaví vlastnosti sdílené složky.

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

Parametry

options: ShareSetPropertiesOptions

Návraty

Promise<ShareSetPropertiesResponse>

Data odpovědí pro operaci Vlastnosti sady sdílených složek

Upozornění

Toto rozhraní API je teď zastaralé.

Use setProperties instead.

Nastaví kvótu pro zadanou sdílenou složku.

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

Parametry

quotaInGB: number

Určuje maximální velikost sdílené složky v gigabajtech.

options: ShareSetQuotaOptions

Návraty

Promise<ShareSetQuotaResponse>

Data odpovědí pro operaci Získání kvóty sdílené složky

Vytvoří nový objekt ShareClient shodný se zdrojem, ale se zadaným časovým razítkem snímku. Zadejte "" odebere snímek a vrátí adresu URL základní sdílené složky.

function withSnapshot(snapshot: string): ShareClient

Parametry

snapshot: string

Časové razítko snímku.

Návraty

ShareClient

Nový objekt ShareClient shodný se zdrojem, ale se zadaným časovým razítkem snímku

Sdílet prostřednictvím

ShareClient class

Konstruktory

Vlastnosti

Zděděné vlastnosti

Metody

Podrobnosti konstruktoru

ShareClient(string, Credential | TokenCredential, ShareClientOptions)

Parametry

ShareClient(string, Pipeline, ShareClientConfig)

Parametry

ShareClient(string, string, ShareClientOptions)

Parametry

Podrobnosti vlastnosti

name

Hodnota vlastnosti

rootDirectoryClient

Hodnota vlastnosti

Podrobnosti zděděných vlastností

accountName

Hodnota vlastnosti

url

Hodnota vlastnosti

Podrobnosti metody

create(ShareCreateOptions)

Parametry

Návraty

createDirectory(string, DirectoryCreateOptions)

Parametry

Návraty

createFile(string, number, FileCreateOptions)

Parametry

Návraty

createIfNotExists(ShareCreateOptions)

Parametry

Návraty

createPermission(string | SharePermission, ShareCreatePermissionOptions)

Parametry

Návraty

createSnapshot(ShareCreateSnapshotOptions)

Parametry

Návraty

delete(ShareDeleteMethodOptions)

Parametry

Návraty

deleteDirectory(string, DirectoryDeleteOptions)

Parametry

Návraty

deleteFile(string, FileDeleteOptions)

Parametry

Návraty

deleteIfExists(ShareDeleteMethodOptions)

Parametry

Návraty

exists(ShareExistsOptions)

Parametry

Návraty

generateSasStringToSign(ShareGenerateSasUrlOptions)

Parametry

Návraty

generateSasUrl(ShareGenerateSasUrlOptions)

Parametry

Návraty

getAccessPolicy(ShareGetAccessPolicyOptions)

Parametry

Návraty

getDirectoryClient(string)

Parametry

Návraty

getPermission(string, ShareGetPermissionOptions)

Parametry

Návraty

getProperties(ShareGetPropertiesOptions)

Parametry

Návraty

getShareLeaseClient(string)

Parametry

Návraty

getStatistics(ShareGetStatisticsOptions)

Parametry