DataLakeDirectoryClient class
Een DataLakeDirectoryClient vertegenwoordigt een URL naar de Azure Storage-map.
- Uitbreiding
Constructors
| Data |
Hiermee maakt u een exemplaar van DataLakePathClient op basis van url en pijplijn. |
| Data |
Hiermee maakt u een exemplaar van DataLakePathClient op basis van url en referentie. |
Eigenschappen
| file |
Naam van het huidige bestandssysteem. |
| name | Naam van het huidige pad (map of bestand). |
Overgenomen eigenschappen
| account |
|
| credential | Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het |
| url | Gecodeerde URL-tekenreekswaarde. |
Methoden
Overgenomen methoden
| delete(boolean, Path |
Verwijder het huidige pad (map of bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Verwijder het huidige pad (map of bestand) als dit bestaat. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
Retourneert waar als het Data Lake-bestand dat wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie met zorg 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. |
| get |
Retourneert de toegangsbeheergegevens voor een pad (map van bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Haal een DataLakeLeaseClient- op waarmee leases op het pad (map of bestand) worden beheerd. |
| get |
Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het pad (map of bestand). WAARSCHUWING: het Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties |
| move(string, Path |
Map of bestand binnen hetzelfde bestandssysteem verplaatsen. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
| move(string, string, Path |
Map of bestand verplaatsen naar een ander bestandssysteem. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Hiermee verwijdert u het toegangsbeheer op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Stel de toegangsbeheergegevens in voor een pad (map van bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Hiermee stelt u het toegangsbeheer in op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Hiermee stelt u systeemeigenschappen in op het pad (map of bestand). Als er geen waarde is opgegeven of 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 |
| set |
Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor het opgegeven pad (map van 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 |
| set |
Hiermee stelt u de bestandsmachtigingen voor een pad in. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
| to |
Converteer huidige DataLakePathClient naar DataLakeDirectoryClient als het huidige pad een map is. |
| to |
Converteer huidige DataLakePathClient naar DataLakeFileClient als het huidige pad een bestand is. |
| update |
Hiermee wijzigt u het toegangsbeheer op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
Constructordetails
DataLakeDirectoryClient(string, Pipeline)
Hiermee maakt u een exemplaar van DataLakePathClient op basis van url en pijplijn.
new DataLakeDirectoryClient(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 geef een aangepaste pijplijn op.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Hiermee maakt u een exemplaar van DataLakePathClient op basis van url en referentie.
new DataLakeDirectoryClient(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 referenties van 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
Facultatief. Opties voor het configureren van de HTTP-pijplijn.
Eigenschapdetails
fileSystemName
Naam van het huidige bestandssysteem.
string fileSystemNameWaarde van eigenschap
string
name
Naam van het huidige pad (map of bestand).
string nameWaarde van eigenschap
string
Details van overgenomen eigenschap
accountName
credential
Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van 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 | TokenCredentialWaarde van eigenschap
overgenomen vanDataLakePathClient.credential
url
Gecodeerde URL-tekenreekswaarde.
url: stringWaarde van eigenschap
string
overgenomen vanDataLakePathClient.url
Methodedetails
create(DirectoryCreateOptions)
Maak een map.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>Parameters
- options
- DirectoryCreateOptions
Facultatief. Opties bij het maken van een map.
Retouren
Promise<DirectoryCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
Maak een map.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>Parameters
- resourceType
- PathResourceTypeModel
Het resourcetype moet map zijn voor DataLakeDirectoryClient.
- options
- PathCreateOptions
Facultatief. Opties bij het maken van een map.
Retouren
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Maak een map als deze nog niet bestaat.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>Parameters
Retouren
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
Maak een map als deze nog niet bestaat.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Parameters
- resourceType
- PathResourceTypeModel
Het resourcetype moet map zijn voor DataLakeDirectoryClient.
- options
- PathCreateIfNotExistsOptions
Retouren
Promise<PathCreateIfNotExistsResponse>
generateSasStringToSign(DirectoryGenerateSasUrlOptions)
Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): stringParameters
- options
- DirectoryGenerateSasUrlOptions
Optionele parameters.
Retouren
string
De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.
generateSasUrl(DirectoryGenerateSasUrlOptions)
Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel.
Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>Parameters
- options
- DirectoryGenerateSasUrlOptions
Optionele parameters.
Retouren
Promise<string>
De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven in de SAS, is ondertekend door de sleutel voor de overdracht van invoergebruikers.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): stringParameters
- options
- DirectoryGenerateSasUrlOptions
Optionele parameters.
- userDelegationKey
- UserDelegationKey
Retourwaarde van blobServiceClient.getUserDelegationKey()
Retouren
string
De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>Parameters
- options
- DirectoryGenerateSasUrlOptions
Optionele parameters.
- userDelegationKey
- UserDelegationKey
Retourwaarde van blobServiceClient.getUserDelegationKey()
Retouren
Promise<string>
De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.
getFileClient(string)
Hiermee maakt u een DataLakeFileClient--object onder de huidige map.
function getFileClient(fileName: string): DataLakeFileClientParameters
- fileName
-
string
Retouren
getSubdirectoryClient(string)
Hiermee maakt u een DataLakeDirectoryClient--object onder de huidige map.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientParameters
- subdirectoryName
-
string
Naam van submap.
Retouren
Details overgenomen methode
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
Alleen vereist en geldig als de resource een map is. Als 'waar' wordt, worden alle paden onder de map verwijderd.
- options
- PathDeleteOptions
Facultatief. Opties bij het verwijderen van het pad.
Retouren
Promise<PathDeleteResponse>
overgenomen vanDataLakePathClient.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
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>Parameters
- recursive
-
boolean
Alleen vereist en geldig als de resource een map is. Als 'waar' wordt, worden alle paden onder de map verwijderd.
- options
- PathDeleteOptions
Retouren
Promise<PathDeleteIfExistsResponse>
overgenomen vanDataLakePathClient.deleteIfExists-
exists(PathExistsOptions)
Retourneert waar als het Data Lake-bestand dat wordt vertegenwoordigd door deze client bestaat; anders onwaar.
OPMERKING: gebruik deze functie met zorg 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 bestaat bewerking.
Retouren
Promise<boolean>
overgenomen vanDataLakePathClient.bestaat
getAccessControl(PathGetAccessControlOptions)
Retourneert de toegangsbeheergegevens voor een pad (map van bestand).
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>Parameters
- options
- PathGetAccessControlOptions
Facultatief. Opties bij het verkrijgen van toegangsbeheer voor bestanden.
Retouren
Promise<PathGetAccessControlResponse>
overgenomen vanDataLakePathClient.getAccessControl-
getDataLakeLeaseClient(string)
Haal een DataLakeLeaseClient- op waarmee leases op het pad (map of bestand) worden beheerd.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParameters
- proposeLeaseId
-
string
Facultatief. Oorspronkelijke voorgestelde lease-id.
Retouren
overgenomen vanDataLakePathClient.getDataLakeLeaseClient
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, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de methoden van DataLakeFileSystemClient die lijstpaden met behulp van de optie includeMetadata, die hun oorspronkelijke behuizing behouden.
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Parameters
- options
- PathGetPropertiesOptions
Facultatief. Opties bij het ophalen van padeigenschappen.
Retouren
Promise<PathGetPropertiesResponse>
overgenomen vanDataLakePathClient.getProperties-
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
Pad naar doelmap, zoals map of bestandspad 'map/bestand'. Als het destinationPath is geverifieerd met SAS, voegt u de SAS toe aan het doelpad, zoals map/bestand?sasToken.
- options
- PathMoveOptions
Facultatief. Opties bij het verplaatsen van map of bestand.
Retouren
Promise<PathMoveResponse>
overgenomen vanDataLakePathClient.move
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
Pad naar de doelmap, zoals map of bestandspad 'map/bestand' Als het doelpad is geverifieerd met SAS, voegt u de SAS toe aan het doelpad, zoals 'map/bestand?sasToken'.
- options
- PathMoveOptions
Facultatief. Opties bij het verplaatsen van map of bestand.
Retouren
Promise<PathMoveResponse>
overgenomen vanDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Hiermee verwijdert u het toegangsbeheer 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
De POSIX-toegangsbeheerlijst voor het bestand of de map.
Facultatief. Opties
Retouren
overgenomen vanDataLakePathClient.removeAccessControlRecursive-
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Stel de toegangsbeheergegevens in voor een pad (map van bestand).
Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>Parameters
- acl
De POSIX-toegangsbeheerlijst voor het bestand of de map.
- options
- PathSetAccessControlOptions
Facultatief. Opties bij het instellen van toegangsbeheer voor paden.
Retouren
Promise<PathSetAccessControlResponse>
overgenomen vanDataLakePathClient.setAccessControl-
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Hiermee stelt u het toegangsbeheer in 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
De POSIX-toegangsbeheerlijst voor het bestand of de map.
Facultatief. Opties
Retouren
overgenomen vanDataLakePathClient.setAccessControlRecursive-
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Hiermee stelt u systeemeigenschappen in op het pad (map of bestand).
Als er geen waarde is opgegeven of 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>
overgenomen vanDataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor het opgegeven pad (map van 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
Facultatief. Vervang bestaande metagegevens door deze waarde. Als er geen waarde is opgegeven, worden de bestaande metagegevens verwijderd.
- options
- PathSetMetadataOptions
Facultatief. Opties bij het instellen van padmetagegevens.
Retouren
Promise<PathSetMetadataResponse>
overgenomen vanDataLakePathClient.setMetadata-
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<PathSetPermissionsResponse>Parameters
- permissions
- PathPermissions
De POSIX-toegangsmachtigingen voor de bestandseigenaar, de groep die eigenaar is van het bestand en andere.
- options
- PathSetPermissionsOptions
Facultatief. Opties bij het instellen van padmachtigingen.
Retouren
Promise<PathSetPermissionsResponse>
overgenomen vanDataLakePathClient.setPermissions
toDirectoryClient()
Converteer huidige DataLakePathClient naar DataLakeDirectoryClient als het huidige pad een map is.
function toDirectoryClient(): DataLakeDirectoryClientRetouren
overgenomen vanDataLakePathClient.toDirectoryClient
toFileClient()
Converteer huidige DataLakePathClient naar DataLakeFileClient als het huidige pad een bestand is.
function toFileClient(): DataLakeFileClientRetouren
overgenomen vanDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Hiermee wijzigt u het toegangsbeheer 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
De POSIX-toegangsbeheerlijst voor het bestand of de map.
Facultatief. Opties
Retouren
overgenomen vanDataLakePathClient.updateAccessControlRecursive-