DataLakeDirectoryClient class
En DataLakeDirectoryClient representerar en URL till Azure Storage-katalogen.
- Extends
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 autentiseringsuppgifter från paketet för att autentisera |
| url | Kodat URL-strängvärde. |
Metoder
Ärvda metoder
Konstruktorinformation
DataLakeDirectoryClient(string, Pipeline)
Skapar en instans av DataLakePathClient från URL och pipeline.
new DataLakeDirectoryClient(url: string, pipeline: Pipeline)Parametrar
- url
-
string
En klientsträng som pekar på Sökvägen till Azure Storage-datasjön (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.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Skapar en instans av DataLakePathClient från URL och autentiseringsuppgifter.
new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Parametrar
- url
-
string
En klientsträng som pekar på Sökvägen till Azure Storage-datasjön (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 autentiseringsuppgifter från paketet för att autentisera @azure/identity 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
Valfritt. 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
credential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity 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ånDataLakePathClient.credential
url
Metodinformation
create(DirectoryCreateOptions)
Skapa en katalog.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>Parametrar
- options
- DirectoryCreateOptions
Valfritt. Alternativ när du skapar katalogen.
Returer
Promise<DirectoryCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
Skapa en katalog.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>Parametrar
- resourceType
- PathResourceTypeModel
Resurstyp måste vara "katalog" för DataLakeDirectoryClient.
- options
- PathCreateOptions
Valfritt. Alternativ när du skapar katalogen.
Returer
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Skapa en katalog om den inte redan finns.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>Parametrar
Returer
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
Skapa en katalog om den inte redan finns.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Parametrar
- resourceType
- PathResourceTypeModel
Resurstyp måste vara "katalog" för DataLakeDirectoryClient.
- options
- PathCreateIfNotExistsOptions
Returer
Promise<PathCreateIfNotExistsResponse>
generateSasUrl(DirectoryGenerateSasUrlOptions)
Endast tillgängligt för klienter som skapats med en autentiseringsuppgift med delad nyckel.
Genererar en SAS-URI (Service Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>Parametrar
- options
- DirectoryGenerateSasUrlOptions
Valfria parametrar.
Returer
Promise<string>
SAS-URI:n som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.
getFileClient(string)
Skapar ett DataLakeFileClient-objekt under den aktuella katalogen.
function getFileClient(fileName: string): DataLakeFileClientParametrar
- fileName
-
string
Returer
getSubdirectoryClient(string)
Skapar ett DataLakeDirectoryClient-objekt under den aktuella katalogen.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientParametrar
- subdirectoryName
-
string
Underkatalognamn.
Returer
Ärvd metodinformation
delete(boolean, PathDeleteOptions)
Ta bort aktuell sökväg (katalog eller fil).
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>Parametrar
- recursive
-
boolean
Obligatoriskt och giltigt endast när resursen är en katalog. Om det är "sant" tas alla sökvägar under katalogen bort.
- options
- PathDeleteOptions
Valfritt. Alternativ vid borttagning av sökväg.
Returer
Promise<PathDeleteResponse>
Ärvd frånDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Ta bort aktuell sökväg (katalog eller fil) om den finns.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>Parametrar
- recursive
-
boolean
Obligatoriskt och giltigt endast när resursen är en katalog. Om det är "sant" tas alla sökvägar under katalogen bort.
- options
- PathDeleteOptions
Returer
Promise<PathDeleteIfExistsResponse>
Ärvd frånDataLakePathClient.deleteIfExists
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. Tvärtom kan nya filer 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>
Ärvd frånDataLakePathClient.exists
getAccessControl(PathGetAccessControlOptions)
Returnerar åtkomstkontrolldata för en sökväg (filkatalog).
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>Parametrar
- options
- PathGetAccessControlOptions
Valfritt. Alternativ när du hämtar filåtkomstkontroll.
Returer
Promise<PathGetAccessControlResponse>
Ärvd frånDataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Hämta en DataLakeLeaseClient som hanterar lån på sökvägen (katalog eller fil).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParametrar
- proposeLeaseId
-
string
Valfritt. 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! Objektet metadata 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 i DataLakeFileSystemClient som listar sökvägar med hjälp av includeMetadata alternativet, vilket behåller deras ursprungliga hölje.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Parametrar
- options
- PathGetPropertiesOptions
Valfritt. Alternativ när du hämtar sökvägsegenskaper.
Returer
Promise<PathGetPropertiesResponse>
Ärvd frånDataLakePathClient.getProperties
move(string, PathMoveOptions)
Flytta katalog eller fil i samma filsystem.
Se https://docs.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
Valfritt. Alternativ när du flyttar katalog eller fil.
Returer
Promise<PathMoveResponse>
Ärvd frånDataLakePathClient.move
move(string, string, PathMoveOptions)
Flytta katalog eller fil till ett annat filsystem.
Se https://docs.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
Valfritt. Alternativ när du flyttar katalog eller fil.
Returer
Promise<PathMoveResponse>
Ärvd frånDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Tar bort Access Control på en sökväg och undersökvägar.
Se https://docs.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.
Valfritt. Alternativ
Returer
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Ange åtkomstkontrolldata för en sökväg (filkatalog).
Se https://docs.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
Valfritt. Alternativ när du anger åtkomstkontroll för sökväg.
Returer
Promise<PathSetAccessControlResponse>
Ärvd frånDataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Anger Access Control på en sökväg och undersökvägar.
Se https://docs.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.
Valfritt. 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-huvudena för bloben, rensas dessa HTTP-blobhuvuden utan värde.
Se https://docs.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>
Ärvd frånDataLakePathClient.setHttpHeaders
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 inga metadata definierats i parametern tas sökvägsmetadata bort.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>Parametrar
- metadata
- Metadata
Valfritt. Ersätt befintliga metadata med det här värdet. Om inget värde anges tas befintliga metadata bort.
- options
- PathSetMetadataOptions
Valfritt. Alternativ när du anger sökvägsmetadata.
Returer
Promise<PathSetMetadataResponse>
Ärvd frånDataLakePathClient.setMetadata
setPermissions(PathPermissions, PathSetPermissionsOptions)
Anger filbehörigheter på en sökväg.
Se https://docs.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
Valfritt. Alternativ när du anger sökvägsbehörigheter.
Returer
Promise<PathSetPermissionsResponse>
Ärvd frånDataLakePathClient.setPermissions
toDirectoryClient()
Konvertera aktuell DataLakePathClient till DataLakeDirectoryClient om den aktuella sökvägen är en katalog.
function toDirectoryClient(): DataLakeDirectoryClientReturer
Ärvd frånDataLakePathClient.toDirectoryClient
toFileClient()
Konvertera aktuell DataLakePathClient till DataLakeFileClient om den aktuella sökvägen är en fil.
function toFileClient(): DataLakeFileClientReturer
Ärvd frånDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Ändrar Access Control på en sökväg och undersökvägar.
Se https://docs.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.
Valfritt. Alternativ