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 eventuella autentiseringsuppgifter från |
url | Kodat URL-strängvärde. |
Metoder
Ärvda metoder
delete(boolean, Path |
Ta bort aktuell sökväg (katalog eller fil). Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
delete |
Ta bort den aktuella sökvägen (katalog eller fil) om den finns. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
exists(Path |
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. |
get |
Returnerar åtkomstkontrolldata för en sökväg (filkatalog). Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties |
get |
Hämta en DataLakeLeaseClient- som hanterar lån på sökvägen (katalog eller fil). |
get |
Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för sökvägen (katalog eller fil). VARNING! Det Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties |
move(string, Path |
Flytta katalog eller fil i samma filsystem. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
move(string, string, Path |
Flytta katalog eller fil till ett annat filsystem. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
remove |
Tar bort åtkomstkontrollen på en sökväg och undersökvägar. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
set |
Ange åtkomstkontrolldata för en sökväg (filkatalog). Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
set |
Anger åtkomstkontroll på en sökväg och undersökvägar. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
set |
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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
set |
Anger filbehörigheter för en sökväg. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
to |
Konvertera aktuell DataLakePathClient till DataLakeDirectoryClient om den aktuella sökvägen är en katalog. |
to |
Konvertera aktuell DataLakePathClient till DataLakeFileClient om den aktuella sökvägen är en fil. |
update |
Ändrar åtkomstkontrollen på en sökväg och undersökvägar. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
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å 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.
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å 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 fileSystemName
Egenskapsvärde
string
name
Namn på aktuell sökväg (katalog eller fil).
string name
Egenskapsvärde
string
Information om ärvda egenskaper
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 | TokenCredential
Egenskapsvä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
Valfri. 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
Valfri. 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>
generateSasStringToSign(DirectoryGenerateSasUrlOptions)
Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string
Parametrar
- options
- DirectoryGenerateSasUrlOptions
Valfria parametrar.
Returer
string
SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.
generateSasUrl(DirectoryGenerateSasUrlOptions)
Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter.
Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. 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 till den resurs som representeras av den här klienten, följt av den genererade SAS-token.
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas i SAS signeras av indataanvändarens delegeringsnyckel.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string
Parametrar
- options
- DirectoryGenerateSasUrlOptions
Valfria parametrar.
- userDelegationKey
- UserDelegationKey
Returvärde för blobServiceClient.getUserDelegationKey()
Returer
string
SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>
Parametrar
- options
- DirectoryGenerateSasUrlOptions
Valfria parametrar.
- userDelegationKey
- UserDelegationKey
Returvärde för blobServiceClient.getUserDelegationKey()
Returer
Promise<string>
SAS-URI:n som består av URI:n till 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): DataLakeFileClient
Parametrar
- fileName
-
string
Returer
getSubdirectoryClient(string)
Skapar ett DataLakeDirectoryClient--objekt under den aktuella katalogen.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient
Parametrar
- 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
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>
ärvd frånDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Ta bort den aktuella sökvägen (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
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>
ä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. 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>
ärvs 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
Valfri. 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): DataLakeLeaseClient
Parametrar
- 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://docs.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>
ärvs 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
Valfri. 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
Valfri. Alternativ när du flyttar katalog eller fil.
Returer
Promise<PathMoveResponse>
ärvd frånDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Tar bort åtkomstkontrollen 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.
Valfri. 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
Valfri. Alternativ när du anger åtkomstkontroll för sökväg.
Returer
Promise<PathSetAccessControlResponse>
ärvd frånDataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Anger åtkomstkontroll 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.
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://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 om inga metadata har definierats i parametern, tas sökvägens metadata 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
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>
ärvd frånDataLakePathClient.setMetadata
setPermissions(PathPermissions, PathSetPermissionsOptions)
Anger filbehörigheter för 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
Valfri. 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(): DataLakeDirectoryClient
Returer
ärvd frånDataLakePathClient.toDirectoryClient
toFileClient()
Konvertera aktuell DataLakePathClient till DataLakeFileClient om den aktuella sökvägen är en fil.
function toFileClient(): DataLakeFileClient
Returer
ärvd frånDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Ändrar åtkomstkontrollen 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.
Valfri. Alternativ