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 balíčku |
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 |
Pokud existuje, odstraňte aktuální cestu (adresář nebo soubor). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete |
exists(Path |
Vrátí hodnotu true, pokud existuje soubor Data Lake reprezentovaný tímto klientem; jinak nepravda. POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové soubory přidány jinými klienty nebo aplikacemi. |
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áře nebo souboru). |
get |
Vrátí všechna uživatelsky 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řesuňte adresář nebo soubor do 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 řízení přístupu 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í řízení přístupu na cestě a dílčích cestách. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
set |
Nastaví systémové vlastnosti v cestě (adresář nebo soubor). Pokud není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu blob bez hodnoty se vymažou. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Nastaví uživatelsky definovaná metadata pro zadanou cestu (adresář souboru) jako jeden nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo v parametru nejsou 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í řízení přístupu 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 datovému jezeře Služby Azure Storage (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 přizpůsobený 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 datovému jezeře Služby Azure Storage (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 balíčku @azure/identity
k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
- options
- StoragePipelineOptions
Volitelný. Možnosti konfigurace kanálu HTTP
Podrobnosti vlastnosti
fileSystemName
Název aktuálního systému souborů
string fileSystemName
Hodnota vlastnosti
string
name
Název aktuální cesty (adresář nebo soubor).
string name
Hodnota vlastnosti
string
Podrobnosti zděděných vlastností
accountName
credential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity
k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Hodnota vlastnosti
url
Zakódovaná hodnota řetězce adresy URL.
url: string
Hodnota vlastnosti
string
zděděno zdataLakePathClient.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
Volitelný. 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
Volitelný. 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>
generateSasStringToSign(DirectoryGenerateSasUrlOptions)
Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string
Parametry
- options
- DirectoryGenerateSasUrlOptions
Volitelné parametry.
Návraty
string
Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.
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 (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán 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, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných v SAS je podepsán vstupním klíčem delegování uživatele.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string
Parametry
- options
- DirectoryGenerateSasUrlOptions
Volitelné parametry.
- userDelegationKey
- UserDelegationKey
Návratová hodnota blobServiceClient.getUserDelegationKey()
Návraty
string
Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>
Parametry
- options
- DirectoryGenerateSasUrlOptions
Volitelné parametry.
- userDelegationKey
- UserDelegationKey
Návratová hodnota blobServiceClient.getUserDelegationKey()
Návraty
Promise<string>
Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.
getFileClient(string)
Vytvoří objekt DataLakeFileClient v aktuálním adresáři.
function getFileClient(fileName: string): DataLakeFileClient
Parametry
- fileName
-
string
Návraty
getSubdirectoryClient(string)
Vytvoří objekt DataLakeDirectoryClient v aktuálním adresáři.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient
Parametry
- 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 prostředek je adresář. Pokud je hodnota true, odstraní se všechny cesty pod adresářem.
- options
- PathDeleteOptions
Volitelný. Možnosti při odstraňování cesty
Návraty
Promise<PathDeleteResponse>
zděděno zDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Pokud existuje, odstraňte aktuální cestu (adresář nebo soubor).
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 prostředek je adresář. Pokud je hodnota 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 existuje soubor Data Lake reprezentovaný tímto klientem; jinak nepravda.
POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové soubory přidány jinými klienty nebo aplikacemi.
function exists(options?: PathExistsOptions): Promise<boolean>
Parametry
- options
- PathExistsOptions
možnosti pro operaci 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
Volitelný. 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áře nebo souboru).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Parametry
- proposeLeaseId
-
string
Volitelný. Počáteční navrhované ID zapůjčení
Návraty
getProperties(PathGetPropertiesOptions)
Vrátí všechna uživatelsky 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 klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodami DataLakeFileSystemClient, které vypisují cesty pomocí možnosti includeMetadata
, což zachová původní velikost skříně.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>
Parametry
- options
- PathGetPropertiesOptions
Volitelný. Možnosti při získávání vlastností cesty
Návraty
Promise<PathGetPropertiesResponse>
zděděno zDataLakePathClient.getProperties
move(string, PathMoveOptions)
Přesuňte adresář nebo soubor do 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
Cílová cesta k 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
Volitelný. 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 "systém souborů".
- destinationPath
-
string
Cílová cesta k adresáři, například "adresář" nebo cesta k souboru "adresář/soubor", pokud je cílová cesta ověřená pomocí SAS, přidejte sas do cílové cesty, například "directory/file?sasToken".
- options
- PathMoveOptions
Volitelný. Možnosti při přesouvání adresáře nebo souboru
Návraty
Promise<PathMoveResponse>
zděděno zDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Odebere řízení přístupu 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ář.
Volitelný. Volby
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
Volitelný. Možnosti při nastavování řízení přístupu k cestě
Návraty
Promise<PathSetAccessControlResponse>
zděděno zDataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Nastaví řízení přístupu na cestě a dílčích cestách.
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ář.
Volitelný. Volby
Návraty
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Nastaví systémové vlastnosti v cestě (adresář nebo soubor).
Pokud není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu 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ěné zDataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
Nastaví uživatelsky definovaná metadata pro zadanou cestu (adresář souboru) jako jeden nebo více dvojic název-hodnota.
Pokud není k dispozici žádná možnost nebo v parametru nejsou 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
Volitelný. Nahraďte stávající metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata se odeberou.
- options
- PathSetMetadataOptions
Volitelný. Možnosti při nastavování metadat cesty
Návraty
Promise<PathSetMetadataResponse>
zděděný 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 vlastníka souboru a další.
- options
- PathSetPermissionsOptions
Volitelný. 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(): DataLakeDirectoryClient
Návraty
zděděno zDataLakePathClient.toDirectoryClient
toFileClient()
Pokud je aktuální cesta souborem, převeďte aktuální DataLakePathClient na DataLakeFileClient.
function toFileClient(): DataLakeFileClient
Návraty
zděděno zDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Upraví řízení přístupu 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ář.
Volitelný. Volby