ShareURL class

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

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

Extends: StorageURL

Konstruktory

Vytvoří instanci shareURL.

Vlastnosti

pipeline	Kanál zásad žádosti
url	Hodnota řetězce adresy URL.

Metody

create(Aborter, IShareCreateOptions)	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.
createPermission(Aborter, string)	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.
createSnapshot(Aborter, IShareCreateSnapshotOptions)	Vytvoří snímek sdílené složky jen pro čtení.
delete(Aborter, IShareDeleteMethodOptions)	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í.
fromServiceURL(ServiceURL, string)	Vytvoří objekt ShareURL ze služby ServiceURL.
getAccessPolicy(Aborter)	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".
getPermission(Aborter, string)	Získá jazyk SDDL (Security Descriptor Definition Language) pro daný klíč oprávnění souboru, který označuje popisovač zabezpečení.
getProperties(Aborter)	Vrátí všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadanou sdílenou složku.
getStatistics(Aborter)	Načte statistiky související se sdílenou složkou.
newPipeline(Credential, INewPipelineOptions)	Statická metoda používaná k vytvoření nového objektu kanálu s zadanými přihlašovacími údaji.
setAccessPolicy(Aborter, ISignedIdentifier[])	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.
setMetadata(Aborter, IMetadata)	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.
setQuota(Aborter, number)	Nastaví kvótu pro zadanou sdílenou složku.
withPipeline(Pipeline)	Vytvoří nový objekt ShareURL shodný se zdrojem, ale se zadaným kanálem zásad požadavku.
withSnapshot(string)	Vytvoří nový objekt ShareURL identický 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

ShareURL(string, Pipeline)

Vytvoří instanci shareURL.

new ShareURL(url: string, pipeline: Pipeline)

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".

pipeline: Pipeline

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

Podrobnosti vlastnosti

pipeline

Kanál zásad žádosti

pipeline: Pipeline

Hodnota vlastnosti

Pipeline

url

Hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

Podrobnosti metody

create(Aborter, IShareCreateOptions)

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.

function create(aborter: Aborter, options?: IShareCreateOptions)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

options: IShareCreateOptions

Návraty

Promise<Models.ShareCreateResponse>

createPermission(Aborter, string)

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.

function createPermission(aborter: Aborter, filePermission: string)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

filePermission: string

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

Návraty

Promise<Models.ShareCreatePermissionResponse>

createSnapshot(Aborter, IShareCreateSnapshotOptions)

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

function createSnapshot(aborter: Aborter, options?: IShareCreateSnapshotOptions)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

options: IShareCreateSnapshotOptions

Návraty

Promise<Models.ShareCreateSnapshotResponse>

delete(Aborter, IShareDeleteMethodOptions)

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í.

function delete(aborter: Aborter, options?: IShareDeleteMethodOptions)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

options: IShareDeleteMethodOptions

Návraty

Promise<Models.ShareDeleteResponse>

fromServiceURL(ServiceURL, string)

Vytvoří objekt ShareURL ze služby ServiceURL.

static function fromServiceURL(serviceURL: ServiceURL, shareName: string)

Parametry

serviceURL: ServiceURL

shareName: string

Návraty

ShareURL

getAccessPolicy(Aborter)

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".

function getAccessPolicy(aborter: Aborter)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

Návraty

Promise<ShareGetAccessPolicyResponse>

getPermission(Aborter, string)

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

function getPermission(aborter: Aborter, filePermissionKey: string)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

filePermissionKey: string

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

Návraty

Promise<Models.ShareGetPermissionResponse>

getProperties(Aborter)

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

function getProperties(aborter: Aborter)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

Návraty

Promise<Models.ShareGetPropertiesResponse>

getStatistics(Aborter)

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

function getStatistics(aborter: Aborter)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

Návraty

Promise<ShareGetStatisticsResponse>

newPipeline(Credential, INewPipelineOptions)

Statická metoda používaná k vytvoření nového objektu kanálu s zadanými přihlašovacími údaji.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

Parametry

credential: Credential

Například AnonymousCredential, SharedKeyCredential.

pipelineOptions: INewPipelineOptions

Návraty

Pipeline

Nový objekt kanálu.

setAccessPolicy(Aborter, ISignedIdentifier[])

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.

function setAccessPolicy(aborter: Aborter, shareAcl?: ISignedIdentifier[])

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

shareAcl: ISignedIdentifier[]

Návraty

Promise<Models.ShareSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

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.

function setMetadata(aborter: Aborter, metadata?: IMetadata)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

metadata: IMetadata

Návraty

Promise<Models.ShareSetMetadataResponse>

setQuota(Aborter, number)

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

function setQuota(aborter: Aborter, quotaInGB: number)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

quotaInGB: number

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

Návraty

Promise<Models.ShareSetQuotaResponse>

withPipeline(Pipeline)

Vytvoří nový objekt ShareURL shodný se zdrojem, ale se zadaným kanálem zásad požadavku.

function withPipeline(pipeline: Pipeline)

Parametry

pipeline: Pipeline

Návraty

ShareURL

withSnapshot(string)

Vytvoří nový objekt ShareURL identický 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)

Parametry

snapshot: string

Návraty

ShareURL

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

Váš názor

Byla tato stránka užitečná?