DataLakeDirectoryClient class

Pakiet:

@azure/storage-file-datalake

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

Rozszerzenie

DataLakePathClient

Konstruktory

DataLakeDirectoryClient(string, Pipeline)	Tworzy wystąpienie elementu DataLakePathClient z adresu URL i potoku.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Tworzy wystąpienie elementu DataLakePathClient na podstawie adresu URL i poświadczeń.

Właściwości

fileSystemName	Nazwa bieżącego systemu plików.
name	Nazwa bieżącej ścieżki (katalogu lub pliku).

Właściwości dziedziczone

accountName
credential	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.
url	Wartość zakodowanego ciągu adresu URL.

Metody

create(DirectoryCreateOptions)	Utwórz katalog. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
create(PathResourceTypeModel, PathCreateOptions)	Utwórz katalog. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(DirectoryCreateIfNotExistsOptions)	Utwórz katalog, jeśli jeszcze nie istnieje. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Utwórz katalog, jeśli jeszcze nie istnieje. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
generateSasStringToSign(DirectoryGenerateSasUrlOptions)	Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(DirectoryGenerateSasUrlOptions)	Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)	Generuje ciąg do podpisania identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych w sygnaturze dostępu współdzielonego jest podpisany przez wejściowy klucz delegowania użytkownika. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)	Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez wejściowy klucz delegowania użytkownika. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getFileClient(string)	Tworzy obiekt DataLakeFileClient w bieżącym katalogu.
getSubdirectoryClient(string)	Tworzy obiekt DataLakeDirectoryClient w bieżącym katalogu.

Metody dziedziczone

delete(boolean, PathDeleteOptions)	Usuń bieżącą ścieżkę (katalog lub plik). Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Usuń bieżącą ścieżkę (katalog lub plik), jeśli istnieje. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Zwraca wartość true, jeśli plik usługi Data Lake reprezentowany przez tego klienta istnieje; w przeciwnym razie wartość false. UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący plik może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe pliki mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.
getAccessControl(PathGetAccessControlOptions)	Zwraca dane kontroli dostępu dla ścieżki (katalogu pliku). Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Pobierz DataLakeLeaseClient, który zarządza dzierżawami w ścieżce (katalogu lub pliku).
getProperties(PathGetPropertiesOptions)	Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla ścieżki (katalogu lub pliku). OSTRZEŻENIE: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metody DataLakeFileSystemClient, że ścieżki listy przy użyciu opcji includeMetadata, która zachowa oryginalną wielkość liter. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Przenieś katalog lub plik w tym samym systemie plików. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Przenieś katalog lub plik do innego systemu plików. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Usuwa kontrolę dostępu w ścieżce i ścieżkach podrzędnych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Ustaw dane kontroli dostępu dla ścieżki (katalogu pliku). Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Ustawia kontrolę dostępu na ścieżce i ścieżkach podrzędnych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Ustawia właściwości systemu na ścieżce (katalog lub plik). Jeśli żadna wartość nie zostanie podana lub żadna wartość podana dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Ustawia metadane zdefiniowane przez użytkownika dla określonej ścieżki (katalogu pliku) jako co najmniej jedną parę nazwa-wartość. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane ścieżki zostaną usunięte. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Ustawia uprawnienia do pliku na ścieżce. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Przekonwertuj bieżący element DataLakePathClient na element DataLakeDirectoryClient, jeśli bieżąca ścieżka jest katalogiem.
toFileClient()	Przekonwertuj bieżący element DataLakePathClient na element DataLakeFileClient, jeśli bieżąca ścieżka jest plikiem.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Modyfikuje kontrolę dostępu w ścieżce i ścieżkach podrzędnych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Szczegóły konstruktora

DataLakeDirectoryClient(string, Pipeline)

Tworzy wystąpienie elementu DataLakePathClient z adresu URL i potoku.

new DataLakeDirectoryClient(url: string, pipeline: Pipeline)

Parametry

url

string

Ciąg klienta wskazujący ścieżkę usługi Azure Storage typu data lake (katalog lub plik), taką jak "https://myaccount.dfs.core.windows.net/filesystem/directory" lub "https://myaccount.dfs.core.windows.net/filesystem/file". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

pipeline

Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok lub podaj dostosowany potok.

DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Tworzy wystąpienie elementu DataLakePathClient na podstawie adresu URL i poświadczeń.

new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametry

url

string

Ciąg klienta wskazujący ścieżkę usługi Azure Storage typu data lake (katalog lub plik), taką jak "https://myaccount.dfs.core.windows.net/filesystem/directory" lub "https://myaccount.dfs.core.windows.net/filesystem/file". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

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.

options

StoragePipelineOptions

Fakultatywny. Opcje konfigurowania potoku HTTP.

Szczegóły właściwości

fileSystemName

Nazwa bieżącego systemu plików.

string fileSystemName

Wartość właściwości

string

name

Nazwa bieżącej ścieżki (katalogu lub pliku).

string name

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

accountName

accountName: string

Wartość właściwości

string

dziedziczone zDataLakePathClient.accountName

credential

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wartość właściwości

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

dziedziczone zDataLakePathClient.credential

url

Wartość zakodowanego ciągu adresu URL.

url: string

Wartość właściwości

string

dziedziczone zDataLakePathClient.url

Szczegóły metody

create(DirectoryCreateOptions)

Utwórz katalog.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>

Parametry

options

DirectoryCreateOptions

Fakultatywny. Opcje podczas tworzenia katalogu.

Zwraca

Promise<DirectoryCreateResponse>

create(PathResourceTypeModel, PathCreateOptions)

Utwórz katalog.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

Parametry

resourceType

PathResourceTypeModel

Typ zasobu musi mieć wartość "katalog" dla elementu DataLakeDirectoryClient.

options

PathCreateOptions

Fakultatywny. Opcje podczas tworzenia katalogu.

Zwraca

Promise<PathCreateResponse>

createIfNotExists(DirectoryCreateIfNotExistsOptions)

Utwórz katalog, jeśli jeszcze nie istnieje.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>

Parametry

options

DirectoryCreateIfNotExistsOptions

Zwraca

Promise<DirectoryCreateIfNotExistsResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Utwórz katalog, jeśli jeszcze nie istnieje.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

Parametry

resourceType

PathResourceTypeModel

Typ zasobu musi mieć wartość "katalog" dla elementu DataLakeDirectoryClient.

options

PathCreateIfNotExistsOptions

Zwraca

Promise<PathCreateIfNotExistsResponse>

generateSasStringToSign(DirectoryGenerateSasUrlOptions)

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych.

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

function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string

Parametry

options

DirectoryGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateSasUrl(DirectoryGenerateSasUrlOptions)

Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>

Parametry

options

DirectoryGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

Promise<string>

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)

Generuje ciąg do podpisania identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych w sygnaturze dostępu współdzielonego jest podpisany przez wejściowy klucz delegowania użytkownika.

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

function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametry

options

DirectoryGenerateSasUrlOptions

Parametry opcjonalne.

userDelegationKey

UserDelegationKey

Wartość zwracana blobServiceClient.getUserDelegationKey()

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez wejściowy klucz delegowania użytkownika.

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

function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parametry

options

DirectoryGenerateSasUrlOptions

Parametry opcjonalne.

userDelegationKey

UserDelegationKey

Wartość zwracana blobServiceClient.getUserDelegationKey()

Zwraca

Promise<string>

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

getFileClient(string)

Tworzy obiekt DataLakeFileClient w bieżącym katalogu.

function getFileClient(fileName: string): DataLakeFileClient

Parametry

fileName

string

Zwraca

DataLakeFileClient

getSubdirectoryClient(string)

Tworzy obiekt DataLakeDirectoryClient w bieżącym katalogu.

function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient

Parametry

subdirectoryName

string

Nazwa podkatalogu.

Zwraca

DataLakeDirectoryClient

Szczegóły metody dziedziczonej

delete(boolean, PathDeleteOptions)

Usuń bieżącą ścieżkę (katalog lub plik).

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

Parametry

recursive

boolean

Wymagane i prawidłowe tylko wtedy, gdy zasób jest katalogiem. Jeśli wartość "true", wszystkie ścieżki poniżej katalogu zostaną usunięte.

options

PathDeleteOptions

Fakultatywny. Opcje podczas usuwania ścieżki.

Zwraca

Promise<PathDeleteResponse>

dziedziczone zDataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

Usuń bieżącą ścieżkę (katalog lub plik), jeśli istnieje.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

Parametry

recursive

boolean

Wymagane i prawidłowe tylko wtedy, gdy zasób jest katalogiem. Jeśli wartość "true", wszystkie ścieżki poniżej katalogu zostaną usunięte.

options

PathDeleteOptions

Zwraca

Promise<PathDeleteIfExistsResponse>

dziedziczone zDataLakePathClient.deleteIfExists

exists(PathExistsOptions)

Zwraca wartość true, jeśli plik usługi Data Lake reprezentowany przez tego klienta istnieje; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący plik może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe pliki mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

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

Parametry

options

PathExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

dziedziczone zDataLakePathClient.exists

getAccessControl(PathGetAccessControlOptions)

Zwraca dane kontroli dostępu dla ścieżki (katalogu pliku).

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

Parametry

options

PathGetAccessControlOptions

Fakultatywny. Opcje podczas uzyskiwania kontroli dostępu do plików.

Zwraca

Promise<PathGetAccessControlResponse>

dziedziczone zDataLakePathClient.getAccessControl

getDataLakeLeaseClient(string)

Pobierz DataLakeLeaseClient, który zarządza dzierżawami w ścieżce (katalogu lub pliku).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametry

proposeLeaseId

string

Fakultatywny. Początkowy proponowany identyfikator dzierżawy.

Zwraca

DataLakeLeaseClient

dziedziczone zDataLakePathClient.getDataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla ścieżki (katalogu lub pliku).

OSTRZEŻENIE: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metody DataLakeFileSystemClient, że ścieżki listy przy użyciu opcji includeMetadata, która zachowa oryginalną wielkość liter.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

Parametry

options

PathGetPropertiesOptions

Fakultatywny. Opcje podczas pobierania właściwości ścieżki.

Zwraca

Promise<PathGetPropertiesResponse>

dziedziczone zDataLakePathClient.getProperties

move(string, PathMoveOptions)

Przenieś katalog lub plik w tym samym systemie plików.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parametry

destinationPath

string

Docelowa ścieżka katalogu, na przykład "katalog" lub ścieżka pliku "katalog/plik". Jeśli parametr destinationPath jest uwierzytelniany przy użyciu sygnatury dostępu współdzielonego, dodaj sygnaturę dostępu współdzielonego do ścieżki docelowej, takiej jak "directory/file?sasToken".

options

PathMoveOptions

Fakultatywny. Opcje podczas przenoszenia katalogu lub pliku.

Zwraca

Promise<PathMoveResponse>

dziedziczone zDataLakePathClient.move

move(string, string, PathMoveOptions)

Przenieś katalog lub plik do innego systemu plików.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parametry

destinationFileSystem

string

Docelowy system plików, taki jak "filesystem".

destinationPath

string

Ścieżka katalogu docelowego, na przykład "katalog" lub ścieżka pliku "katalog/plik", jeśli ścieżka destinationPath jest uwierzytelniona przy użyciu sygnatury dostępu współdzielonego, dodaj sygnaturę dostępu współdzielonego do ścieżki docelowej, takiej jak "katalog/plik?sasToken".

options

PathMoveOptions

Fakultatywny. Opcje podczas przenoszenia katalogu lub pliku.

Zwraca

Promise<PathMoveResponse>

dziedziczone zDataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Usuwa kontrolę dostępu w ścieżce i ścieżkach podrzędnych.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parametry

acl

RemovePathAccessControlItem[]

Lista kontroli dostępu POSIX dla pliku lub katalogu.

options

PathChangeAccessControlRecursiveOptions

Fakultatywny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>

dziedziczone zDataLakePathClient.removeAccessControlRecursive

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Ustaw dane kontroli dostępu dla ścieżki (katalogu pliku).

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

Parametry

acl

PathAccessControlItem[]

Lista kontroli dostępu POSIX dla pliku lub katalogu.

options

PathSetAccessControlOptions

Fakultatywny. Opcje podczas ustawiania kontroli dostępu ścieżki.

Zwraca

Promise<PathSetAccessControlResponse>

dziedziczone zDataLakePathClient.setAccessControl

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Ustawia kontrolę dostępu na ścieżce i ścieżkach podrzędnych.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parametry

acl

PathAccessControlItem[]

Lista kontroli dostępu POSIX dla pliku lub katalogu.

options

PathChangeAccessControlRecursiveOptions

Fakultatywny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>

dziedziczone zDataLakePathClient.setAccessControlRecursive

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Ustawia właściwości systemu na ścieżce (katalog lub plik).

Jeśli żadna wartość nie zostanie podana lub żadna wartość podana dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

Parametry

httpHeaders

PathHttpHeaders

options

PathSetHttpHeadersOptions

Zwraca

Promise<PathSetHttpHeadersResponse>

dziedziczone zDataLakePathClient.setHttpHeaders

setMetadata(Metadata, PathSetMetadataOptions)

Ustawia metadane zdefiniowane przez użytkownika dla określonej ścieżki (katalogu pliku) jako co najmniej jedną parę nazwa-wartość.

Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane ścieżki zostaną usunięte.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

Parametry

metadata

Metadata

Fakultatywny. Zastąp istniejące metadane tą wartością. Jeśli żadna wartość nie zostanie podana, istniejące metadane zostaną usunięte.

options

PathSetMetadataOptions

Fakultatywny. Opcje podczas ustawiania metadanych ścieżki.

Zwraca

Promise<PathSetMetadataResponse>

dziedziczone zDataLakePathClient.setMetadata

setPermissions(PathPermissions, PathSetPermissionsOptions)

Ustawia uprawnienia do pliku na ścieżce.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

Parametry

permissions

PathPermissions

Uprawnienia dostępu do pliku POSIX dla właściciela pliku, grupy właściciela pliku i innych.

options

PathSetPermissionsOptions

Fakultatywny. Opcje podczas ustawiania uprawnień ścieżki.

Zwraca

Promise<PathSetPermissionsResponse>

dziedziczone zDataLakePathClient.setPermissions

toDirectoryClient()

Przekonwertuj bieżący element DataLakePathClient na element DataLakeDirectoryClient, jeśli bieżąca ścieżka jest katalogiem.

function toDirectoryClient(): DataLakeDirectoryClient

Zwraca

DataLakeDirectoryClient

dziedziczone zDataLakePathClient.toDirectoryClient

toFileClient()

Przekonwertuj bieżący element DataLakePathClient na element DataLakeFileClient, jeśli bieżąca ścieżka jest plikiem.

function toFileClient(): DataLakeFileClient

Zwraca

DataLakeFileClient

dziedziczone zDataLakePathClient.toFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Modyfikuje kontrolę dostępu w ścieżce i ścieżkach podrzędnych.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parametry

acl

PathAccessControlItem[]

Lista kontroli dostępu POSIX dla pliku lub katalogu.

options

PathChangeAccessControlRecursiveOptions

Fakultatywny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>

dziedziczone zDataLakePathClient.updateAccessControlRecursive