DataLakeDirectoryClient class
DataLakeDirectoryClient představuje adresu URL adresáře služby Azure Storage.
- Extends
Konstruktory
| Data |
Vytvoří instanci DataLakePathClient z adresy URL a kanálu. |
| Data |
Vytvoří instanci DataLakePathClient z adresy URL a přihlašovacích údajů. |
Vlastnosti
| file |
Název aktuálního systému souborů. |
| name | Název aktuální cesty (adresář nebo soubor) |
Zděděné vlastnosti
| account |
|
| credential | Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z |
| url | Zakódovaná hodnota řetězce adresy URL. |
Metody
Zděděné metody
| delete(boolean, Path |
Odstranit aktuální cestu (adresář nebo soubor). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete. |
| delete |
Odstraňte aktuální cestu (adresář nebo soubor), pokud existuje. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete. |
| exists(Path |
Vrátí hodnotu true, pokud soubor Data Lake reprezentovaný tímto klientem existuje. jinak false. POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Naopak po dokončení této funkce můžou ostatní klienti nebo aplikace přidávat nové soubory. |
| get |
Vrátí data řízení přístupu pro cestu (adresář souboru). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties. |
| get |
Získejte DataLakeLeaseClient , který spravuje zapůjčení cesty (adresář nebo soubor). |
| get |
Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti pro cestu (adresář nebo soubor). UPOZORNĚNÍ: Objekt Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties. |
| move(string, Path |
Přesune adresář nebo soubor v rámci stejného systému souborů. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create. |
| move(string, string, Path |
Přesuňte adresář nebo soubor do jiného systému souborů. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create. |
| remove |
Odebere Access Control na cestě a dílčích cestách. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update. |
| set |
Nastavte data řízení přístupu pro cestu (adresář souboru). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update. |
| set |
Nastaví Access Control na cestu a dílčí cesty. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update. |
| set |
Nastaví systémové vlastnosti cesty (adresář nebo soubor). Pokud se nezadá žádná hodnota nebo nezadá žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektů blob bez hodnoty se vymažou. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties. |
| set |
Nastaví uživatelem definovaná metadata pro zadanou cestu (adresář souboru) jako jednu nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata cesty budou odebrána. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata. |
| set |
Nastaví oprávnění k souboru v cestě. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update. |
| to |
Převeďte aktuální DataLakePathClient na DataLakeDirectoryClient, pokud je aktuální cesta adresář. |
| to |
Pokud je aktuální cesta souborem, převeďte aktuální dataLakePathClient na DataLakeFileClient. |
| update |
Upraví Access Control na cestě a dílčích cestách. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update. |
Podrobnosti konstruktoru
DataLakeDirectoryClient(string, Pipeline)
Vytvoří instanci DataLakePathClient z adresy URL a kanálu.
new DataLakeDirectoryClient(url: string, pipeline: Pipeline)Parametry
- url
-
string
Řetězec klienta odkazující na cestu k úložišti Azure Storage Data Lake (adresář nebo soubor), například "https://myaccount.dfs.core.windows.net/filesystem/directory" nebo "https://myaccount.dfs.core.windows.net/filesystem/file". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- pipeline
- Pipeline
Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Vytvoří instanci DataLakePathClient z adresy URL a přihlašovacích údajů.
new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Parametry
- url
-
string
Řetězec klienta odkazující na cestu k úložišti Azure Storage Data Lake (adresář nebo soubor), například "https://myaccount.dfs.core.windows.net/filesystem/directory" nebo "https://myaccount.dfs.core.windows.net/filesystem/file". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.
- options
- StoragePipelineOptions
Nepovinný parametr. Možnosti konfigurace kanálu HTTP
Podrobnosti vlastnosti
fileSystemName
Název aktuálního systému souborů.
string fileSystemNameHodnota vlastnosti
string
name
Název aktuální cesty (adresář nebo soubor)
string nameHodnota vlastnosti
string
Podrobnosti zděděných vlastností
accountName
credential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialHodnota vlastnosti
Zděděno zdataLakePathClient.credential
url
Zakódovaná hodnota řetězce adresy URL.
url: stringHodnota vlastnosti
string
Zděděno zadresy DataLakePathClient.url
Podrobnosti metody
create(DirectoryCreateOptions)
Vytvořte adresář.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>Parametry
- options
- DirectoryCreateOptions
Nepovinný parametr. Možnosti při vytváření adresáře
Návraty
Promise<DirectoryCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
Vytvořte adresář.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>Parametry
- resourceType
- PathResourceTypeModel
Typ prostředku musí být adresář pro DataLakeDirectoryClient.
- options
- PathCreateOptions
Nepovinný parametr. Možnosti při vytváření adresáře
Návraty
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Pokud adresář ještě neexistuje, vytvořte ho.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>Parametry
Návraty
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
Pokud adresář ještě neexistuje, vytvořte ho.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Parametry
- resourceType
- PathResourceTypeModel
Typ prostředku musí být adresář pro DataLakeDirectoryClient.
- options
- PathCreateIfNotExistsOptions
Návraty
Promise<PathCreateIfNotExistsResponse>
generateSasUrl(DirectoryGenerateSasUrlOptions)
K dispozici pouze pro klienty vytvořené pomocí přihlašovacích údajů sdíleného klíče.
Vygeneruje identifikátor URI sdíleného přístupového podpisu služby (SAS) na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>Parametry
- options
- DirectoryGenerateSasUrlOptions
Volitelné parametry.
Návraty
Promise<string>
Identifikátor URI SAS sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následného vygenerovaného tokenu SAS.
getFileClient(string)
Vytvoří Objekt DataLakeFileClient v aktuálním adresáři.
function getFileClient(fileName: string): DataLakeFileClientParametry
- fileName
-
string
Návraty
getSubdirectoryClient(string)
Vytvoří DataLakeDirectoryClient objekt v aktuálním adresáři.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientParametry
- subdirectoryName
-
string
Název podadresáře.
Návraty
Podrobnosti zděděných metod
delete(boolean, PathDeleteOptions)
Odstranit aktuální cestu (adresář nebo soubor).
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete.
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>Parametry
- recursive
-
boolean
Povinné a platné pouze v případě, že je prostředek adresář. Pokud má hodnotu true, odstraní se všechny cesty pod adresářem.
- options
- PathDeleteOptions
Nepovinný parametr. Možnosti při odstraňování cesty.
Návraty
Promise<PathDeleteResponse>
Zděděno zDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Odstraňte aktuální cestu (adresář nebo soubor), pokud existuje.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete.
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>Parametry
- recursive
-
boolean
Povinné a platné pouze v případě, že je prostředek adresář. Pokud má hodnotu true, odstraní se všechny cesty pod adresářem.
- options
- PathDeleteOptions
Návraty
Promise<PathDeleteIfExistsResponse>
Zděděno zDataLakePathClient.deleteIfExists
exists(PathExistsOptions)
Vrátí hodnotu true, pokud soubor Data Lake reprezentovaný tímto klientem existuje. jinak false.
POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Naopak po dokončení této funkce můžou ostatní klienti nebo aplikace přidávat nové soubory.
function exists(options?: PathExistsOptions): Promise<boolean>Parametry
- options
- PathExistsOptions
možnosti operace Existuje.
Návraty
Promise<boolean>
Zděděno zDataLakePathClient.exists
getAccessControl(PathGetAccessControlOptions)
Vrátí data řízení přístupu pro cestu (adresář souboru).
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties.
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>Parametry
- options
- PathGetAccessControlOptions
Nepovinný parametr. Možnosti při získávání řízení přístupu k souborům
Návraty
Promise<PathGetAccessControlResponse>
Zděděno zDataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Získejte DataLakeLeaseClient , který spravuje zapůjčení cesty (adresář nebo soubor).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParametry
- proposeLeaseId
-
string
Nepovinný parametr. Počáteční navrhované ID zapůjčení
Návraty
getProperties(PathGetPropertiesOptions)
Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti pro cestu (adresář nebo soubor).
UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít své klíče napsané malými písmeny, i když původně obsahovaly velká písmena. Tím se liší od klíčů metadat vrácených metodami DataLakeFileSystemClient , které vypisují cesty pomocí includeMetadata možnosti , která si zachová jejich původní velikostí a velikostí.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties.
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Parametry
- options
- PathGetPropertiesOptions
Nepovinný parametr. Možnosti při získávání vlastností cesty.
Návraty
Promise<PathGetPropertiesResponse>
Zděděno zDataLakePathClient.getProperties
move(string, PathMoveOptions)
Přesune adresář nebo soubor v rámci stejného systému souborů.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Parametry
- destinationPath
-
string
Cesta k cílovému adresáři, například "adresář" nebo cesta k souboru "adresář/soubor". Pokud je cílová cesta ověřená pomocí SAS, přidejte ho do cílové cesty, například "directory/file?sasToken".
- options
- PathMoveOptions
Nepovinný parametr. Možnosti při přesouvání adresáře nebo souboru
Návraty
Promise<PathMoveResponse>
Zděděno zDataLakePathClient.move
move(string, string, PathMoveOptions)
Přesuňte adresář nebo soubor do jiného systému souborů.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Parametry
- destinationFileSystem
-
string
Cílový systém souborů, například "filesystem".
- destinationPath
-
string
Cesta k cílovému adresáři, jako je adresář, nebo cesta k souboru adresář/soubor. Pokud je cesta destinationPath ověřená pomocí SAS, přidejte sdílený přístupový podpis do cílové cesty, například adresář/soubor?sasToken.
- options
- PathMoveOptions
Nepovinný parametr. Možnosti při přesouvání adresáře nebo souboru
Návraty
Promise<PathMoveResponse>
Zděděno zDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Odebere Access Control na cestě a dílčích cestách.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parametry
Seznam řízení přístupu POSIX pro soubor nebo adresář.
Nepovinný parametr. Možnosti
Návraty
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Nastavte data řízení přístupu pro cestu (adresář souboru).
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>Parametry
- acl
Seznam řízení přístupu POSIX pro soubor nebo adresář.
- options
- PathSetAccessControlOptions
Nepovinný parametr. Možnosti při nastavování řízení přístupu k cestě.
Návraty
Promise<PathSetAccessControlResponse>
Zděděno zDataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Nastaví Access Control na cestu a dílčí cesty.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parametry
- acl
Seznam řízení přístupu POSIX pro soubor nebo adresář.
Nepovinný parametr. Možnosti
Návraty
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Nastaví systémové vlastnosti cesty (adresář nebo soubor).
Pokud se nezadá žádná hodnota nebo nezadá žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektů blob bez hodnoty se vymažou.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>Parametry
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Návraty
Promise<PathSetHttpHeadersResponse>
Zděděno zDataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
Nastaví uživatelem definovaná metadata pro zadanou cestu (adresář souboru) jako jednu nebo více dvojic název-hodnota.
Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata cesty budou odebrána.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata.
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>Parametry
- metadata
- Metadata
Nepovinný parametr. Nahraďte existující metadata touto hodnotou. Pokud se nezadá žádná hodnota, existující metadata se odeberou.
- options
- PathSetMetadataOptions
Nepovinný parametr. Možnosti při nastavování metadat cesty.
Návraty
Promise<PathSetMetadataResponse>
Zděděno zDataLakePathClient.setMetadata
setPermissions(PathPermissions, PathSetPermissionsOptions)
Nastaví oprávnění k souboru v cestě.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>Parametry
- permissions
- PathPermissions
Přístupová oprávnění POSIX pro vlastníka souboru, skupinu, která soubor vlastní, a další.
- options
- PathSetPermissionsOptions
Nepovinný parametr. Možnosti při nastavování oprávnění k cestě.
Návraty
Promise<PathSetPermissionsResponse>
Zděděno zDataLakePathClient.setPermissions
toDirectoryClient()
Převeďte aktuální DataLakePathClient na DataLakeDirectoryClient, pokud je aktuální cesta adresář.
function toDirectoryClient(): DataLakeDirectoryClientNávraty
Zděděno zDataLakePathClient.toDirectoryClient
toFileClient()
Pokud je aktuální cesta souborem, převeďte aktuální dataLakePathClient na DataLakeFileClient.
function toFileClient(): DataLakeFileClientNávraty
Zděděno zdataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Upraví Access Control na cestě a dílčích cestách.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parametry
- acl
Seznam řízení přístupu POSIX pro soubor nebo adresář.
Nepovinný parametr. Možnosti