DataLakePathClient class
DataLakePathClient는 Azure Storage 경로(디렉터리 또는 파일)에 대한 URL을 나타냅니다.
- Extends
-
StorageClient
생성자
| Data |
URL 및 파이프라인에서 DataLakePathClient의 인스턴스를 만듭니다. |
| Data |
URL 및 자격 증명에서 DataLakePathClient의 인스턴스를 만듭니다. |
속성
| file |
현재 파일 시스템의 이름입니다. |
| name | 현재 경로의 이름(디렉터리 또는 파일)입니다. |
상속된 속성
| account |
|
| credential | AnonymousCredential, StorageSharedKeyCredential 또는 서비스에 대한 요청을 인증하는 |
| url | 인코딩된 URL 문자열 값입니다. |
메서드
생성자 세부 정보
DataLakePathClient(string, Pipeline)
URL 및 파이프라인에서 DataLakePathClient의 인스턴스를 만듭니다.
new DataLakePathClient(url: string, pipeline: Pipeline)매개 변수
- url
-
string
Azure Storage 데이터 레이크 경로(디렉터리 또는 파일)를 가리키는 클라이언트 문자열(예: "https://myaccount.dfs.core.windows.net/filesystem/directory" 또는 "https://myaccount.dfs.core.windows.net/filesystem/file"입니다. AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString").
- pipeline
- Pipeline
newPipeline()을 호출하여 기본 파이프라인을 만들거나 사용자 지정된 파이프라인을 제공합니다.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
URL 및 자격 증명에서 DataLakePathClient의 인스턴스를 만듭니다.
new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)매개 변수
- url
-
string
Azure Storage 데이터 레이크 경로(디렉터리 또는 파일)를 가리키는 클라이언트 문자열(예: "https://myaccount.dfs.core.windows.net/filesystem/directory" 또는 "https://myaccount.dfs.core.windows.net/filesystem/file"입니다. AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString").
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential, StorageSharedKeyCredential 또는 서비스에 대한 요청을 인증하는 @azure/identity 패키지의 자격 증명과 같은 TokenCredential 인터페이스를 구현하는 개체를 제공할 수도 있습니다. 지정하지 않으면 AnonymousCredential이 사용됩니다.
- options
- StoragePipelineOptions
Optional. HTTP 파이프라인을 구성하는 옵션입니다.
속성 세부 정보
fileSystemName
현재 파일 시스템의 이름입니다.
string fileSystemName속성 값
string
name
현재 경로의 이름(디렉터리 또는 파일)입니다.
string name속성 값
string
상속된 속성 세부 정보
accountName
accountName: string속성 값
string
StorageClient.accountName에서 상속된
credential
AnonymousCredential, StorageSharedKeyCredential 또는 서비스에 대한 요청을 인증하는 @azure/identity 패키지의 자격 증명과 같은 TokenCredential 인터페이스를 구현하는 개체를 제공할 수도 있습니다. 지정하지 않으면 AnonymousCredential이 사용됩니다.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential속성 값
StorageClient.credential에서 상속된
url
인코딩된 URL 문자열 값입니다.
url: string속성 값
string
StorageClient.url에서 상속된
메서드 세부 정보
create(PathResourceType, PathCreateOptions)
디렉터리 또는 경로를 만듭니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create 참조
function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>매개 변수
- resourceType
- PathResourceTypeModel
리소스 종류, "디렉터리" 또는 "파일"입니다.
- options
- PathCreateOptions
Optional. 경로를 만들 때의 옵션입니다.
반환
Promise<PathCreateResponse>
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)
디렉터리 또는 파일을 만듭니다. 리소스가 이미 있는 경우 변경되지 않습니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create 참조
function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>매개 변수
- resourceType
- PathResourceTypeModel
리소스 종류, "디렉터리" 또는 "파일"입니다.
- options
- PathCreateIfNotExistsOptions
반환
Promise<PathCreateIfNotExistsResponse>
delete(boolean, PathDeleteOptions)
현재 경로(디렉터리 또는 파일)를 삭제합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete 참조
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>매개 변수
- recursive
-
boolean
리소스가 디렉터리인 경우에만 필수이며 유효합니다. "true"이면 디렉터리 아래의 모든 경로가 삭제됩니다.
- options
- PathDeleteOptions
Optional. 경로를 삭제할 때의 옵션입니다.
반환
Promise<PathDeleteResponse>
deleteIfExists(boolean, PathDeleteOptions)
현재 경로(디렉터리 또는 파일)가 있는 경우 삭제합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete 참조
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>매개 변수
- recursive
-
boolean
리소스가 디렉터리인 경우에만 필수이며 유효합니다. "true"이면 디렉터리 아래의 모든 경로가 삭제됩니다.
- options
- PathDeleteOptions
반환
Promise<PathDeleteIfExistsResponse>
exists(PathExistsOptions)
이 클라이언트가 나타내는 Data Lake 파일이 있으면 true를 반환합니다. false이면 false입니다.
참고: 다른 클라이언트 또는 애플리케이션에서 기존 파일을 삭제할 수 있기 때문에 이 함수를 주의해서 사용합니다. 그 반대로 이 함수가 완료된 후 다른 클라이언트 또는 애플리케이션에서 새 파일을 추가할 수 있습니다.
function exists(options?: PathExistsOptions): Promise<boolean>매개 변수
- options
- PathExistsOptions
옵션에서 Exists 연산을 수행할 수 있습니다.
반환
Promise<boolean>
getAccessControl(PathGetAccessControlOptions)
경로(파일 디렉터리)에 대한 액세스 제어 데이터를 반환합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties 참조
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>매개 변수
- options
- PathGetAccessControlOptions
Optional. 파일 액세스 제어를 받을 때의 옵션입니다.
반환
Promise<PathGetAccessControlResponse>
getDataLakeLeaseClient(string)
경로(디렉터리 또는 파일)에서 임대를 관리하는 DataLakeLeaseClient 가져옵니다.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient매개 변수
- proposeLeaseId
-
string
Optional. 처음 제안된 임대 ID입니다.
반환
getProperties(PathGetPropertiesOptions)
경로(디렉터리 또는 파일)에 대한 모든 사용자 정의 메타데이터, 표준 HTTP 속성 및 시스템 속성을 반환합니다.
경고: 응답에서 반환된 metadata 개체에는 원래 대문자가 포함되어 있더라도 해당 키가 소문자로 표시됩니다. 이는 원래 대/소문자를 유지하는 옵션을 사용하여 경로를 나열하는 includeMetadata 메서드에서 반환하는 메타데이터 키와 다릅니다.
https://learn.microsoft.com/rest/api/storageservices/get-blob-properties 참조
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>매개 변수
- options
- PathGetPropertiesOptions
Optional. 경로 속성을 가져오는 경우의 옵션입니다.
반환
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions)
동일한 파일 시스템 내에서 디렉터리 또는 파일을 이동합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create 참조
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>매개 변수
- destinationPath
-
string
대상 디렉터리 경로(예: "directory" 또는 파일 경로 "directory/file")입니다. destinationPath가 SAS로 인증된 경우 "directory/file?sasToken"과 같은 대상 경로에 SAS를 추가합니다.
- options
- PathMoveOptions
Optional. 디렉터리 또는 파일을 이동할 때의 옵션입니다.
반환
Promise<PathMoveResponse>
move(string, string, PathMoveOptions)
디렉터리 또는 파일을 다른 파일 시스템으로 이동합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create 참조
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>매개 변수
- destinationFileSystem
-
string
대상 파일 시스템(예: "filesystem")입니다.
- destinationPath
-
string
대상 디렉터리 경로(예: "directory" 또는 파일 경로 "directory/file")는 destinationPath가 SAS로 인증된 경우 "directory/file?sasToken"과 같은 대상 경로에 SAS를 추가합니다.
- options
- PathMoveOptions
Optional. 디렉터리 또는 파일을 이동할 때의 옵션입니다.
반환
Promise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
경로 및 하위 경로에서 Access Control을 제거합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update 참조
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>매개 변수
파일 또는 디렉터리에 대한 POSIX 액세스 제어 목록입니다.
Optional. Options
반환
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
경로(파일 디렉터리)에 대한 액세스 제어 데이터를 설정합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update 참조
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>매개 변수
- acl
파일 또는 디렉터리에 대한 POSIX 액세스 제어 목록입니다.
- options
- PathSetAccessControlOptions
Optional. 경로 액세스 제어를 설정할 때의 옵션입니다.
반환
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
경로 및 하위 경로에 대한 Access Control을 설정합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update 참조
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>매개 변수
- acl
파일 또는 디렉터리에 대한 POSIX 액세스 제어 목록입니다.
Optional. Options
반환
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
경로(디렉터리 또는 파일)의 시스템 속성을 설정합니다.
값이 제공되지 않거나 지정된 Blob HTTP 헤더에 대해 값이 제공되지 않은 경우 값이 없는 이러한 Blob HTTP 헤더는 지워지게 됩니다.
https://learn.microsoft.com/rest/api/storageservices/set-blob-properties 참조
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>매개 변수
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
반환
Promise<PathSetHttpHeadersResponse>
setMetadata(Metadata, PathSetMetadataOptions)
지정된 경로(파일 디렉터리)에 대한 사용자 정의 메타데이터를 하나 이상의 이름-값 쌍으로 설정합니다.
옵션이 제공되지 않거나 매개 변수에 정의된 메타데이터가 없는 경우 경로 메타데이터가 제거됩니다.
https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata 참조
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>매개 변수
- metadata
- Metadata
Optional. 기존 메타데이터를 이 값으로 대체합니다. 제공된 값이 없으면 기존 메타데이터가 제거됩니다.
- options
- PathSetMetadataOptions
Optional. 경로 메타데이터를 설정할 때의 옵션입니다.
반환
Promise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions)
경로에 대한 파일 권한을 설정합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update 참조
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>매개 변수
- permissions
- PathPermissions
파일 소유자, 파일 소유 그룹 등에 대한 POSIX 액세스 권한입니다.
- options
- PathSetPermissionsOptions
Optional. 경로 사용 권한을 설정할 때의 옵션입니다.
반환
Promise<PathSetPermissionsResponse>
toDirectoryClient()
현재 경로가 디렉터리인 경우 현재 DataLakePathClient를 DataLakeDirectoryClient로 변환합니다.
function toDirectoryClient(): DataLakeDirectoryClient반환
toFileClient()
현재 경로가 파일인 경우 현재 DataLakePathClient를 DataLakeFileClient로 변환합니다.
function toFileClient(): DataLakeFileClient반환
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
경로 및 하위 경로에서 Access Control을 수정합니다.
https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update 참조
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>매개 변수
- acl
파일 또는 디렉터리에 대한 POSIX 액세스 제어 목록입니다.
Optional. Options