DataLakePathClient class
En DataLakePathClient representerar en URL till Azure Storage-sökvägen (katalog eller fil).
- Extends
-
StorageClient
Konstruktorer
| Data |
Skapar en instans av DataLakePathClient från URL och pipeline. |
| Data |
Skapar en instans av DataLakePathClient från URL och autentiseringsuppgifter. |
Egenskaper
| file |
Namnet på det aktuella filsystemet. |
| name | Namn på aktuell sökväg (katalog eller fil). |
Ärvda egenskaper
| account |
|
| credential | Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från |
| url | Kodat URL-strängvärde. |
Metoder
Konstruktorinformation
DataLakePathClient(string, Pipeline)
Skapar en instans av DataLakePathClient från URL och pipeline.
new DataLakePathClient(url: string, pipeline: Pipeline)Parametrar
- url
-
string
En klientsträng som pekar på Azure Storages datasjösökväg (katalog eller fil), till exempel "https://myaccount.dfs.core.windows.net/filesystem/directory" eller "https://myaccount.dfs.core.windows.net/filesystem/file". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- pipeline
- Pipeline
Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Skapar en instans av DataLakePathClient från URL och autentiseringsuppgifter.
new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Parametrar
- url
-
string
En klientsträng som pekar på Azure Storages datasjösökväg (katalog eller fil), till exempel "https://myaccount.dfs.core.windows.net/filesystem/directory" eller "https://myaccount.dfs.core.windows.net/filesystem/file". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
- options
- StoragePipelineOptions
Valfri. Alternativ för att konfigurera HTTP-pipelinen.
Egenskapsinformation
fileSystemName
Namnet på det aktuella filsystemet.
string fileSystemNameEgenskapsvärde
string
name
Namn på aktuell sökväg (katalog eller fil).
string nameEgenskapsvärde
string
Information om ärvda egenskaper
accountName
accountName: stringEgenskapsvärde
string
ärvd från StorageClient.accountName
credential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialEgenskapsvärde
ärvd från StorageClient.credential
url
Kodat URL-strängvärde.
url: stringEgenskapsvärde
string
ärvd från StorageClient.url
Metodinformation
create(PathResourceTypeModel, PathCreateOptions)
Skapa en katalog eller sökväg.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>Parametrar
- resourceType
- PathResourceTypeModel
Resurstyp, "katalog" eller "fil".
- options
- PathCreateOptions
Valfri. Alternativ när du skapar sökvägen.
Returer
Promise<PathCreateResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
Skapa en katalog eller fil. Om resursen redan finns ändras den inte.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Parametrar
- resourceType
- PathResourceTypeModel
Resurstyp, "katalog" eller "fil".
- options
- PathCreateIfNotExistsOptions
Returer
Promise<PathCreateIfNotExistsResponse>
delete(boolean, PathDeleteOptions)
Ta bort aktuell sökväg (katalog eller fil).
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>Parametrar
- recursive
-
boolean
Krävs och är endast giltigt när resursen är en katalog. Om "sant" tas alla sökvägar under katalogen bort.
- options
- PathDeleteOptions
Valfri. Alternativ vid borttagning av sökväg.
Returer
Promise<PathDeleteResponse>
deleteIfExists(boolean, PathDeleteOptions)
Ta bort den aktuella sökvägen (katalog eller fil) om den finns.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>Parametrar
- recursive
-
boolean
Krävs och är endast giltigt när resursen är en katalog. Om "sant" tas alla sökvägar under katalogen bort.
- options
- PathDeleteOptions
Returer
Promise<PathDeleteIfExistsResponse>
exists(PathExistsOptions)
Returnerar sant om Data Lake-filen som representeras av den här klienten finns. annars falskt.
Obs! Använd den här funktionen med försiktighet eftersom en befintlig fil kan tas bort av andra klienter eller program. Vice versa nya filer kan läggas till av andra klienter eller program när den här funktionen har slutförts.
function exists(options?: PathExistsOptions): Promise<boolean>Parametrar
- options
- PathExistsOptions
alternativ för åtgärden Finns.
Returer
Promise<boolean>
getAccessControl(PathGetAccessControlOptions)
Returnerar åtkomstkontrolldata för en sökväg (filkatalog).
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>Parametrar
- options
- PathGetAccessControlOptions
Valfri. Alternativ när du hämtar filåtkomstkontroll.
Returer
Promise<PathGetAccessControlResponse>
getDataLakeLeaseClient(string)
Hämta en DataLakeLeaseClient- som hanterar lån på sökvägen (katalog eller fil).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParametrar
- proposeLeaseId
-
string
Valfri. Ursprungligt föreslaget låne-ID.
Returer
getProperties(PathGetPropertiesOptions)
Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för sökvägen (katalog eller fil).
VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoderna för DataLakeFileSystemClient som listar sökvägar med hjälp av alternativet includeMetadata, som behåller sitt ursprungliga hölje.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Parametrar
- options
- PathGetPropertiesOptions
Valfri. Alternativ när du hämtar sökvägsegenskaper.
Returer
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions)
Flytta katalog eller fil i samma filsystem.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Parametrar
- destinationPath
-
string
Målkatalogsökväg som "katalog" eller filsökväg "katalog/fil". Om destinationPath autentiseras med SAS lägger du till SAS i målsökvägen som "directory/file?sasToken".
- options
- PathMoveOptions
Valfri. Alternativ när du flyttar katalog eller fil.
Returer
Promise<PathMoveResponse>
move(string, string, PathMoveOptions)
Flytta katalog eller fil till ett annat filsystem.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Parametrar
- destinationFileSystem
-
string
Målfilsystem som "filsystem".
- destinationPath
-
string
Målkatalogsökväg som "katalog" eller filsökväg "katalog/fil" Om destinationPath autentiseras med SAS lägger du till SAS i målsökvägen som "directory/file?sasToken".
- options
- PathMoveOptions
Valfri. Alternativ när du flyttar katalog eller fil.
Returer
Promise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Tar bort åtkomstkontrollen på en sökväg och undersökvägar.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parametrar
POSIX-åtkomstkontrollistan för filen eller katalogen.
Valfri. Alternativ
Returer
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Ange åtkomstkontrolldata för en sökväg (filkatalog).
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>Parametrar
- acl
POSIX-åtkomstkontrollistan för filen eller katalogen.
- options
- PathSetAccessControlOptions
Valfri. Alternativ när du anger åtkomstkontroll för sökväg.
Returer
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Anger åtkomstkontroll på en sökväg och undersökvägar.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parametrar
- acl
POSIX-åtkomstkontrollistan för filen eller katalogen.
Valfri. Alternativ
Returer
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Anger systemegenskaper på sökvägen (katalog eller fil).
Om inget värde anges, eller inget värde som angetts för de angivna HTTP-blobhuvudena, rensas dessa HTTP-blobhuvuden utan värde.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>Parametrar
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Returer
Promise<PathSetHttpHeadersResponse>
setMetadata(Metadata, PathSetMetadataOptions)
Anger användardefinierade metadata för den angivna sökvägen (filkatalogen) som ett eller flera namn/värde-par.
Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas sökvägens metadata bort.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>Parametrar
- metadata
- Metadata
Valfri. Ersätt befintliga metadata med det här värdet. Om inget värde anges tas befintliga metadata bort.
- options
- PathSetMetadataOptions
Valfri. Alternativ när du anger sökvägsmetadata.
Returer
Promise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions)
Anger filbehörigheter för en sökväg.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>Parametrar
- permissions
- PathPermissions
POSIX-åtkomstbehörigheterna för filägaren, filägargruppen och andra.
- options
- PathSetPermissionsOptions
Valfri. Alternativ när du anger sökvägsbehörigheter.
Returer
Promise<PathSetPermissionsResponse>
toDirectoryClient()
Konvertera aktuell DataLakePathClient till DataLakeDirectoryClient om den aktuella sökvägen är en katalog.
function toDirectoryClient(): DataLakeDirectoryClientReturer
toFileClient()
Konvertera aktuell DataLakePathClient till DataLakeFileClient om den aktuella sökvägen är en fil.
function toFileClient(): DataLakeFileClientReturer
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Ändrar åtkomstkontrollen på en sökväg och undersökvägar.
Se https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parametrar
- acl
POSIX-åtkomstkontrollistan för filen eller katalogen.
Valfri. Alternativ