DataLakePathClient class

Pakket:

@azure/storage-file-datalake

Een DataLakePathClient vertegenwoordigt een URL naar het Azure Storage-pad (map of bestand).

Extends

StorageClient

Constructors

DataLakePathClient(string, Pipeline)	Hiermee maakt u een exemplaar van DataLakePathClient op basis van DE URL en pijplijn.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Hiermee maakt u een exemplaar van DataLakePathClient op basis van URL en referentie.

Eigenschappen

fileSystemName	Naam van het huidige bestandssysteem.
name	Naam van het huidige pad (map of bestand).

Overgenomen eigenschappen

accountName
credential	Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
url	Gecodeerde URL-tekenreekswaarde.

Methoden

create(PathResourceTypeModel, PathCreateOptions)	Maak een map of pad. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Maak een map of bestand. Als de resource al bestaat, wordt deze niet gewijzigd. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)	Verwijder het huidige pad (map of bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Verwijder het huidige pad (map of bestand) als dit bestaat. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Retourneert true als het Data Lake-bestand dat wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie zorgvuldig, omdat een bestaand bestand kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe bestanden worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
getAccessControl(PathGetAccessControlOptions)	Retourneert de toegangsbeheergegevens voor een pad (map van het bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Haal een DataLakeLeaseClient op waarmee leases op het pad (map of bestand) worden beheerd.
getProperties(PathGetPropertiesOptions)	Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het pad (map of bestand). WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, heeft de sleutels in kleine letters, zelfs als deze oorspronkelijk hoofdletters bevatten. Dit wijkt af van de metagegevenssleutels die worden geretourneerd door de methoden van DataLakeFileSystemClient die lijstpaden met behulp van de includeMetadata optie, die hun oorspronkelijke hoofdletters behouden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Map of bestand binnen hetzelfde bestandssysteem verplaatsen. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Map of bestand verplaatsen naar een ander bestandssysteem. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Hiermee verwijdert u de Access Control op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Stel de toegangsbeheergegevens in voor een pad (map van het bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Hiermee stelt u de Access Control op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Hiermee stelt u systeemeigenschappen in op het pad (map of bestand). Als er geen waarde is opgegeven of als er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor het opgegeven pad (map van het bestand) in als een of meer naam-waardeparen. Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van het pad verwijderd. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Hiermee stelt u de bestandsmachtigingen voor een pad in. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Converteer de huidige DataLakePathClient naar DataLakeDirectoryClient als het huidige pad een map is.
toFileClient()	Converteer de huidige DataLakePathClient naar DataLakeFileClient als het huidige pad een bestand is.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Hiermee wijzigt u de Access Control op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Constructordetails

DataLakePathClient(string, Pipeline)

Hiermee maakt u een exemplaar van DataLakePathClient op basis van DE URL en pijplijn.

new DataLakePathClient(url: string, pipeline: Pipeline)

Parameters

url

string

Een clienttekenreeks die verwijst naar het Azure Storage Data Lake-pad (map of bestand), zoals 'https://myaccount.dfs.core.windows.net/filesystem/directory" of "https://myaccount.dfs.core.windows.net/filesystem/file". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

pipeline

Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.

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

Hiermee maakt u een exemplaar van DataLakePathClient op basis van URL en referentie.

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

Parameters

url

string

Een clienttekenreeks die verwijst naar het Azure Storage Data Lake-pad (map of bestand), zoals 'https://myaccount.dfs.core.windows.net/filesystem/directory" of "https://myaccount.dfs.core.windows.net/filesystem/file". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options

StoragePipelineOptions

Optioneel. Opties voor het configureren van de HTTP-pijplijn.

Eigenschapdetails

fileSystemName

Naam van het huidige bestandssysteem.

string fileSystemName

Waarde van eigenschap

string

name

Naam van het huidige pad (map of bestand).

string name

Waarde van eigenschap

string

Details van overgenomen eigenschap

accountName

accountName: string

Waarde van eigenschap

string

Overgenomen vanStorageClient.accountName

credential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Overgenomen vanStorageClient.credential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

Overgenomen vanStorageClient.url

Methodedetails

create(PathResourceTypeModel, PathCreateOptions)

Maak een map of pad.

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

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

Parameters

resourceType

PathResourceTypeModel

Resourcetype, 'map' of 'bestand'.

options

PathCreateOptions

Optioneel. Opties bij het maken van een pad.

Retouren

Promise<PathCreateResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Maak een map of bestand. Als de resource al bestaat, wordt deze niet gewijzigd.

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

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

Parameters

resourceType

PathResourceTypeModel

Resourcetype, 'map' of 'bestand'.

options

PathCreateIfNotExistsOptions

Retouren

Promise<PathCreateIfNotExistsResponse>

delete(boolean, PathDeleteOptions)

Verwijder het huidige pad (map of bestand).

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

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

Parameters

recursive

boolean

Vereist en alleen geldig als de resource een map is. Als 'waar' is, worden alle paden onder de map verwijderd.

options

PathDeleteOptions

Optioneel. Opties bij het verwijderen van het pad.

Retouren

Promise<PathDeleteResponse>

deleteIfExists(boolean, PathDeleteOptions)

Verwijder het huidige pad (map of bestand) als dit bestaat.

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

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

Parameters

recursive

boolean

Vereist en alleen geldig als de resource een map is. Als 'waar' is, worden alle paden onder de map verwijderd.

options

PathDeleteOptions

Retouren

Promise<PathDeleteIfExistsResponse>

exists(PathExistsOptions)

Retourneert true als het Data Lake-bestand dat wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie zorgvuldig, omdat een bestaand bestand kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe bestanden worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.

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

Parameters

options

PathExistsOptions

opties voor de bewerking Exists.

Retouren

Promise<boolean>

getAccessControl(PathGetAccessControlOptions)

Retourneert de toegangsbeheergegevens voor een pad (map van het bestand).

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

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

Parameters

options

PathGetAccessControlOptions

Optioneel. Opties bij het verkrijgen van toegangsbeheer voor bestanden.

Retouren

Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient(string)

Haal een DataLakeLeaseClient op waarmee leases op het pad (map of bestand) worden beheerd.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameters

proposeLeaseId

string

Optioneel. Initiële voorgestelde lease-id.

Retouren

DataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het pad (map of bestand). WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, heeft de sleutels in kleine letters, zelfs als deze oorspronkelijk hoofdletters bevatten. Dit wijkt af van de metagegevenssleutels die worden geretourneerd door de methoden van DataLakeFileSystemClient die lijstpaden met behulp van de includeMetadata optie, die hun oorspronkelijke hoofdletters behouden.

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

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

Parameters

options

PathGetPropertiesOptions

Optioneel. Opties bij het ophalen van padeigenschappen.

Retouren

Promise<PathGetPropertiesResponse>

move(string, PathMoveOptions)

Map of bestand binnen hetzelfde bestandssysteem verplaatsen.

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

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

Parameters

destinationPath

string

Doelmappad, zoals 'map' of bestandspad 'map/bestand'. Als destinationPath is geverifieerd met SAS, voegt u de SAS toe aan het doelpad, zoals 'map/bestand?sasToken'.

options

PathMoveOptions

Optioneel. Opties bij het verplaatsen van een map of bestand.

Retouren

Promise<PathMoveResponse>

move(string, string, PathMoveOptions)

Map of bestand verplaatsen naar een ander bestandssysteem.

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

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

Parameters

destinationFileSystem

string

Doelbestandssysteem, zoals 'bestandssysteem'.

destinationPath

string

Doelmappad zoals 'map' of bestandspad 'map/bestand' Als het destinationPath is geverifieerd met SAS, voegt u de SAS toe aan het doelpad, zoals 'directory/file?sasToken'.

options

PathMoveOptions

Optioneel. Opties bij het verplaatsen van een map of bestand.

Retouren

Promise<PathMoveResponse>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Hiermee verwijdert u de Access Control op een pad en subpaden.

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

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

Parameters

acl

RemovePathAccessControlItem[]

De POSIX-toegangsbeheerlijst voor het bestand of de map.

options

PathChangeAccessControlRecursiveOptions

Optioneel. Opties

Retouren

Promise<PathChangeAccessControlRecursiveResponse>

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Stel de toegangsbeheergegevens in voor een pad (map van het bestand).

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

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

Parameters

acl

PathAccessControlItem[]

De POSIX-toegangsbeheerlijst voor het bestand of de map.

options

PathSetAccessControlOptions

Optioneel. Opties bij het instellen van toegangsbeheer voor paden.

Retouren

Promise<PathSetAccessControlResponse>

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Hiermee stelt u de Access Control op een pad en subpaden.

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

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

Parameters

acl

PathAccessControlItem[]

De POSIX-toegangsbeheerlijst voor het bestand of de map.

options

PathChangeAccessControlRecursiveOptions

Optioneel. Opties

Retouren

Promise<PathChangeAccessControlRecursiveResponse>

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Hiermee stelt u systeemeigenschappen in op het pad (map of bestand). Als er geen waarde is opgegeven of als er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist.

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

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

Parameters

httpHeaders

PathHttpHeaders

options

PathSetHttpHeadersOptions

Retouren

Promise<PathSetHttpHeadersResponse>

setMetadata(Metadata, PathSetMetadataOptions)

Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor het opgegeven pad (map van het bestand) in als een of meer naam-waardeparen. Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van het pad verwijderd.

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

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

Parameters

metadata

Metadata

Optioneel. Vervang bestaande metagegevens door deze waarde. Als er geen waarde is opgegeven, worden de bestaande metagegevens verwijderd.

options

PathSetMetadataOptions

Optioneel. Opties bij het instellen van padmetagegevens.

Retouren

Promise<PathSetMetadataResponse>

setPermissions(PathPermissions, PathSetPermissionsOptions)

Hiermee stelt u de bestandsmachtigingen voor een pad in.

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

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

Parameters

permissions

PathPermissions

De POSIX-toegangsmachtigingen voor de bestandseigenaar, de groep die eigenaar is van het bestand en andere.

options

PathSetPermissionsOptions

Optioneel. Opties bij het instellen van padmachtigingen.

Retouren

Promise<PathSetAccessControlResponse>

toDirectoryClient()

Converteer de huidige DataLakePathClient naar DataLakeDirectoryClient als het huidige pad een map is.

function toDirectoryClient(): DataLakeDirectoryClient

Retouren

DataLakeDirectoryClient

toFileClient()

Converteer de huidige DataLakePathClient naar DataLakeFileClient als het huidige pad een bestand is.

function toFileClient(): DataLakeFileClient

Retouren

DataLakeFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Hiermee wijzigt u de Access Control op een pad en subpaden.

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

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

Parameters

acl

PathAccessControlItem[]

De POSIX-toegangsbeheerlijst voor het bestand of de map.

options

PathChangeAccessControlRecursiveOptions

Optioneel. Opties

Retouren

Promise<PathChangeAccessControlRecursiveResponse>