DataLakeDirectoryClient class

URL 및 파이프라인에서 DataLakePathClient의 인스턴스를 만듭니다.

new DataLakeDirectoryClient(url: string, pipeline: Pipeline)

매개 변수

URL 및 자격 증명에서 DataLakePathClient의 인스턴스를 만듭니다.

new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

매개 변수

현재 파일 시스템의 이름입니다.

string fileSystemName

속성 값

현재 경로의 이름(디렉터리 또는 파일)입니다.

string name

속성 값

accountName: string

속성 값

DataLakePathClient.accountName 상속된

AnonymousCredential, StorageSharedKeyCredential 또는 서비스에 대한 요청을 인증하는 @azure/identity 패키지의 자격 증명과 같은 TokenCredential 인터페이스를 구현하는 개체를 제공할 수도 있습니다. 지정하지 않으면 AnonymousCredential이 사용됩니다.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

속성 값

DataLakePathClient.credential 상속된

인코딩된 URL 문자열 값입니다.

url: string

속성 값

DataLakePathClient.url 상속된

디렉터리를 만듭니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create 참조

function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>

매개 변수

반환

디렉터리를 만듭니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create 참조

function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

매개 변수

반환

디렉터리가 아직 없는 경우 만듭니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create 참조

function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>

매개 변수

반환

디렉터리가 아직 없는 경우 만듭니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create 참조

function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

매개 변수

반환

전달된 클라이언트 속성 및 매개 변수를 기반으로 SAS(서비스 공유 액세스 서명) URI에 서명하는 문자열을 생성합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조

function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string

매개 변수

반환

이 클라이언트가 나타내는 리소스에 대한 URI로 구성된 SAS URI와 생성된 SAS 토큰이 뒤따릅니다.

공유 키 자격 증명을 사용하여 생성된 클라이언트에만 사용할 수 있습니다.

전달된 클라이언트 속성 및 매개 변수를 기반으로 SAS(서비스 공유 액세스 서명) URI를 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조

function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>

매개 변수

반환

이 클라이언트가 나타내는 리소스에 대한 URI로 구성된 SAS URI와 생성된 SAS 토큰이 뒤따릅니다.

SAS에 전달된 클라이언트 속성 및 매개 변수에 따라 SAS(서비스 공유 액세스 서명) URI에 서명하는 문자열을 생성합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조

function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

매개 변수

반환

이 클라이언트가 나타내는 리소스에 대한 URI로 구성된 SAS URI와 생성된 SAS 토큰이 뒤따릅니다.

전달된 클라이언트 속성 및 매개 변수를 기반으로 SAS(서비스 공유 액세스 서명) URI를 생성합니다. SAS는 입력 사용자 위임 키로 서명됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조

function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

매개 변수

반환

이 클라이언트가 나타내는 리소스에 대한 URI로 구성된 SAS URI와 생성된 SAS 토큰이 뒤따릅니다.

현재 디렉터리 아래에 DataLakeFileClient 개체를 만듭니다.

function getFileClient(fileName: string): DataLakeFileClient

매개 변수

반환

현재 디렉터리 아래에 DataLakeDirectoryClient 개체를 만듭니다.

function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient

매개 변수

반환

현재 경로(디렉터리 또는 파일)를 삭제합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete 참조

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

매개 변수

반환

DataLakePathClient.delete 상속된

현재 경로(디렉터리 또는 파일)가 있는 경우 삭제합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete 참조

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

매개 변수

반환

DataLakePathClient.deleteIfExists 상속된

이 클라이언트가 나타내는 Data Lake 파일이 있으면 true를 반환합니다. false이면 false입니다.

참고: 다른 클라이언트 또는 애플리케이션에서 기존 파일을 삭제할 수 있기 때문에 이 함수를 주의해서 사용합니다. 그 반대로 이 함수가 완료된 후 다른 클라이언트 또는 애플리케이션에서 새 파일을 추가할 수 있습니다.

function exists(options?: PathExistsOptions): Promise<boolean>

매개 변수

반환

DataLakePathClient.exists에서 상속된

경로(파일 디렉터리)에 대한 액세스 제어 데이터를 반환합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties 참조

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

매개 변수

반환

DataLakePathClient.getAccessControl 상속된

경로(디렉터리 또는 파일)에서 임대를 관리하는 DataLakeLeaseClient 가져옵니다.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

매개 변수

반환

DataLakePathClient.getDataLakeLeaseClient 상속된

경로(디렉터리 또는 파일)에 대한 모든 사용자 정의 메타데이터, 표준 HTTP 속성 및 시스템 속성을 반환합니다.

경고: 응답에서 반환된 metadata 개체에는 원래 대문자가 포함되어 있더라도 해당 키가 소문자로 표시됩니다. 이는 원래 대/소문자를 유지하는 includeMetadata 옵션을 사용하여 경로를 나열하는 DataLakeFileSystemClient 메서드에서 반환하는 메타데이터 키와 다릅니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties 참조

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

매개 변수

반환

DataLakePathClient.getProperties 상속된

동일한 파일 시스템 내에서 디렉터리 또는 파일을 이동합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create 참조

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

매개 변수

반환

DataLakePathClient.move 상속된

디렉터리 또는 파일을 다른 파일 시스템으로 이동합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create 참조

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

매개 변수

반환

DataLakePathClient.move 상속된

경로 및 하위 경로에서 Access Control을 제거합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update 참조

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

매개 변수

반환

DataLakePathClient.removeAccessControlRecursive 상속된

경로(파일 디렉터리)에 대한 액세스 제어 데이터를 설정합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update 참조

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

매개 변수

반환

DataLakePathClient.setAccessControl 상속된

경로 및 하위 경로에 대한 Access Control을 설정합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update 참조

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

매개 변수

반환

DataLakePathClient.setAccessControlRecursive 상속된

경로(디렉터리 또는 파일)의 시스템 속성을 설정합니다.

값이 제공되지 않거나 지정된 Blob HTTP 헤더에 대해 값이 제공되지 않은 경우 값이 없는 이러한 Blob HTTP 헤더는 지워지게 됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties 참조

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

매개 변수

반환

DataLakePathClient.setHttpHeaders 상속된

지정된 경로(파일 디렉터리)에 대한 사용자 정의 메타데이터를 하나 이상의 이름-값 쌍으로 설정합니다.

옵션이 제공되지 않거나 매개 변수에 정의된 메타데이터가 없는 경우 경로 메타데이터가 제거됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata 참조

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

매개 변수

반환

DataLakePathClient.setMetadata 상속된

경로에 대한 파일 권한을 설정합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update 참조

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

매개 변수

반환

DataLakePathClient.setPermissions 상속된

현재 경로가 디렉터리인 경우 현재 DataLakePathClient를 DataLakeDirectoryClient로 변환합니다.

function toDirectoryClient(): DataLakeDirectoryClient

반환

DataLakePathClient.toDirectoryClient 상속된

현재 경로가 파일인 경우 현재 DataLakePathClient를 DataLakeFileClient로 변환합니다.

function toFileClient(): DataLakeFileClient

반환

DataLakePathClient.toFileClient 상속된

경로 및 하위 경로에서 Access Control을 수정합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update 참조

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

매개 변수

반환

DataLakePathClient.updateAccessControlRecursive 상속된