DataLakeDirectoryClient class
DataLakeDirectoryClient, Azure Depolama dizininin URL'sini temsil eder.
- Extends
Oluşturucular
| Data |
URL ve işlem hattından DataLakePathClient örneği oluşturur. |
| Data |
URL'den ve kimlik bilgisinden DataLakePathClient örneği oluşturur. |
Özellikler
| file |
Geçerli dosya sisteminin adı. |
| name | Geçerli yolun adı (dizin veya dosya). |
Devralınan Özellikler
| account |
|
| credential | AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için |
| url | Kodlanmış URL dizesi değeri. |
Yöntemler
Devralınan Yöntemler
| delete(boolean, Path |
Geçerli yolu (dizin veya dosya) silin. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Varsa geçerli yolu (dizin veya dosya) silin. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
Bu istemci tarafından temsil edilen Data Lake dosyası varsa true döndürür; false olarak ayarlayın. NOT: Mevcut bir dosya diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından yeni dosyalar eklenebilir. |
| get |
Bir yol (dosya dizini) için erişim denetimi verilerini döndürür. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Yolda (dizin veya dosya) kiraları yöneten bir DataLakeLeaseClient alın. |
| get |
Yol (dizin veya dosya) için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür. UYARI: Yanıtta döndürülen Bkz. https://learn.microsoft.com/rest/api/storageservices/get-blob-properties |
| move(string, Path |
Dizini veya dosyayı aynı dosya sistemi içinde taşıyın. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| move(string, string, Path |
Dizini veya dosyayı başka bir dosya sistemine taşıyın. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Yol ve alt yollardaki Erişim Denetimini kaldırır. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Bir yol (dosya dizini) için erişim denetimi verilerini ayarlayın. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Bir yolda ve alt yollarda Erişim Denetimi'ni ayarlar. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Yoldaki sistem özelliklerini (dizin veya dosya) ayarlar. Belirtilen blob HTTP üst bilgileri için değer sağlanmazsa veya değer sağlanmazsa, değeri olmayan bu blob HTTP üst bilgileri temizlenir. Bkz. https://learn.microsoft.com/rest/api/storageservices/set-blob-properties |
| set |
Belirtilen yol (dosya dizini) için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar. Seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa, yol meta verileri kaldırılır. Bkz. https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata |
| set |
Bir yolda dosya izinlerini ayarlar. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| to |
Geçerli yol bir dizinse geçerli DataLakePathClient'ı DataLakeDirectoryClient'a dönüştürün. |
| to |
Geçerli yol bir dosyaysa, geçerli DataLakePathClient'ı DataLakeFileClient'a dönüştürün. |
| update |
Bir yol ve alt yol üzerindeki Erişim Denetimi'ni değiştirir. Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
Oluşturucu Ayrıntıları
DataLakeDirectoryClient(string, Pipeline)
URL ve işlem hattından DataLakePathClient örneği oluşturur.
new DataLakeDirectoryClient(url: string, pipeline: Pipeline)
Parametreler
- url
-
string
"https://myaccount.dfs.core.windows.net/filesystem/directory" gibi Azure Storage data lake yolunu (dizin veya dosya) işaret eden bir İstemci dizesi; veya "https://myaccount.dfs.core.windows.net/filesystem/file". AnonymousCredential kullanıyorsanız , "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString" gibi bir SAS ekleyebilirsiniz.
- pipeline
- Pipeline
Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için newPipeline() çağrısında bulunabilirsiniz.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
URL'den ve kimlik bilgisinden DataLakePathClient örneği oluşturur.
new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametreler
- url
-
string
"https://myaccount.dfs.core.windows.net/filesystem/directory" gibi Azure Storage data lake yolunu (dizin veya dosya) işaret eden bir İstemci dizesi; veya "https://myaccount.dfs.core.windows.net/filesystem/file". AnonymousCredential kullanıyorsanız , "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString" gibi bir SAS ekleyebilirsiniz.
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
- options
- StoragePipelineOptions
Optional. HTTP işlem hattını yapılandırma seçenekleri.
Özellik Ayrıntıları
fileSystemName
Geçerli dosya sisteminin adı.
string fileSystemName
Özellik Değeri
string
name
Geçerli yolun adı (dizin veya dosya).
string name
Özellik Değeri
string
Devralınan Özellik Detayları
accountName
credential
AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Özellik Değeri
Devralındığı yer:DataLakePathClient.credential
url
Kodlanmış URL dizesi değeri.
url: string
Özellik Değeri
string
Devralındığı yer:DataLakePathClient.url
Yöntem Ayrıntıları
create(DirectoryCreateOptions)
Bir dizin oluşturun.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>
Parametreler
- options
- DirectoryCreateOptions
Optional. Dizin oluştururken seçenekler.
Döndürülenler
Promise<DirectoryCreateResponse>
create(PathResourceType, PathCreateOptions)
Bir dizin oluşturun.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>
Parametreler
- resourceType
- PathResourceTypeModel
Kaynak türü, DataLakeDirectoryClient için "dizin" olmalıdır.
- options
- PathCreateOptions
Optional. Dizin oluştururken seçenekler.
Döndürülenler
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Henüz yoksa bir dizin oluşturun.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>
Parametreler
Döndürülenler
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)
Henüz yoksa bir dizin oluşturun.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>
Parametreler
- resourceType
- PathResourceTypeModel
Kaynak türü, DataLakeDirectoryClient için "dizin" olmalıdır.
- options
- PathCreateIfNotExistsOptions
Döndürülenler
Promise<PathCreateIfNotExistsResponse>
generateSasStringToSign(DirectoryGenerateSasUrlOptions)
Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur.
Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string
Parametreler
- options
- DirectoryGenerateSasUrlOptions
İsteğe bağlı parametreler.
Döndürülenler
string
Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.
generateSasUrl(DirectoryGenerateSasUrlOptions)
Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.
geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.
Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>
Parametreler
- options
- DirectoryGenerateSasUrlOptions
İsteğe bağlı parametreler.
Döndürülenler
Promise<string>
Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sine imza atacak dizeyi, sas içinde geçirilen istemci özelliklerine ve parametrelerine göre oluşturur. Sas, giriş kullanıcı temsilcisi anahtarı tarafından imzalanır.
Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string
Parametreler
- options
- DirectoryGenerateSasUrlOptions
İsteğe bağlı parametreler.
- userDelegationKey
- UserDelegationKey
blobServiceClient.getUserDelegationKey() dönüş değeri
Döndürülenler
string
Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)
geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, giriş kullanıcı temsilcisi anahtarı tarafından imzalanır.
Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>
Parametreler
- options
- DirectoryGenerateSasUrlOptions
İsteğe bağlı parametreler.
- userDelegationKey
- UserDelegationKey
blobServiceClient.getUserDelegationKey() dönüş değeri
Döndürülenler
Promise<string>
Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.
getFileClient(string)
Geçerli dizin altında bir DataLakeFileClient nesnesi oluşturur.
function getFileClient(fileName: string): DataLakeFileClient
Parametreler
- fileName
-
string
Döndürülenler
getSubdirectoryClient(string)
Geçerli dizin altında bir DataLakeDirectoryClient nesnesi oluşturur.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient
Parametreler
- subdirectoryName
-
string
Alt dizin adı.
Döndürülenler
Devralınan Yöntemin Ayrıntıları
delete(boolean, PathDeleteOptions)
Geçerli yolu (dizin veya dosya) silin.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>
Parametreler
- recursive
-
boolean
Gerekli ve yalnızca kaynak bir dizin olduğunda geçerlidir. "True" ise, dizinin altındaki tüm yollar silinir.
- options
- PathDeleteOptions
Optional. Yolu silerken seçenekler.
Döndürülenler
Promise<PathDeleteResponse>
Devralındığı yer:DataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Varsa geçerli yolu (dizin veya dosya) silin.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>
Parametreler
- recursive
-
boolean
Gerekli ve yalnızca kaynak bir dizin olduğunda geçerlidir. "True" ise, dizinin altındaki tüm yollar silinir.
- options
- PathDeleteOptions
Döndürülenler
Promise<PathDeleteIfExistsResponse>
Devralındığı yer:DataLakePathClient.deleteIfExists
exists(PathExistsOptions)
Bu istemci tarafından temsil edilen Data Lake dosyası varsa true döndürür; false olarak ayarlayın.
NOT: Mevcut bir dosya diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından yeni dosyalar eklenebilir.
function exists(options?: PathExistsOptions): Promise<boolean>
Parametreler
- options
- PathExistsOptions
seçeneklerine tıklayın.
Döndürülenler
Promise<boolean>
Devralındığı yer:DataLakePathClient.exists
getAccessControl(PathGetAccessControlOptions)
Bir yol (dosya dizini) için erişim denetimi verilerini döndürür.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>
Parametreler
- options
- PathGetAccessControlOptions
Optional. Dosya erişim denetimi alma seçenekleri.
Döndürülenler
Promise<PathGetAccessControlResponse>
Devralındığı yer:DataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Yolda (dizin veya dosya) kiraları yöneten bir DataLakeLeaseClient alın.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Parametreler
- proposeLeaseId
-
string
Optional. İlk önerilen kira kimliği.
Döndürülenler
Devralındığı yer:DataLakePathClient.getDataLakeLeaseClient
getProperties(PathGetPropertiesOptions)
Yol (dizin veya dosya) için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür.
UYARI: Yanıtta döndürülen metadata nesnesinin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak
Bkz. https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>
Parametreler
- options
- PathGetPropertiesOptions
Optional. Yol özelliklerini alma seçenekleri.
Döndürülenler
Promise<PathGetPropertiesResponse>
Devralındığı yer:DataLakePathClient.getProperties
move(string, PathMoveOptions)
Dizini veya dosyayı aynı dosya sistemi içinde taşıyın.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Parametreler
- destinationPath
-
string
"dizin" veya "dizin/dosya" dosya yolu gibi hedef dizin yolu. destinationPath'in kimliği SAS ile doğrulanmışsa, SAS'yi "dizin/dosya?sasToken" gibi hedef yola ekleyin.
- options
- PathMoveOptions
Optional. Dizin veya dosya taşırken seçenekler.
Döndürülenler
Promise<PathMoveResponse>
Devralındığı yer:DataLakePathClient.move
move(string, string, PathMoveOptions)
Dizini veya dosyayı başka bir dosya sistemine taşıyın.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Parametreler
- destinationFileSystem
-
string
"dosya sistemi" gibi hedef dosya sistemi.
- destinationPath
-
string
"dizin" veya dosya yolu "dizin/dosya" gibi hedef dizin yolu DestinationPath'in kimliği SAS ile doğrulanmışsa, SAS'yi "dizin/dosya?sasToken" gibi hedef yola ekleyin.
- options
- PathMoveOptions
Optional. Dizin veya dosya taşırken seçenekler.
Döndürülenler
Promise<PathMoveResponse>
Devralındığı yer:DataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Yol ve alt yollardaki Erişim Denetimini kaldırır.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Parametreler
Dosya veya dizin için POSIX erişim denetimi listesi.
Optional. Options
Döndürülenler
Devralındığı yer:DataLakePathClient.removeAccessControlRecursive
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Bir yol (dosya dizini) için erişim denetimi verilerini ayarlayın.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>
Parametreler
- acl
Dosya veya dizin için POSIX erişim denetimi listesi.
- options
- PathSetAccessControlOptions
Optional. Yol erişim denetimini ayarlarken seçenekler.
Döndürülenler
Promise<PathSetAccessControlResponse>
Devralındığı yer:DataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Bir yolda ve alt yollarda Erişim Denetimi'ni ayarlar.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Parametreler
- acl
Dosya veya dizin için POSIX erişim denetimi listesi.
Optional. Options
Döndürülenler
Devralındığı yer:DataLakePathClient.setAccessControlRecursive
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Yoldaki sistem özelliklerini (dizin veya dosya) ayarlar.
Belirtilen blob HTTP üst bilgileri için değer sağlanmazsa veya değer sağlanmazsa, değeri olmayan bu blob HTTP üst bilgileri temizlenir.
Bkz. https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>
Parametreler
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Döndürülenler
Promise<PathSetHttpHeadersResponse>
Devralındığı yer:DataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
Belirtilen yol (dosya dizini) için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar.
Seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa, yol meta verileri kaldırılır.
Bkz. https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>
Parametreler
- metadata
- Metadata
Optional. Var olan meta verileri bu değerle değiştirin. Değer sağlanmazsa, mevcut meta veriler kaldırılır.
- options
- PathSetMetadataOptions
Optional. Yol meta verilerini ayarlarken seçenekler.
Döndürülenler
Promise<PathSetMetadataResponse>
Devralındığı yer:DataLakePathClient.setMetadata
setPermissions(PathPermissions, PathSetPermissionsOptions)
Bir yolda dosya izinlerini ayarlar.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>
Parametreler
- permissions
- PathPermissions
Dosya sahibi, dosya sahibi grubu ve diğerleri için POSIX erişim izinleri.
- options
- PathSetPermissionsOptions
Optional. Yol izinlerini ayarlarken seçenekler.
Döndürülenler
Promise<PathSetPermissionsResponse>
Devralındığı yer:DataLakePathClient.setPermissions
toDirectoryClient()
Geçerli yol bir dizinse geçerli DataLakePathClient'ı DataLakeDirectoryClient'a dönüştürün.
function toDirectoryClient(): DataLakeDirectoryClient
Döndürülenler
Devralındığı yer:DataLakePathClient.toDirectoryClient
toFileClient()
Geçerli yol bir dosyaysa, geçerli DataLakePathClient'ı DataLakeFileClient'a dönüştürün.
function toFileClient(): DataLakeFileClient
Döndürülenler
Devralındığı yer:DataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Bir yol ve alt yol üzerindeki Erişim Denetimi'ni değiştirir.
Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Parametreler
- acl
Dosya veya dizin için POSIX erişim denetimi listesi.
Optional. Options
Döndürülenler
Devralındığı yer:DataLakePathClient.updateAccessControlRecursive