Sdílet prostřednictvím


@azure/storage-file-share package

Třídy

AccountSASPermissions

K DISPOZICI POUZE V NODE.JS RUNTIME.

Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená účtem AccountSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako pole oprávnění v AccountSASSignatureValues objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.

AccountSASResourceTypes

K DISPOZICI POUZE V NODE.JS RUNTIME.

Jedná se o pomocnou třídu pro vytvoření řetězce představujícího prostředky přístupné účtem AccountSAS. Nastavení hodnoty na hodnotu true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí přístup k danému typu prostředku. Jakmile jsou všechny hodnoty nastaveny, měl by být serializován s toString a nastaven jako pole zdroje v AccountSASSignatureValues objektu. Řetězec prostředků je možné sestavit bez této třídy, ale pořadí prostředků je specifické a tato třída zaručuje správnost.

AccountSASServices

K DISPOZICI POUZE V NODE.JS RUNTIME.

Toto je pomocná třída pro vytvoření řetězce představující služby přístupné účtem AccountSAS. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí přístup k této službě. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole služeb v AccountSASSignatureValues objektu. Řetězec služeb je možné sestavit bez této třídy, ale pořadí služeb je specifické a tato třída zaručuje správnost.

AnonymousCredential

AnonymousCredential poskytuje člen credentialPolicyCreator sloužící k vytvoření AnonymousCredentialPolicy objekty. AnonymousCredentialPolicy se používá s požadavky HTTP(S), které čtou veřejné prostředky nebo se používají se sdílenými přístupovými podpisy (SAS).

AnonymousCredentialPolicy

AnonymousCredentialPolicy se používá s požadavky HTTP(S), které čtou veřejné prostředky nebo se používají se sdílenými přístupovými podpisy (SAS).

BaseRequestPolicy

Základní třída, ze které jsou odvozeny všechny zásady požadavků.

Credential

Přihlašovací údaje jsou abstraktní třídou pro podepisování požadavků HTTP služby Azure Storage. Tato třída bude hostitelem objektu pro vytváření přihlašovacích údajůPolicyCreator, který generuje CredentialPolicy.

CredentialPolicy

Zásady přihlašovacích údajů používané k podepsání požadavků HTTP(S) před odesláním Toto je abstraktní třída.

FileSASPermissions

K DISPOZICI POUZE V NODE.JS RUNTIME.

Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená službou ServiceSAS k souboru. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění na FileSASSignatureValues objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.

FileSystemAttributes

Toto je pomocná třída pro vytvoření řetězce představujícího atributy NTFS do souboru nebo adresáře.

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

Pipeline

Třída kanálu obsahující zásady požadavků HTTP. Výchozí kanál můžete vytvořit voláním newPipeline. Nebo můžete vytvořit kanál s vlastními zásadami konstruktorem kanálu.

Před implementací přizpůsobeného kanálu si přečtěte newPipeline a poskytnuté zásady.

SASQueryParameters

Představuje komponenty, které tvoří parametry dotazu SAS služby Azure Storage. Tento typ není vytvořen přímo uživatelem; generuje se pouze AccountSASSignatureValues a FileSASSignatureValues typy. Po vygenerování je možné ho zakódovat do toString() a připojit se přímo k adrese URL (v případě, že existují existující parametry dotazu, které by mohly ovlivnit vhodné prostředky připojení těchto parametrů dotazu).

POZNÁMKA: Instance této třídy jsou neměnné.

ShareClient

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

ShareDirectoryClient

ShareDirectoryClient představuje adresu URL adresáře služby Azure Storage, který umožňuje manipulovat s jeho soubory a adresáři.

ShareFileClient

ShareFileClient představuje adresu URL souboru Azure Storage.

ShareLeaseClient

Klient, který spravuje zapůjčení pro ShareFileClient nebo ShareClient.

Viz https://learn.microsoft.com/rest/api/storageservices/lease-file a viz https://learn.microsoft.com/rest/api/storageservices/lease-share

ShareSASPermissions

Toto je pomocná třída pro vytvoření řetězce představujícího oprávnění udělená službou ServiceSAS ke sdílené složce. Nastavení hodnoty true znamená, že jakýkoli SAS, který tato oprávnění používá, udělí oprávnění pro danou operaci. Jakmile jsou všechny hodnoty nastaveny, měla by být serializována s toString a nastavena jako pole oprávnění na FileSASSignatureValues objektu. Řetězec oprávnění je možné vytvořit bez této třídy, ale pořadí oprávnění je specifické a tato třída zaručuje správnost.

ShareServiceClient

ShareServiceClient představuje adresu URL služby Azure Storage File, která umožňuje manipulovat se sdílenými složkami.

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory je třída továrny, která pomáhá generovat objekty StorageBrowserPolicy.

StorageRetryPolicy

Zásady opakování s exponenciálními opakováními a implementovanými lineárními opakováními

StorageRetryPolicyFactory

StorageRetryPolicyFactory je třída továrny, která pomáhá generovat StorageRetryPolicy objekty.

StorageSharedKeyCredential

K DISPOZICI POUZE V NODE.JS RUNTIME.

StorageSharedKeyCredential pro autorizaci klíče účtu služby Azure Storage

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy je zásada použitá k podepsání požadavku HTTP pomocí sdíleného klíče.

Rozhraní

AccessPolicy

Zásady přístupu.

AccountSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME.

AccountSASSignatureValues slouží k vygenerování sdíleného přístupového podpisu (SAS) pro účet služby Azure Storage. Jakmile jsou všechny zde uvedené hodnoty správně nastaveny, zavolejte generateAccountSASQueryParameters získat reprezentaci SAS, která se dá skutečně použít na adresy URL souborů. Poznámka: Tato třída i SASQueryParameters existují, protože první třída je proměnlivá a logická reprezentace, zatímco druhá třída je neměnná a používá se k vygenerování skutečných požadavků REST.

Další koncepční informace o SAS najdete v https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1, kde najdete https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas popisy parametrů, včetně požadovaných parametrů.

ClearRange
CloseHandlesInfo

Zavření zpracovává informace o výsledku.

CommonGenerateSasUrlOptions

Běžné možnosti ShareGenerateSasUrlOptions a FileGenerateSasUrlOptions.

CommonOptions

Rozhraní pro možnosti společné pro každou vzdálenou operaci.

CopyFileSmbInfo

Skupina parametrů

CorsRule

CORS je funkce HTTP, která umožňuje webové aplikaci spuštěné v jedné doméně přistupovat k prostředkům v jiné doméně. Webové prohlížeče implementují omezení zabezpečení známé jako zásady stejného původu, které brání webové stránce v volání rozhraní API v jiné doméně; CORS poskytuje bezpečný způsob, jak povolit, aby jedna doména (původní doména) volala rozhraní API v jiné doméně.

DirectoryCloseHandlesHeaders

Další hodnoty hlavičky odpovědi pro žádost o uzavření zpracovává.

DirectoryCreateHeaders

Definuje hlavičky pro operaci Directory_create.

DirectoryCreateIfNotExistsResponse

Obsahuje data odpovědí pro operaci createIfNotExists(DirectoryCreateOptions).

DirectoryCreateOptions

Možnosti konfigurace operace vytvoření

DirectoryDeleteHeaders

Definuje hlavičky pro operaci Directory_delete.

DirectoryDeleteIfExistsResponse

Obsahuje data odpovědí pro operaci deleteIfExists(DirectoryDeleteOptions).

DirectoryDeleteOptions

Možnosti konfigurace operace odstranění

DirectoryExistsOptions

Možnosti konfigurace existují operace.

DirectoryForceCloseHandlesHeaders

Definuje hlavičky pro operaci Directory_forceCloseHandles.

DirectoryForceCloseHandlesOptions

Možnosti konfigurace forceCloseHandle.

DirectoryForceCloseHandlesSegmentOptions

Možnosti konfigurace adresáře – Vynucení operací segmentů operací zavření

See:

DirectoryGetPropertiesHeaders

Definuje hlavičky pro operaci Directory_getProperties.

DirectoryGetPropertiesOptions

Možnosti konfigurace operace getProperties

DirectoryItem

Položka adresáře uvedená v seznamu.

DirectoryListFilesAndDirectoriesOptions

Možnosti konfigurace listFilesAndDirectories operace.

DirectoryListFilesAndDirectoriesSegmentHeaders

Definuje hlavičky pro operaci Directory_listFilesAndDirectoriesSegment.

DirectoryListHandlesHeaders

Definuje hlavičky pro operaci Directory_listHandles.

DirectoryListHandlesOptions

Možnosti konfigurace operace listHandles

DirectoryListHandlesSegmentOptions

Možnosti konfigurace adresáře – Operace segmentů seznam

See:

  • <xref:ShareDirectoryClient.listHandlesSegment>
  • <xref:ShareDirectoryClient.iterateHandleSegments>
  • <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties

Rozhraní pro možnosti společné pro každou vzdálenou operaci.

DirectoryRenameHeaders

Definuje hlavičky pro operaci Directory_rename.

DirectoryRenameOptions

Možnosti konfigurace operace přejmenování

DirectorySetMetadataHeaders

Definuje hlavičky pro operaci Directory_setMetadata.

DirectorySetMetadataOptions

Možnosti konfigurace operace setMetadata

DirectorySetPropertiesHeaders

Definuje hlavičky pro operaci Directory_setProperties.

FileAbortCopyFromURLOptions

Možnosti konfigurace operace abortCopyFromURL

FileAbortCopyHeaders

Definuje hlavičky pro operaci File_abortCopy.

FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions

Možnosti konfigurace operace clearRange

FileCloseHandlesHeaders

Další hodnoty hlavičky odpovědi pro žádost o uzavření zpracovává.

FileCreateHardLinkHeaders

Definuje hlavičky pro operaci File_createHardLink.

FileCreateHardLinkOptions

Možnosti konfigurace souboru – Operace vytvoření pevného propojení

See:

FileCreateHeaders

Definuje hlavičky pro operaci File_create.

FileCreateOptions

Možnosti konfigurace operace vytvoření

FileCreateSymbolicLinkHeaders

Definuje hlavičky pro File_createSymbolicLink operaci.

FileCreateSymbolicLinkOptions

Možnosti konfigurace operací Soubor – Vytvořit symbolický odkaz.

See:

FileDeleteHeaders

Definuje hlavičky pro operaci File_delete.

FileDeleteIfExistsResponse

Obsahuje data odpovědí pro operaci deleteIfExists.

FileDeleteOptions

Možnosti konfigurace operace odstranění

FileDownloadHeaders

Definuje hlavičky pro operaci File_download.

FileDownloadOptionalParams

Volitelné parametry.

FileDownloadOptions

Možnosti konfigurace souboru – operace stahování

See:

FileDownloadToBufferOptions

Rozhraní možností pro operaci downloadToBuffer.

FileExistsOptions

Možnosti konfigurace existují operace.

FileForceCloseHandlesHeaders

Definuje hlavičky pro operaci File_forceCloseHandles.

FileForceCloseHandlesOptions

Možnosti konfigurace souboru – Vynucení operací popisovačů zavření

See:

FileGenerateSasUrlOptions

Možnosti konfigurace vygenerování operace SasUrl

FileGetPropertiesHeaders

Definuje hlavičky pro operaci File_getProperties.

FileGetPropertiesOptions

Možnosti konfigurace operace getProperties

FileGetRangeListHeaders

Definuje hlavičky pro operaci File_getRangeList.

FileGetRangeListOptions

Možnosti konfigurace operace getRangeList

FileGetSymbolicLinkHeaders

Definuje hlavičky pro File_getSymbolicLink operaci.

FileGetSymbolicLinkOptions

Možnosti konfigurace operací Soubor – Získat symbolický odkaz.

See:

FileHttpHeaders
FileItem

Položka souboru v seznamu.

FileListHandlesHeaders

Definuje hlavičky pro operaci File_listHandles.

FileListHandlesOptions

Rozhraní pro možnosti společné pro každou vzdálenou operaci.

FileListHandlesSegmentOptions

Možnosti konfigurace souboru – Operace segmentů seznam

See:

  • <xref:ShareFileClient.listHandlesSegment>
  • <xref:ShareFileClient.iterateHandleSegments>
  • <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions

Rozhraní možností pro soubor – operace nahrávání

See:

  • uploadFile
  • <xref:ShareFileClient.uploadSeekableStream>
FilePosixProperties

Vlastnosti systému souborů NFS. Tyto vlastnosti platí jenom pro soubory nebo adresáře v účtech souborů NFS úrovně Premium.

FileProperties

Rozhraní pro možnosti společné pro každou vzdálenou operaci.

FileProperty

Vlastnosti souboru.

FileRenameHeaders

Definuje hlavičky pro operaci File_rename.

FileRenameOptions

Možnosti konfigurace operace přejmenování

FileResizeOptions

Možnosti konfigurace operace změny velikosti

FileSASSignatureValues

K DISPOZICI POUZE V NODE.JS RUNTIME.

FileSASSignatureValues slouží ke generování tokenů SAS souborové služby pro sdílené složky nebo soubory.

FileServiceProperties

Vlastnosti služby Úložiště

FileSetHTTPHeadersHeaders

Definuje hlavičky pro operaci File_setHttpHeaders.

FileSetHttpHeadersOptions

Možnosti konfigurace operace setHttpHeaders

FileSetMetadataHeaders

Definuje hlavičky pro operaci File_setMetadata.

FileSetMetadataOptions

Možnosti konfigurace operace setMetadata

FileStartCopyHeaders

Definuje hlavičky pro operaci File_startCopy.

FileStartCopyOptions

Možnosti konfigurace operace startCopyFromURL.

FileUploadRangeFromURLHeaders

Definuje hlavičky pro operaci File_uploadRangeFromURL.

FileUploadRangeFromURLOptionalParams

Volitelné parametry.

FileUploadRangeFromURLOptions

Možnosti konfigurace operace uploadRangeFromURL

FileUploadRangeHeaders

Definuje hlavičky pro operaci File_uploadRange.

FileUploadRangeOptions

Možnosti konfigurace operace uploadRange

FileUploadStreamOptions

Rozhraní možností pro ShareFileClient.uploadStream().

FilesAndDirectoriesListSegment

Abstrakce pro položky, které lze uvést z adresáře.

HandleItem

Položka popisovače služby Azure Storage uvedená v seznamu

HttpAuthorization

Představuje ověřovací informace v autorizaci, ProxyAuthorization, WWW-Authenticate a Proxy-Authenticate hodnoty hlaviček.

HttpHeaders

Kolekce párů klíč/hodnota hlavičky HTTP.

HttpOperationResponse

Odpověď HTTP, která je kompatibilní s jádrem-v1 (core-http).

HttpResponse

Reprezentace odpovědi HTTP, která obsahuje odkaz na požadavek, který ho pochází.

LeaseAccessConditions

Skupina parametrů

LeaseOperationOptions

možnosti zapůjčení.

LeaseOperationResponseHeaders

Podrobnosti odpovědi pro konkrétní operaci zapůjčení

ListFilesAndDirectoriesSegmentResponse

Výčet adresářů a souborů.

ListHandlesResponse

Výčet popisovačů

ListSharesResponse

Výčet sdílených složek.

ListSharesResponseModel

Výčet sdílených složek.

Metadata
Metrics

Metriky Analýzy úložiště pro souborovou službu

NfsFileMode

Oprávnění režimu souboru nebo adresáře.

PipelineLike

Rozhraní pro třídu pipeline Pipeline obsahující zásady požadavků HTTP. Výchozí kanál můžete vytvořit voláním newPipeline. Nebo můžete vytvořit kanál s vlastními zásadami konstruktorem kanálu.

Před implementací přizpůsobeného kanálu si přečtěte newPipeline a poskytnuté zásady.

PipelineOptions

Rozhraní option pro konstruktor kanálu.

PosixRolePermissions

Představuje oprávnění k souborům pro konkrétní roli.

Range

Rozsah operací služby.

Viz https://learn.microsoft.com/rest/api/storageservices/specifying-the-range-header-for-file-service-operations

RangeModel

Rozsah souborů Azure Storage.

RequestPolicy

Kompatibilní rozhraní pro zásady požadavků core-http

RequestPolicyFactory

Rozhraní pro kompatibilitu s RequestPolicyFactory core-http

RequestPolicyOptions

Rozhraní pro kompatibilitu s RequestPolicy

ResponseLike

Objekt s jednoduchou vlastností _response.

ResponseWithBody

Objekt s vlastností _response, která obsahuje tělo a záhlaví již parsovaná do známých typů.

ResponseWithHeaders

Objekt s vlastností _response, která obsahuje hlavičky, které jsou již analyzovány do zadaného objektu.

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

RetentionPolicy

Zásady uchovávání informací.

SasIPRange

Povolený rozsah IP adres pro SAS.

ServiceClientOptions

Podmnožina @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

Možnosti konfigurace generateAccountSasUrl operace

ServiceGetPropertiesHeaders

Definuje hlavičky pro operaci Service_getProperties.

ServiceGetPropertiesOptions

Možnosti konfigurace operace getProperties

ServiceListSharesOptions

Možnosti konfigurace operace listShares

ServiceListSharesSegmentHeaders

Definuje hlavičky pro operaci Service_listSharesSegment.

ServiceSetPropertiesHeaders

Definuje hlavičky pro operaci Service_setProperties.

ServiceSetPropertiesOptions

Možnosti konfigurace operace setProperties

ServiceUndeleteShareOptions

Možnosti konfigurace operace <xref:ShareServiceClient.undelete>

SetPropertiesResponse

Obsahuje data odpovědi pro operaci setHttpHeaders.

ShareClientConfig
ShareCreateHeaders

Definuje hlavičky pro operaci Share_create.

ShareCreateIfNotExistsResponse

Obsahuje data odpovědí pro operaci createIfNotExists.

ShareCreateOptions

Možnosti konfigurace operace vytvoření

ShareCreatePermissionHeaders

Definuje hlavičky pro operaci Share_createPermission.

ShareCreatePermissionOptions

Možnosti konfigurace operace createPermission

ShareCreateSnapshotHeaders

Definuje hlavičky pro operaci Share_createSnapshot.

ShareCreateSnapshotOptions

Možnosti konfigurace operace createSnapshot

ShareDeleteHeaders

Definuje hlavičky pro operaci Share_delete.

ShareDeleteIfExistsResponse

Obsahuje data odpovědí pro operaci deleteIfExists.

ShareDeleteMethodOptions

Možnosti konfigurace operace odstranění

ShareExistsOptions

Možnosti konfigurace existují operace.

ShareFileRangeList

Seznam oblastí souborů

ShareGenerateSasUrlOptions

Možnosti konfigurace vygenerování operace SasUrl

ShareGetAccessPolicyHeaders

Definuje hlavičky pro operaci Share_getAccessPolicy.

ShareGetAccessPolicyOptions

Možnosti konfigurace operace getAccessPolicy

ShareGetPermissionHeaders

Definuje hlavičky pro operaci Share_getPermission.

ShareGetPermissionOptions

Možnosti konfigurace operace getPermission

ShareGetPropertiesHeaders

Definuje hlavičky pro operaci Share_getProperties.

ShareGetPropertiesOptions

Možnosti konfigurace operace getProperties

ShareGetStatisticsHeaders

Definuje hlavičky pro operaci Share_getStatistics.

ShareGetStatisticsOptions

Možnosti konfigurace operace getStatistics

ShareItem

Uvedená položka sdílené složky Azure Storage.

ShareItemInternal

Uvedená položka sdílené složky Azure Storage.

SharePermission

Oprávnění (popisovač zabezpečení) na úrovni sdílené složky.

SharePropertiesInternal

Vlastnosti sdílené složky

ShareProtocolSettings

Nastavení protokolu

ShareProtocols

Protokoly, které se mají povolit ve sdílené složce. Prozatím podporuje jenom protokol SMB nebo NFS.

ShareSetAccessPolicyHeaders

Definuje hlavičky pro operaci Share_setAccessPolicy.

ShareSetAccessPolicyOptions

Možnosti konfigurace operace setAccessPolicy

ShareSetMetadataHeaders

Definuje hlavičky pro operaci Share_setMetadata.

ShareSetMetadataOptions

Možnosti konfigurace operace setMetadata

ShareSetPropertiesHeaders

Definuje hlavičky pro operaci Share_setProperties.

ShareSetPropertiesOptions

Možnosti konfigurace operace setProperties

ShareSetQuotaOptions

Možnosti konfigurace operace setQuota

ShareSmbSettings

Nastavení protokolu SMB.

ShareStats

Statistiky sdílené složky

SignedIdentifier

Identifikátor se znaménkem

SignedIdentifierModel

Identifikátor se znaménkem.

SmbMultichannel

Nastavení pro smb multichannel

SourceModifiedAccessConditions

Skupina parametrů

StoragePipelineOptions

Rozhraní Options pro funkci newPipeline

StorageRetryOptions

Rozhraní možností opakování objektu blob úložiště

WebResource

Popis požadavku HTTP, který se má provést na vzdálený server.

Aliasy typu

CopyStatusType

Definuje hodnoty pro CopyStatusType.

DeleteSnapshotsOptionType

Definuje hodnoty pro DeleteSnapshotsOptionType.

DirectoryCreateResponse

Obsahuje data odpovědí pro operaci vytvoření.

DirectoryDeleteResponse

Obsahuje data odpovědí pro operaci odstranění.

DirectoryForceCloseHandlesResponse

Typ odpovědi pro forceCloseHandle.

DirectoryGetPropertiesResponse

Obsahuje data odpovědí pro operaci getProperties.

DirectoryListFilesAndDirectoriesSegmentResponse

Obsahuje data odpovědi pro operaci listFilesAndDirectoriesSegment.

DirectoryListHandlesResponse

Obsahuje data odpovědi pro operaci listHandles.

DirectoryRenameResponse

Obsahuje data odpovědí pro operaci přejmenování.

DirectorySetMetadataResponse

Obsahuje data odpovědi pro operaci setMetadata.

DirectorySetPropertiesResponse

Obsahuje data odpovědi pro operaci setProperties.

FileAbortCopyResponse

Obsahuje data odpovědí pro operaci abortCopy.

FileAttributesPreserveType

Označuje zachování existujících atributů souboru beze změny.

FileCreateHardLinkResponse

Obsahuje data odpovědí pro operaci vytvoření pevného propojení.

FileCreateResponse

Obsahuje data odpovědí pro operaci vytvoření.

FileCreateSymbolicLinkResponse

Obsahuje data odpovědí pro operaci vytvoření pevného propojení.

FileDeleteResponse

Obsahuje data odpovědí pro operaci odstranění.

FileDownloadResponseModel

Obsahuje data odpovědí pro operaci stahování.

FileForceCloseHandlesResponse

Typ odpovědi pro forceCloseHandle.

FileGetPropertiesResponse

Obsahuje data odpovědí pro operaci getProperties.

FileGetRangeListDiffResponse

Obsahuje data odpovědi pro operaci getRangeList.

FileGetRangeListResponse

Obsahuje data odpovědí pro operaci getRangeList.

FileGetSymbolicLinkResponse

Obsahuje data odpovědí pro operaci vytvoření pevného propojení.

FileLastWrittenMode

Definuje hodnoty pro FileLastWrittenMode.

FileListHandlesResponse

Obsahuje data odpovědi pro operaci listHandles.

FilePermissionFormat

Definuje hodnoty pro FilePermissionFormat.

FilePermissionInheritType

Označuje dědění oprávnění k souboru z nadřazeného adresáře.

FilePermissionPreserveType

Označuje zachování stávající hodnoty oprávnění k souboru beze změny.

FileRenameResponse

Obsahuje data odpovědí pro operaci přejmenování.

FileSetHTTPHeadersResponse

Obsahuje data odpovědi pro operaci setHttpHeaders.

FileSetMetadataResponse

Obsahuje data odpovědi pro operaci setMetadata.

FileStartCopyResponse

Obsahuje data odpovědí pro operaci startCopy.

FileUploadRangeFromURLResponse

Obsahuje data odpovědi pro operaci uploadRangeFromURL.

FileUploadRangeResponse

Obsahuje data odpovědí pro operaci uploadRange.

HttpRequestBody

Typy subjektů podporovaných na žádosti. NodeJS.ReadableStream a () => NodeJS.ReadableStream je pouze Uzel. Blob, ReadableStream<Uint8Array> a () => ReadableStream<Uint8Array> jsou pouze prohlížeče.

LeaseDurationType

Definuje hodnoty pro LeaseDurationType.

LeaseOperationResponse

Obsahuje data odpovědí pro operace, které získávají, mění, přeruší nebo uvolní zapůjčení.

Viz téma ShareLeaseClient.

LeaseStateType

Definuje hodnoty pro LeaseStateType.

LeaseStatusType

Definuje hodnoty pro LeaseStatusType.

ListSharesIncludeType

Definuje hodnoty pro ListSharesIncludeType.

ModeCopyMode

Definuje hodnoty pro ModeCopyMode.

NfsFileType

Definuje hodnoty pro NfsFileType.
<xref:KnownNfsFileType> lze použít zaměnitelně s NfsFileType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Regular
Directory
SymLink

OwnerCopyMode

Definuje hodnoty pro OwnerCopyMode.

PermissionCopyModeType

Definuje hodnoty pro PermissionCopyModeType.

RawFileDownloadResponse

Obsahuje data odpovědí pro operaci stahování.

ServiceGetPropertiesResponse

Obsahuje data odpovědí pro operaci getProperties.

ServiceListSharesSegmentResponse

Obsahuje data odpovědí pro operaci listShares.

ServiceSetPropertiesResponse

Obsahuje data odpovědi pro operaci setProperties.

ShareAccessTier

Definuje hodnoty pro ShareAccessTier.

ShareClientOptions
ShareCreatePermissionResponse

Obsahuje data odpovědí pro operaci createPermission.

ShareCreateResponse

Obsahuje data odpovědí pro operaci vytvoření.

ShareCreateSnapshotResponse

Obsahuje data odpovědí pro operaci createSnapshot.

ShareDeleteResponse

Obsahuje data odpovědí pro operaci odstranění.

ShareFileHandleAccessRights

Definuje hodnoty pro AccessRight.

ShareGetAccessPolicyResponse
ShareGetPermissionResponse

Obsahuje data odpovědi pro operaci getPermission.

ShareGetPropertiesResponse

Obsahuje data odpovědi pro operaci getProperties.

ShareGetPropertiesResponseModel

Obsahuje data odpovědí pro operaci getProperties.

ShareGetStatisticsResponse

Data odpovědi pro operaci getStatistics.

ShareGetStatisticsResponseModel

Obsahuje data odpovědi pro operaci getStatistics.

ShareProperties

Vlastnosti sdílené složky

ShareRootSquash

Definuje hodnoty pro ShareRootSquash.

ShareSetAccessPolicyResponse

Obsahuje data odpovědi pro operaci setAccessPolicy.

ShareSetMetadataResponse

Obsahuje data odpovědi pro operaci setMetadata.

ShareSetPropertiesResponse

Obsahuje data odpovědi pro operaci setProperties.

ShareSetQuotaHeaders

Definuje hlavičky pro operaci setQuota.

ShareSetQuotaResponse

Obsahuje data odpovědi pro operaci setQuota.

ShareTokenIntent

Definuje hodnoty pro ShareTokenIntent.
PoleShareTokenIntent lze použít zaměnitelně s ShareTokenIntent, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

backup

TimeNowType

Označuje nastavení jako čas požadavku.

TimePreserveType

Označuje zachování stávající časové hodnoty beze změny.

WithResponse

Typ, který představuje výsledek operace se známou vlastností _response.

Výčty

KnownShareTokenIntent

Známé hodnoty ShareTokenIntent, které služba přijímá.

SASProtocol

Protokoly pro vygenerovaný SAS.

StorageFileAudience

Definuje známé cílové skupiny cloudu pro službu Storage.

StorageRetryPolicyType

Typy RetryPolicy.

Funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vygeneruje SASQueryParameters objekt, který obsahuje všechny parametry dotazu SAS potřebné k vytvoření skutečného požadavku REST.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vytvoří instanci SASQueryParameters.

Přijímá pouze požadovaná nastavení potřebná k vytvoření sdíleného přístupového podpisu. Pro volitelná nastavení nastavte odpovídající vlastnosti přímo, například oprávnění, startOn a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, jsou vyžadována oprávnění a vypršení platnosti. Pokud tento konstruktor inicializace inicializace pomocí tohoto konstruktoru inicialy, musíte k identifikátoru přiřadit hodnotu nebo platnost vyprší & oprávnění ručně.

getFileServiceAccountAudience(string)

Pokud chcete získat cílovou skupinu OAuth pro účet úložiště pro souborovou službu.

isPipelineLike(unknown)

Pomocná rutina, která rozhodne, jestli daný argument splňuje kontrakt kanálu

newPipeline(Credential | TokenCredential, StoragePipelineOptions)

Vytvoří nový objekt kanálu se zadanými přihlašovacími údaji.

parseOctalFileMode(string)

Parsování 4ciferného osmimístného řetězcového vyjádření režimu souboru do struktury NfsFileMode.

parseSymbolicFileMode(string)

Parsování 9mísícového symbolického řetězcového vyjádření režimu souboru do struktury NfsFileMode.

toOctalFileMode(NfsFileMode)

Převeďte NfsFileMode strukturu na 4cifernou osmimístnou represenaci.

toSymbolicFileMode(NfsFileMode)

Převeďte NfsFileMode na řetězec v symbolickém zápisu.

Podrobnosti funkce

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vygeneruje SASQueryParameters objekt, který obsahuje všechny parametry dotazu SAS potřebné k vytvoření skutečného požadavku REST.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parametry

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Návraty

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vytvoří instanci SASQueryParameters.

Přijímá pouze požadovaná nastavení potřebná k vytvoření sdíleného přístupového podpisu. Pro volitelná nastavení nastavte odpovídající vlastnosti přímo, například oprávnění, startOn a identifikátor.

UPOZORNĚNÍ: Pokud identifikátor není zadaný, jsou vyžadována oprávnění a vypršení platnosti. Pokud tento konstruktor inicializace inicializace pomocí tohoto konstruktoru inicialy, musíte k identifikátoru přiřadit hodnotu nebo platnost vyprší & oprávnění ručně.

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parametry

fileSASSignatureValues
FileSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Návraty

getFileServiceAccountAudience(string)

Pokud chcete získat cílovou skupinu OAuth pro účet úložiště pro souborovou službu.

function getFileServiceAccountAudience(storageAccountName: string): string

Parametry

storageAccountName

string

Návraty

string

isPipelineLike(unknown)

Pomocná rutina, která rozhodne, jestli daný argument splňuje kontrakt kanálu

function isPipelineLike(pipeline: unknown): pipeline

Parametry

pipeline

unknown

Argument, který může být kanálem

Návraty

pipeline

true, pokud argument splňuje kontrakt kanálu

newPipeline(Credential | TokenCredential, StoragePipelineOptions)

Vytvoří nový objekt kanálu se zadanými přihlašovacími údaji.

function newPipeline(credential?: Credential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parametry

credential

Credential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

pipelineOptions
StoragePipelineOptions

Optional. Options.

Návraty

Nový objekt kanálu.

parseOctalFileMode(string)

Parsování 4ciferného osmimístného řetězcového vyjádření režimu souboru do struktury NfsFileMode.

function parseOctalFileMode(input?: string): NfsFileMode | undefined

Parametry

input

string

Návraty

NfsFileMode | undefined

parseSymbolicFileMode(string)

Parsování 9mísícového symbolického řetězcového vyjádření režimu souboru do struktury NfsFileMode.

function parseSymbolicFileMode(input?: string): NfsFileMode | undefined

Parametry

input

string

Návraty

NfsFileMode | undefined

toOctalFileMode(NfsFileMode)

Převeďte NfsFileMode strukturu na 4cifernou osmimístnou represenaci.

function toOctalFileMode(input?: NfsFileMode): string | undefined

Parametry

input
NfsFileMode

Návraty

string | undefined

toSymbolicFileMode(NfsFileMode)

Převeďte NfsFileMode na řetězec v symbolickém zápisu.

function toSymbolicFileMode(input?: NfsFileMode): string | undefined

Parametry

input
NfsFileMode

Návraty

string | undefined