Udostępnij za pośrednictwem

@azure/storage-file-datalake package

  • Odwołanie

Klasy

AccountSASPermissions

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego uprawnienia przyznane przez accountSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole uprawnień w AccountSASSignatureValues obiektu. Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
AccountSASResourceTypes

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego zasoby dostępne dla kontaSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna dostęp do tego typu zasobu. Po ustawieniu wszystkich wartości powinna zostać zserializowana ciągiem toString i ustawiona jako pole zasobów na AccountSASSignatureValues obiektu. Można utworzyć ciąg zasobów bez tej klasy, ale kolejność zasobów jest określona, a ta klasa gwarantuje poprawność.
AccountSASServices

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego usługi dostępne w usłudze AccountSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna dostęp do tej usługi. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole usług na AccountSASSignatureValues obiektu. Można skonstruować ciąg usług bez tej klasy, ale kolejność usług jest określona, a ta klasa gwarantuje poprawność.
AnonymousCredential

Funkcja AnonymousCredential udostępnia element członkowski credentialPolicyCreator używany do tworzenia obiektów AnonymousCredentialPolicy. Funkcja AnonymousCredentialPolicy jest używana z żądaniami HTTP(S), które odczytują zasoby publiczne lub są używane z sygnaturami dostępu współdzielonego (SAS).
AnonymousCredentialPolicy

Funkcja AnonymousCredentialPolicy jest używana z żądaniami HTTP(S), które odczytują zasoby publiczne lub są używane z sygnaturami dostępu współdzielonego (SAS).
BaseRequestPolicy

Klasa bazowa, z której pochodzą wszystkie zasady żądań.
Credential

Credential to abstrakcyjna klasa podpisywania żądań HTTP usługi Azure Storage. Ta klasa będzie hostować fabrykę credentialPolicyCreator, która generuje element CredentialPolicy.
CredentialPolicy

Zasady poświadczeń używane do podpisywania żądań HTTP(S) przed wysłaniem. Jest to abstrakcyjna klasa.
DataLakeAclChangeFailedError

Błąd zgłaszany po przerwaniu operacji i może być kontynuowany później.
DataLakeDirectoryClient

Obiekt DataLakeDirectoryClient reprezentuje adres URL katalogu usługi Azure Storage.
DataLakeFileClient

Obiekt DataLakeFileClient reprezentuje adres URL pliku usługi Azure Storage.
DataLakeFileSystemClient

Obiekt DataLakeFileSystemClient reprezentuje adres URL systemu plików usługi Azure Storage, który umożliwia manipulowanie jego katalogami i plikami.
DataLakeLeaseClient
DataLakePathClient

Obiekt DataLakePathClient reprezentuje adres URL ścieżki usługi Azure Storage (katalogu lub pliku).
DataLakeSASPermissions

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego uprawnienia przyznane przez usługę ServiceSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole uprawnień w obiekcie DataLakeSASSignatureValues. Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
DataLakeServiceClient

Obiekt DataLakeServiceClient umożliwia manipulowanie zasobami i systemami plików usługi Azure Data Lake. Konto magazynu zapewnia przestrzeń nazw najwyższego poziomu dla usługi Data Lake.
DirectorySASPermissions

Jest to klasa pomocnika do konstruowania ciągu reprezentującego uprawnienia przyznane przez usługę ServiceSAS do katalogu. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole uprawnień w obiekcie DataLakeSASSignatureValues. Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
FileSystemSASPermissions

Jest to klasa pomocnika służąca do konstruowania ciągu reprezentującego uprawnienia przyznane przez usługę ServiceSAS do kontenera. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą funkcji toString i ustawić jako pole uprawnień w obiekcie DataLakeSASSignatureValues. Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
Pipeline

Klasa Potok zawierająca zasady żądań HTTP. Możesz utworzyć domyślny potok, wywołując newPipeline. Możesz też utworzyć potok przy użyciu własnych zasad przez konstruktor potoku.

Przed wdrożeniem dostosowanego potoku zapoznaj się z tematem newPipeline i podano zasady.
RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.
SASQueryParameters

Reprezentuje składniki tworzące parametry zapytania sygnatury dostępu współdzielonego usługi Azure Storage. Ten typ nie jest konstruowany bezpośrednio przez użytkownika; Jest on generowany tylko przez typy AccountSASSignatureValues i <xref:BlobSASSignatureValues>. Po wygenerowaniu można je kodować w toString() i dołączać bezpośrednio do adresu URL (należy jednak zachować ostrożność w przypadku istnienia parametrów zapytania, co może mieć wpływ na odpowiednie środki dołączania tych parametrów zapytania).

UWAGA: Wystąpienia tej klasy są niezmienne.
StorageBrowserPolicy

StorageBrowserPolicy będzie obsługiwać różnice między Node.js a środowiskiem uruchomieniowym przeglądarki, w tym:

  1. Przeglądarki buforuje żądania GET/HEAD, dodając nagłówki warunkowe, takie jak "IF_MODIFIED_SINCE". StorageBrowserPolicy to zasady służące do dodawania zapytania sygnatury czasowej do adresu URL żądania GET/HEAD, co pozwala uniknąć pamięci podręcznej przeglądarki.

  2. Usuń nagłówek pliku cookie na potrzeby zabezpieczeń

  3. Usuń nagłówek o długości zawartości, aby uniknąć ostrzeżenia przeglądarki
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów StorageBrowserPolicy.
StorageRetryPolicy

Zasady ponawiania próby z implementacją ponawiania wykładniczego i ponawiania liniowego.
StorageRetryPolicyFactory

StorageRetryPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów StorageRetryPolicy.
StorageSharedKeyCredential

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

StorageSharedKeyCredential na potrzeby autoryzacji klucza konta usługi Azure Storage.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy to zasady używane do podpisywania żądania HTTP przy użyciu klucza współużytkowanego.

Interfejsy

AccessControlChangeCounters

AccessControlChangeCounters zawiera liczbę operacji, które zmieniają listy kontroli dostępu cyklicznie.
AccessControlChangeError

Reprezentuje wpis, który nie może zaktualizować listy kontroli dostępu podczas setAccessControlRecursive, updateAccessControlRecursive i removeAccessControlRecursive.
AccessControlChanges

AccessControlChanges zawiera wsadowe i skumulowane liczby operacji, które zmieniają listy kontroli dostępu cyklicznie. Ponadto uwidacznia wpisy ścieżki, których nie można zaktualizować podczas wykonywania tych operacji.
AccessPolicy
AccountSASSignatureValues

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

AccountSASSignatureValues służy do generowania sygnatury dostępu współdzielonego (SAS) dla konta usługi Azure Storage. Po odpowiednim ustawieniu wszystkich wartości wywołaj generateAccountSASQueryParameters, aby uzyskać reprezentację sygnatury dostępu współdzielonego, która może być faktycznie stosowana do adresów URL usługi Data Lake. Uwaga: zarówno ta klasa, jak i sasQueryParameters istnieją, ponieważ były jest modyfikowalny i reprezentacja logiczna, podczas gdy drugi jest niezmienny i używany do generowania rzeczywistych żądań REST.

Zobacz https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1, aby uzyskać więcej informacji koncepcyjnych na temat sygnatury dostępu współdzielonego zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas opisy parametrów, w tym wymagane
BlobHierarchyListSegment
BlobItemModel

Obiekt blob usługi Azure Storage
BlobPrefix
BlobPropertiesModel

Właściwości obiektu blob
CommonGenerateSasUrlOptions

Typowe opcje FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions i FileGenerateSasUrlOptions.
CommonOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
CpkInfo

Grupa parametrów
DataLakeRequestConditions

Grupa parametrów
DataLakeSASSignatureValues

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Funkcja DataLakeSASSignatureValues ułatwia generowanie tokenów SAS usługi Blob i DataLake dla kontenerów, obiektów blob, systemu plików, katalogów i plików.
DataLakeServiceProperties

Właściwości usługi Storage.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
DirectoryCreateIfNotExistsResponse

Zawiera dane odpowiedzi dla operacji createIfNotExists.
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Opcje konfigurowania generateSasUrl operacji.
FileAppendOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileCreateIfNotExistsOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileCreateIfNotExistsResponse

Zawiera dane odpowiedzi dla operacji createIfNotExists.
FileCreateOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileCreateResponse
FileFlushOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileGenerateSasUrlOptions

Opcje konfigurowania generateSasUrl operacji.
FileParallelUploadOptions

Interfejs opcji dla pliku usługi Data Lake — operacje przekazywania

Widzieć:
FileQueryCsvTextConfiguration

Opcje wykonywania zapytań dotyczących pliku w formacie CSV.
FileQueryError

Typ błędu kwerendy pliku.
FileQueryJsonTextConfiguration

Opcje wykonywania zapytań dotyczących pliku w formacie JSON.
FileQueryOptions

Interfejs opcji dla pliku usługi Data Lake — operacje zapytań

Widzieć:
FileQueryParquetConfiguration

Opcje wykonywania zapytań dotyczących pliku w formacie Parquet.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Interfejs opcji dla pliku usługi Data Lake — operacje readToBuffer

Widzieć:
FileSetExpiryHeaders

Definiuje nagłówki dla operacji Path_setExpiry.
FileSetExpiryOptions

Interfejs opcji dla operacji setExpiry.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Zawiera dane odpowiedzi dla operacji createIfNotExists.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Zawiera dane odpowiedzi dla operacji deleteIfExists.
FileSystemDeleteOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileSystemEncryptionScope

Opcje określania zakresu szyfrowania w systemie plików.
FileSystemExistsOptions

Interfejs opcji dla systemu plików usługi Data Lake istnieje operacje

Widzieć:
FileSystemGenerateSasUrlOptions

Opcje konfigurowania generateSasUrl operacji.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Definiuje nagłówki dla operacji FileSystem_listBlobHierarchySegment.
FileSystemListPathsHeaders

Definiuje nagłówki dla operacji FileSystem_listPaths.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
FileSystemUndeletePathOption

Interfejs dla opcji typowych dla każdej operacji zdalnej.
HttpHeaders

Kolekcja par klucz/wartość nagłówka HTTP.
HttpOperationResponse

Odpowiedź HTTP zgodna z core-v1(core-http).
IHttpClient

Zgodny interfejs zasad żądań core-http
Lease

Szczegóły określonej dzierżawy.
LeaseAccessConditions

Grupa parametrów
LeaseOperationOptions

Konfiguruje operacje dzierżawy.
ListBlobsHierarchySegmentResponse

Wyliczenie obiektów blob
ListDeletedPathsOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
ListDeletedPathsSegmentOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
ListFileSystemsSegmentResponse
ListPathsOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
ListPathsSegmentOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Definiuje nagłówki dla operacji Path_appendData.
PathChangeAccessControlRecursiveOptions

Typ opcji dla setAccessControlRecursive, updateAccessControlRecursive i removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Typ odpowiedzi dla setAccessControlRecursive, updateAccessControlRecursive i removeAccessControlRecursive.
PathCreateHeaders

Definiuje nagłówki dla operacji Path_create.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathCreateIfNotExistsResponse

Zawiera dane odpowiedzi dla operacji createIfNotExists.
PathCreateOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathDeleteHeaders

Definiuje nagłówki dla operacji Path_delete.
PathDeleteIfExistsResponse

Zawiera dane odpowiedzi dla operacji deleteIfExists.
PathDeleteOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathExistsOptions

Interfejs opcji dla operacji katalogu/pliku usługi Data Lake

Widzieć:
PathFlushDataHeaders

Definiuje nagłówki dla operacji Path_flushData.
PathGetAccessControlHeaders
PathGetAccessControlOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Definiuje nagłówki dla operacji Path_getProperties.
PathGetPropertiesOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Definiuje nagłówki dla operacji Path_setAccessControl.
PathSetAccessControlOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathSetMetadataHeaders
PathSetMetadataOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathSetPermissionsOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
PathUndeleteHeaders

Definiuje nagłówki dla operacji Path_undelete.
PathUpdateHeaders

Definiuje nagłówki dla operacji Path_update.
PipelineLike

Interfejs klasy potoku zawierający zasady żądań HTTP. Możesz utworzyć domyślny potok, wywołując newPipeline. Możesz też utworzyć potok przy użyciu własnych zasad przez konstruktor potoku.

Przed wdrożeniem dostosowanego potoku zapoznaj się z tematem newPipeline i podano zasady.
PipelineOptions

Interfejs opcji konstruktora potoku.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicyFactory

Interfejs umożliwiający zgodność z elementem RequestPolicyFactory core-http
RequestPolicyOptions

Interfejs umożliwiający zgodność z zasadami RequestPolicy
RolePermissions
SASQueryParametersOptions

Opcje konstruowania SASQueryParameters.
SasIPRange

Dozwolony zakres adresów IP dla sygnatury dostępu współdzielonego.
ServiceClientOptions

Podzestaw @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions

Opcje konfigurowania operacji generowania generateAccountSasUrl.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

Interfejs dla opcji typowych dla każdej operacji zdalnej.
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Opcje konfigurowania undeleteFileSystem.
SignedIdentifier
StoragePipelineOptions

Interfejs opcji dla funkcji newPipeline.
StorageRetryOptions

Interfejs opcji ponawiania prób obiektu blob usługi Storage.
UserDelegationKey
UserDelegationKeyModel

Klucz delegowania użytkownika
WebResource

Opis żądania HTTP, który ma zostać złożony na serwerze zdalnym.

Aliasy typu

AccessControlType
CopyStatusType
DataLakeServiceGetPropertiesResponse

Zawiera dane odpowiedzi dla operacji getProperties.
EncryptionAlgorithmType

Definiuje wartości encryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> można używać zamiennie z algorytmem EncryptionAlgorithmType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Brak
AES256
FileAppendResponse
FileExpiryMode

Definiuje wartości parametru PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration

Opcje wykonywania zapytań o plik w formacie Apache Arrow. Tylko prawidłowe dla outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Zawiera dane odpowiedzi dla operacji <xref:DataLakeServiceClient.renameFileSystem>.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Zawiera dane odpowiedzi dla operacji undeleteFileSystem.
FileUploadResponse
HttpRequestBody

Typy ciał obsługiwanych na żądanie. NodeJS.ReadableStream i () => NodeJS.ReadableStream jest tylko węzłem. Obiekty blob, ReadableStream i () => ReadableStream są tylko przeglądarką.
LeaseDurationType
LeaseOperationResponse

Zawiera dane odpowiedzi dla operacji, które tworzą, modyfikują lub usuwają dzierżawę.

Zobacz <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel

Definiuje wartości parametru PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Definiuje wartości parametru PathRenameMode.
PathResourceTypeModel

Definiuje wartości parametru PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

Zawiera dane odpowiedzi dla operacji listContainersSegment.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

Opcje konfigurowania <xref:DataLakeServiceClient.renameFileSystem>.

Wyliczenia

PathGetPropertiesAction

Definiuje wartości parametru PathGetPropertiesAction. Możliwe wartości to: "getAccessControl", "getStatus"
PathRenameMode

Definiuje wartości parametru PathRenameMode. Możliwe wartości to: "legacy", "posix"
PathResourceType

Definiuje wartości parametru PathResourceType. Możliwe wartości to: "katalog", "plik"
SASProtocol

Protokoły dla wygenerowanej sygnatury dostępu współdzielonego.
StorageDataLakeAudience

Definiuje znanych odbiorców chmury dla usługi Storage.
StorageRetryPolicyType

Typy RetryPolicy.

Funkcje

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Generuje obiekt SASQueryParameters zawierający wszystkie parametry zapytania SAS potrzebne do utworzenia rzeczywistego żądania REST.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy wystąpienie parametrów SASQueryParameters.

Akceptuje tylko wymagane ustawienia wymagane do utworzenia sygnatury dostępu współdzielonego. W przypadku ustawień opcjonalnych ustaw odpowiednie właściwości bezpośrednio, takie jak uprawnienia, startOn i identyfikator.

OSTRZEŻENIE: Jeśli nie podano identyfikatora, wymagane są uprawnienia i wygaśnięcieWłaściwej. Musisz przypisać wartość do identyfikatora lub wygaśnięćW & uprawnienia ręcznie, jeśli zostanie zainicjowany przy użyciu tego konstruktora.

Przed uruchomieniem poniższych fragmentów kodu wypełnij wymagane szczegóły.

Przykład

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Przed uruchomieniem fragmentu kodu wypełnij wymagane szczegóły.

Przykład

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy wystąpienie parametrów SASQueryParameters. OSTRZEŻENIE: identyfikator zostanie zignorowany podczas generowania sygnatury dostępu współdzielonego delegowania użytkownika, wymagane są uprawnienia i wygasanie.

Przykład

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
getDataLakeServiceAccountAudience(string)

Aby uzyskać odbiorców protokołu OAuth dla konta magazynu dla usługi datalake.
isPipelineLike(unknown)

Pomocnik do podjęcia decyzji, czy dany argument spełnia kontrakt potoku
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Tworzy nowy obiekt Potok z podanym poświadczenie.

Szczegóły funkcji

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Generuje obiekt SASQueryParameters zawierający wszystkie parametry zapytania SAS potrzebne do utworzenia rzeczywistego żądania REST.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

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

Parametry

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Zwraca

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy wystąpienie parametrów SASQueryParameters.

Akceptuje tylko wymagane ustawienia wymagane do utworzenia sygnatury dostępu współdzielonego. W przypadku ustawień opcjonalnych ustaw odpowiednie właściwości bezpośrednio, takie jak uprawnienia, startOn i identyfikator.

OSTRZEŻENIE: Jeśli nie podano identyfikatora, wymagane są uprawnienia i wygaśnięcieWłaściwej. Musisz przypisać wartość do identyfikatora lub wygaśnięćW & uprawnienia ręcznie, jeśli zostanie zainicjowany przy użyciu tego konstruktora.

Przed uruchomieniem poniższych fragmentów kodu wypełnij wymagane szczegóły.

Przykład

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Przed uruchomieniem fragmentu kodu wypełnij wymagane szczegóły.

Przykład

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parametry

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Zwraca

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy wystąpienie parametrów SASQueryParameters. OSTRZEŻENIE: identyfikator zostanie zignorowany podczas generowania sygnatury dostępu współdzielonego delegowania użytkownika, wymagane są uprawnienia i wygasanie.

Przykład

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Parametry

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Wartość zwracana blobServiceClient.getUserDelegationKey()

accountName

string

Zwraca

SASQueryParameters

getDataLakeServiceAccountAudience(string)

Aby uzyskać odbiorców protokołu OAuth dla konta magazynu dla usługi datalake.

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parametry

storageAccountName

string

Zwraca

string

isPipelineLike(unknown)

Pomocnik do podjęcia decyzji, czy dany argument spełnia kontrakt potoku

function isPipelineLike(pipeline: unknown): pipeline

Parametry

pipeline

unknown

Argument, który może być potokiem

Zwraca

pipeline

true, gdy argument spełnia kontrakt potoku

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Tworzy nowy obiekt Potok z podanym poświadczenie.

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

Parametry

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

pipelineOptions
StoragePipelineOptions

Fakultatywny. Opcje.

Zwraca

Pipeline

Nowy obiekt Pipeline.