DataLakePathClient class
A DataLakePathClient az Azure Storage elérési útja (könyvtár vagy fájl) URL-címét jelöli.
- Extends
-
StorageClient
Konstruktorok
| Data |
Létrehoz egy DataLakePathClient-példányt az URL-címből és a folyamatból. |
| Data |
Létrehoz egy DataLakePathClient-példányt az URL-címből és a hitelesítő adatokból. |
Tulajdonságok
| file |
Az aktuális fájlrendszer neve. |
| name | Az aktuális elérési út neve (könyvtár vagy fájl). |
Örökölt tulajdonságok
| account |
|
| credential | Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a |
| url | Kódolt URL-sztringérték. |
Metódusok
| create(Path |
Hozzon létre egy könyvtárat vagy elérési utat. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| create |
Hozzon létre egy könyvtárat vagy fájlt. Ha az erőforrás már létezik, az nem módosul. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| delete(boolean, Path |
Az aktuális elérési út (könyvtár vagy fájl) törlése. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Ha létezik, törölje az aktuális elérési utat (könyvtárat vagy fájlt). Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
Igaz értéket ad vissza, ha az ügyfél által képviselt Data Lake-fájl létezik; máskülönben hamis. MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő fájlt más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy a függvény befejezése után más ügyfelek vagy alkalmazások új fájlokat adnak hozzá. |
| get |
Egy elérési út (fájlkönyvtár) hozzáférés-vezérlési adatait adja vissza. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Szerezze be DataLakeLeaseClient, amely az elérési úton (könyvtárban vagy fájlban) lévő bérleteket kezeli. |
| get |
A felhasználó által definiált metaadatokat, a szabványos HTTP-tulajdonságokat és az elérési út (könyvtár vagy fájl) rendszertulajdonságait adja vissza. FIGYELMEZTETÉS: A válaszban visszaadott Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-properties |
| move(string, Path |
Könyvtár vagy fájl áthelyezése ugyanabban a fájlrendszerben. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| move(string, string, Path |
Könyvtár vagy fájl áthelyezése másik fájlrendszerbe. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Eltávolítja a hozzáférés-vezérlést egy elérési úton és az alútvonalakon. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Adja meg az elérési út (fájlkönyvtár) hozzáférés-vezérlési adatait. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Beállítja a hozzáférés-vezérlést egy elérési útvonalon és alútvonalakon. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Beállítja a rendszertulajdonságokat az elérési úton (könyvtárban vagy fájlban). Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejlécekhez, a blob HTTP-fejlécei érték nélkül törlődnek. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties |
| set |
A megadott elérési út (fájlkönyvtár) felhasználó által definiált metaadatait egy vagy több név-érték párként állítja be. Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a rendszer eltávolítja az elérési út metaadatait. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata |
| set |
Beállítja a fájlengedélyeket egy elérési úton. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| to |
Az aktuális DataLakePathClient konvertálása DataLakeDirectoryClientre, ha az aktuális elérési út könyvtár. |
| to |
Az aktuális DataLakePathClient átalakítása DataLakeFileClientre, ha az aktuális elérési út egy fájl. |
| update |
Módosítja a hozzáférés-vezérlést egy elérési úton és az alútvonalakon. Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
Konstruktor adatai
DataLakePathClient(string, Pipeline)
Létrehoz egy DataLakePathClient-példányt az URL-címből és a folyamatból.
new DataLakePathClient(url: string, pipeline: Pipeline)Paraméterek
- url
-
string
Az Azure Storage data lake elérési útjára (könyvtárra vagy fájlra) mutató ügyfélsztring, például "https://myaccount.dfs.core.windows.net/filesystem/directory" vagy "https://myaccount.dfs.core.windows.net/filesystem/file". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- pipeline
- Pipeline
A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Létrehoz egy DataLakePathClient-példányt az URL-címből és a hitelesítő adatokból.
new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Paraméterek
- url
-
string
Az Azure Storage data lake elérési útjára (könyvtárra vagy fájlra) mutató ügyfélsztring, például "https://myaccount.dfs.core.windows.net/filesystem/directory" vagy "https://myaccount.dfs.core.windows.net/filesystem/file". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
- options
- StoragePipelineOptions
Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.
Tulajdonság adatai
fileSystemName
Az aktuális fájlrendszer neve.
string fileSystemNameTulajdonság értéke
string
name
Az aktuális elérési út neve (könyvtár vagy fájl).
string nameTulajdonság értéke
string
Örökölt tulajdonság részletei
accountName
accountName: stringTulajdonság értéke
string
örökölt StorageClient.accountName
credential
Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialTulajdonság értéke
örökölt StorageClient.credential
url
Kódolt URL-sztringérték.
url: stringTulajdonság értéke
string
örökölt StorageClient.url-címről
Metódus adatai
create(PathResourceType, PathCreateOptions)
Hozzon létre egy könyvtárat vagy elérési utat.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>Paraméterek
- resourceType
- PathResourceTypeModel
Erőforrástípus, "könyvtár" vagy "fájl".
- options
- PathCreateOptions
Optional. Lehetőségek az elérési út létrehozásakor.
Válaszok
Promise<PathCreateResponse>
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)
Hozzon létre egy könyvtárat vagy fájlt. Ha az erőforrás már létezik, az nem módosul.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Paraméterek
- resourceType
- PathResourceTypeModel
Erőforrástípus, "könyvtár" vagy "fájl".
- options
- PathCreateIfNotExistsOptions
Válaszok
Promise<PathCreateIfNotExistsResponse>
delete(boolean, PathDeleteOptions)
Az aktuális elérési út (könyvtár vagy fájl) törlése.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>Paraméterek
- recursive
-
boolean
Csak akkor kötelező és érvényes, ha az erőforrás könyvtár. Ha "igaz", a könyvtár alatti összes elérési út törlődik.
- options
- PathDeleteOptions
Optional. Az elérési út törlésekor megadott beállítások.
Válaszok
Promise<PathDeleteResponse>
deleteIfExists(boolean, PathDeleteOptions)
Ha létezik, törölje az aktuális elérési utat (könyvtárat vagy fájlt).
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>Paraméterek
- recursive
-
boolean
Csak akkor kötelező és érvényes, ha az erőforrás könyvtár. Ha "igaz", a könyvtár alatti összes elérési út törlődik.
- options
- PathDeleteOptions
Válaszok
Promise<PathDeleteIfExistsResponse>
exists(PathExistsOptions)
Igaz értéket ad vissza, ha az ügyfél által képviselt Data Lake-fájl létezik; máskülönben hamis.
MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő fájlt más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy a függvény befejezése után más ügyfelek vagy alkalmazások új fájlokat adnak hozzá.
function exists(options?: PathExistsOptions): Promise<boolean>Paraméterek
- options
- PathExistsOptions
beállítási lehetőségeket a Exists művelethez.
Válaszok
Promise<boolean>
getAccessControl(PathGetAccessControlOptions)
Egy elérési út (fájlkönyvtár) hozzáférés-vezérlési adatait adja vissza.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>Paraméterek
- options
- PathGetAccessControlOptions
Optional. Beállítások a fájlhozzáférés-vezérlés lekéréséhez.
Válaszok
Promise<PathGetAccessControlResponse>
getDataLakeLeaseClient(string)
Szerezze be DataLakeLeaseClient, amely az elérési úton (könyvtárban vagy fájlban) lévő bérleteket kezeli.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParaméterek
- proposeLeaseId
-
string
Optional. Kezdeti javasolt bérletazonosító.
Válaszok
getProperties(PathGetPropertiesOptions)
A felhasználó által definiált metaadatokat, a szabványos HTTP-tulajdonságokat és az elérési út (könyvtár vagy fájl) rendszertulajdonságait adja vissza.
FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér az DataLakeFileSystemClient által visszaadott metaadatkulcsoktól, amelyek a includeMetadata beállítással listáznak elérési utakat, amelyek megőrzik az eredeti burkolatukat.
Lásd: https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Paraméterek
- options
- PathGetPropertiesOptions
Optional. Lehetőségek az elérési út tulajdonságainak lekérésekor.
Válaszok
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions)
Könyvtár vagy fájl áthelyezése ugyanabban a fájlrendszerben.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Paraméterek
- destinationPath
-
string
A célkönyvtár elérési útja, például a "könyvtár" vagy a "könyvtár/fájl" fájl elérési útja. Ha a destinationPath sassal van hitelesítve, adja hozzá az SAS-t a célútvonalhoz, például "könyvtár/fájl?sasToken".
- options
- PathMoveOptions
Optional. Könyvtár vagy fájl áthelyezésekor megadott beállítások.
Válaszok
Promise<PathMoveResponse>
move(string, string, PathMoveOptions)
Könyvtár vagy fájl áthelyezése másik fájlrendszerbe.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Paraméterek
- destinationFileSystem
-
string
Cél fájlrendszer, például "fájlrendszer".
- destinationPath
-
string
Célkönyvtár elérési útja, például "könyvtár" vagy fájl elérési útja "könyvtár/fájl" Ha a destinationPath sas-hitelesítéssel van hitelesítve, adja hozzá az SAS-t a cél elérési úthoz, például "könyvtár/fájl?sasToken".
- options
- PathMoveOptions
Optional. Könyvtár vagy fájl áthelyezésekor megadott beállítások.
Válaszok
Promise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Eltávolítja a hozzáférés-vezérlést egy elérési úton és az alútvonalakon.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Paraméterek
A fájl vagy könyvtár POSIX-hozzáférés-vezérlési listája.
Optional. Beállítások
Válaszok
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Adja meg az elérési út (fájlkönyvtár) hozzáférés-vezérlési adatait.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>Paraméterek
- acl
A fájl vagy könyvtár POSIX-hozzáférés-vezérlési listája.
- options
- PathSetAccessControlOptions
Optional. Beállítások az elérési út hozzáférés-vezérlésének beállításához.
Válaszok
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Beállítja a hozzáférés-vezérlést egy elérési útvonalon és alútvonalakon.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Paraméterek
- acl
A fájl vagy könyvtár POSIX-hozzáférés-vezérlési listája.
Optional. Beállítások
Válaszok
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Beállítja a rendszertulajdonságokat az elérési úton (könyvtárban vagy fájlban).
Ha nincs megadva érték, vagy nincs megadva érték a megadott blob HTTP-fejlécekhez, a blob HTTP-fejlécei érték nélkül törlődnek.
Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>Paraméterek
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Válaszok
Promise<PathSetHttpHeadersResponse>
setMetadata(Metadata, PathSetMetadataOptions)
A megadott elérési út (fájlkönyvtár) felhasználó által definiált metaadatait egy vagy több név-érték párként állítja be.
Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a rendszer eltávolítja az elérési út metaadatait.
Lásd: https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>Paraméterek
- metadata
- Metadata
Optional. Cserélje le a meglévő metaadatokat erre az értékre. Ha nincs megadva érték, a meglévő metaadatok el lesznek távolítva.
- options
- PathSetMetadataOptions
Optional. Beállítások az elérési út metaadatainak beállításához.
Válaszok
Promise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions)
Beállítja a fájlengedélyeket egy elérési úton.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>Paraméterek
- permissions
- PathPermissions
A POSIX hozzáférési engedélyei a fájl tulajdonosához, a fájltulajdonosi csoporthoz és másokhoz.
- options
- PathSetPermissionsOptions
Optional. Az elérésiút-engedélyek beállításának beállításai.
Válaszok
Promise<PathSetPermissionsResponse>
toDirectoryClient()
Az aktuális DataLakePathClient konvertálása DataLakeDirectoryClientre, ha az aktuális elérési út könyvtár.
function toDirectoryClient(): DataLakeDirectoryClientVálaszok
toFileClient()
Az aktuális DataLakePathClient átalakítása DataLakeFileClientre, ha az aktuális elérési út egy fájl.
function toFileClient(): DataLakeFileClientVálaszok
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Módosítja a hozzáférés-vezérlést egy elérési úton és az alútvonalakon.
Lásd: https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Paraméterek
- acl
A fájl vagy könyvtár POSIX-hozzáférés-vezérlési listája.
Optional. Beállítások