DataLakePathClient class

Pakiet:

@azure/storage-file-datalake

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

Extends

StorageClient

Konstruktory

DataLakePathClient(string, Pipeline)	Tworzy wystąpienie elementu DataLakePathClient na podstawie adresu URL i potoku.
DataLakePathClient(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 w @azure/identity celu uwierzytelnienia żą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	Zakodowana wartość ciągu adresu URL.

Metody

create(PathResourceTypeModel, PathCreateOptions)	Utwórz katalog lub ścieżkę. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Utwórz katalog lub plik. Jeśli zasób już istnieje, nie zostanie on zmieniony. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
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 obiekt, który DataLakeLeaseClient zarządza dzierżawami w ścieżce (katalogu lub pliku).
getProperties(PathGetPropertiesOptions)	Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla ścieżki (katalogu lub pliku). OSTRZEŻENIE: metadata Obiekt zwrócony w odpowiedzi będzie miał swoje klucze małymi literami, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metody DataLakeFileSystemClient tej ścieżki listy przy użyciu includeMetadata opcji , 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 Access Control w ścieżce ścieżki i pod ścieżce. 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 Access Control na ścieżce ścieżki i pod ścieżce. 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 (katalogu lub pliku). Jeśli żadna wartość nie zostanie podana lub żadna wartość nie zostanie 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 w ś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 Access Control na ścieżce i ścieżkach podrzędnych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Szczegóły konstruktora

DataLakePathClient(string, Pipeline)

Tworzy wystąpienie elementu DataLakePathClient na podstawie adresu URL i potoku.

new DataLakePathClient(url: string, pipeline: Pipeline)

Parametry

url

string

Ciąg klienta wskazujący ścieżkę typu data lake usługi Azure Storage (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 używasz elementu AnonymousCredential, takiego jak "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

pipeline

Pipeline

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

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

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

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

Parametry

url

string

Ciąg klienta wskazujący ścieżkę typu data lake usługi Azure Storage (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 używasz elementu AnonymousCredential, takiego jak "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity celu uwierzytelnienia żą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

Opcjonalny. 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 zstorageClient.accountName

credential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity celu uwierzytelnienia żą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 zelementu StorageClient.credential

url

Zakodowana wartość ciągu adresu URL.

url: string

Wartość właściwości

string

Dziedziczone zelementu StorageClient.url

Szczegóły metody

create(PathResourceTypeModel, PathCreateOptions)

Utwórz katalog lub ścieżkę.

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, "katalog" lub "plik".

options

PathCreateOptions

Opcjonalny. Opcje podczas tworzenia ścieżki.

Zwraca

Promise<PathCreateResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Utwórz katalog lub plik. Jeśli zasób już istnieje, nie zostanie on zmieniony.

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, "katalog" lub "plik".

options

PathCreateIfNotExistsOptions

Zwraca

Promise<PathCreateIfNotExistsResponse>

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

Opcjonalny. Opcje podczas usuwania ścieżki.

Zwraca

Promise<PathDeleteResponse>

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>

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>

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

Opcjonalny. Opcje podczas pobierania kontroli dostępu do plików.

Zwraca

Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient(string)

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametry

proposeLeaseId

string

Opcjonalny. Początkowy identyfikator proponowanej dzierżawy.

Zwraca

DataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla ścieżki (katalogu lub pliku). OSTRZEŻENIE: metadata Obiekt zwrócony w odpowiedzi będzie miał swoje klucze małymi literami, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metody DataLakeFileSystemClient tej ścieżki listy przy użyciu includeMetadata opcji , 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

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

Zwraca

Promise<PathGetPropertiesResponse>

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

Ścieżka katalogu docelowego, na przykład "katalog" lub ścieżka pliku "directory/file". Jeśli element 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

Opcjonalny. Opcje podczas przenoszenia katalogu lub pliku.

Zwraca

Promise<PathMoveResponse>

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 "system plików".

destinationPath

string

Ścieżka katalogu docelowego, na przykład "katalog" lub ścieżka pliku "directory/file", 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 "directory/file?sasToken".

options

PathMoveOptions

Opcjonalny. Opcje podczas przenoszenia katalogu lub pliku.

Zwraca

Promise<PathMoveResponse>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Usuwa Access Control w ścieżce ścieżki i pod ścieżce.

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

Opcjonalny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>

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

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

Zwraca

Promise<PathSetAccessControlResponse>

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Ustawia Access Control na ścieżce ścieżki i pod ścieżce.

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

Opcjonalny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Ustawia właściwości systemu na ścieżce (katalogu lub pliku). Jeśli żadna wartość nie zostanie podana lub żadna wartość nie zostanie 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>

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

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

options

PathSetMetadataOptions

Opcjonalny. Opcje podczas ustawiania metadanych ścieżki.

Zwraca

Promise<PathSetMetadataResponse>

setPermissions(PathPermissions, PathSetPermissionsOptions)

Ustawia uprawnienia do pliku w ścieżce.

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

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

Parametry

permissions

PathPermissions

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

options

PathSetPermissionsOptions

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

Zwraca

Promise<PathSetAccessControlResponse>

toDirectoryClient()

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

function toDirectoryClient(): DataLakeDirectoryClient

Zwraca

DataLakeDirectoryClient

toFileClient()

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

function toFileClient(): DataLakeFileClient

Zwraca

DataLakeFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Modyfikuje Access Control na ś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

Opcjonalny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>