@azure/storage-file-datalake package

NODE.JS 런타임에서만 사용할 수 있습니다.

AccountSAS에서 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 serialize되고 AccountSASSignatureValues 개체의 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한의 순서는 특정하며 이 클래스는 정확성을 보장합니다.

NODE.JS 런타임에서만 사용할 수 있습니다.

AccountSAS에서 액세스할 수 있는 리소스를 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 리소스 종류에 대한 액세스 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 serialize되고 AccountSASSignatureValues 개체의 리소스 필드로 설정되어야 합니다. 이 클래스 없이 리소스 문자열을 생성할 수 있지만 리소스의 순서는 특정하며 이 클래스는 정확성을 보장합니다.

NODE.JS 런타임에서만 사용할 수 있습니다.

AccountSAS에서 액세스할 수 있는 서비스를 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 서비스에 대한 액세스 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 serialize되고 AccountSASSignatureValues 개체의 서비스 필드로 설정되어야 합니다. 이 클래스 없이 서비스 문자열을 생성할 수 있지만 서비스의 순서는 특정하며 이 클래스는 정확성을 보장합니다.

AnonymousCredential은 AnonymousCredentialPolicy 개체를 만드는 데 사용되는 credentialPolicyCreator 멤버를 제공합니다. AnonymousCredentialPolicy는 공용 리소스를 읽는 HTTP(S) 요청과 함께 사용되거나 SAS(공유 액세스 서명)와 함께 사용됩니다.

AnonymousCredentialPolicy는 공용 리소스를 읽는 HTTP(S) 요청과 함께 사용되거나 SAS(공유 액세스 서명)와 함께 사용됩니다.

모든 요청 정책이 파생되는 기본 클래스입니다.

자격 증명은 Azure Storage HTTP 요청 서명에 대한 추상 클래스입니다. 이 클래스는 CredentialPolicy를 생성하는 credentialPolicyCreator 팩터리를 호스트합니다.

보내기 전에 HTTP(S) 요청에 서명하는 데 사용되는 자격 증명 정책입니다. 이 클래스는 추상 클래스입니다.

작업이 중단되고 나중에 계속할 수 있을 때 발생하는 오류입니다.

DataLakeDirectoryClient는 Azure Storage 디렉터리에 대한 URL을 나타냅니다.

DataLakeFileClient는 Azure Storage 파일의 URL을 나타냅니다.

DataLakeFileSystemClient는 해당 디렉터리와 파일을 조작할 수 있는 Azure Storage 파일 시스템의 URL을 나타냅니다.

DataLakePathClient는 Azure Storage 경로(디렉터리 또는 파일)에 대한 URL을 나타냅니다.

NODE.JS 런타임에서만 사용할 수 있습니다.

ServiceSAS에서 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 serialize되고 DataLakeSASSignatureValues 개체의 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한의 순서는 특정하며 이 클래스는 정확성을 보장합니다.

DataLakeServiceClient를 사용하면 Azure Data Lake 서비스 리소스 및 파일 시스템을 조작할 수 있습니다. 스토리지 계정은 Data Lake 서비스에 대한 최상위 네임스페이스를 제공합니다.

ServiceSAS가 디렉터리에 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 serialize되고 DataLakeSASSignatureValues 개체의 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한의 순서는 특정하며 이 클래스는 정확성을 보장합니다.

ServiceSAS가 컨테이너에 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString으로 직렬화되고 DataLakeSASSignatureValues 개체의 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한의 순서는 특정하며 이 클래스는 정확성을 보장합니다.

HTTP 요청 정책을 포함하는 파이프라인 클래스입니다. newPipeline을 호출하여 기본 파이프라인을 만들 수 있습니다. 또는 Pipeline 생성자가 고유한 정책을 사용하여 파이프라인을 만들 수 있습니다.

사용자 지정된 파이프라인을 구현하기 전에 newPipeline 및 제공된 정책을 참조하세요.

실패한 파이프라인 요청에 대한 사용자 지정 오류 유형입니다.

Azure Storage SAS의 쿼리 매개 변수를 구성하는 구성 요소를 나타냅니다. 이 형식은 사용자가 직접 생성하지 않습니다. AccountSASSignatureValues 및 <xref:BlobSASSignatureValues> 형식에서만 생성됩니다. 생성되면 로 인코딩하고 URL에 toString() 직접 추가할 수 있습니다(기존 쿼리 매개 변수가 있는 경우 이러한 쿼리 매개 변수를 추가하는 적절한 수단에 영향을 줄 수 있는 경우 여기서 주의해야 합니다).

참고: 이 클래스의 인스턴스는 변경할 수 없습니다.

StorageBrowserPolicy는 다음을 포함하여 Node.js 브라우저 런타임 간의 차이를 처리합니다.

1. 브라우저는 'IF_MODIFIED_SINCE'과 같은 조건부 헤더를 추가하여 GET/HEAD 요청을 캐시합니다. StorageBrowserPolicy는 GET/HEAD 요청 URL에 타임스탬프 쿼리를 추가하여 브라우저 캐시를 방지하는 데 사용되는 정책입니다.

2. 보안을 위해 쿠키 헤더 제거

3. 브라우저 경고를 방지하기 위해 콘텐츠 길이 헤더 제거

StorageBrowserPolicyFactory는 StorageBrowserPolicy 개체를 생성하는 데 도움이 되는 팩터리 클래스입니다.

지수 재시도 및 선형 재시도를 구현한 재시도 정책

StorageRetryPolicyFactory는 StorageRetryPolicy 개체를 생성하는 데 도움이 되는 팩터리 클래스입니다.

NODE.JS 런타임에서만 사용할 수 있습니다.

Azure Storage 서비스의 계정 키 권한 부여를 위한 StorageSharedKeyCredential입니다.

StorageSharedKeyCredentialPolicy는 공유 키를 사용하여 HTTP 요청에 서명하는 데 사용되는 정책입니다.

AccessControlChangeCounters에는 액세스 제어 목록을 재귀적으로 변경하는 작업 수가 포함됩니다.

및 updateAccessControlRecursiveremoveAccessControlRecursive중에 setAccessControlRecursive액세스 제어 목록을 업데이트하지 못한 항목을 나타냅니다.

AccessControlChanges에는 액세스 제어 목록을 재귀적으로 변경하는 작업의 일괄 처리 및 누적 수가 포함됩니다. 또한 이러한 작업이 진행되는 동안 업데이트하지 못한 경로 항목을 노출합니다.

NODE.JS 런타임에서만 사용할 수 있습니다.

AccountSASSignatureValues는 Azure Storage 계정에 대한 SAS(공유 액세스 서명)를 생성하는 데 사용됩니다. 여기에 있는 모든 값이 적절하게 설정되면 generateAccountSASQueryParameters 를 호출하여 실제로 데이터 레이크 URL에 적용할 수 있는 SAS의 표현을 가져옵니다. 참고: 이 클래스와 SASQueryParameters 는 모두 존재합니다. 전자는 변경 가능하고 논리적 표현이지만 후자는 변경할 수 없으며 실제 REST 요청을 생성하는 데 사용되므로 존재합니다.

SAS에 대한 자세한 개념 정보는 필수 매개 변수를 포함한 매개 변수에 대한 설명을 참조하세요 https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas .

Azure Storage Blob

Blob의 속성

FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions 및 FileGenerateSasUrlOptions의 일반적인 옵션입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

매개 변수 그룹

매개 변수 그룹

NODE.JS 런타임에서만 사용할 수 있습니다.

DataLakeSASSignatureValues는 컨테이너, Blob, 파일 시스템, 디렉터리 및 파일에 대한 Blob 및 DataLake 서비스 SAS 토큰을 생성하는 데 사용됩니다.

스토리지 서비스 속성.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

createIfNotExists 작업에 대한 응답 데이터를 포함합니다.

generateSasUrl 작업을 구성하는 옵션입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

createIfNotExists 작업에 대한 응답 데이터를 포함합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

generateSasUrl 작업을 구성하는 옵션입니다.

Data Lake 파일에 대한 옵션 인터페이스 - 업로드 작업

참조

• upload
• Uploadfile
• uploadStream

CSV 형식으로 파일을 쿼리하는 옵션입니다.

파일 쿼리 오류 유형입니다.

JSON 형식으로 파일을 쿼리하는 옵션입니다.

Data Lake 파일에 대한 옵션 인터페이스 - 쿼리 작업

참조

• 쿼리

Parquet 형식으로 파일을 쿼리하는 옵션입니다.

Data Lake 파일에 대한 옵션 인터페이스 - readToBuffer 작업

참조

• readToBuffer

Path_setExpiry 작업에 대한 헤더를 정의합니다.

setExpiry 작업에 대한 옵션 인터페이스입니다.

createIfNotExists 작업에 대한 응답 데이터를 포함합니다.

deleteIfExists 작업에 대한 응답 데이터를 포함합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

파일 시스템에서 암호화 범위를 지정하는 옵션입니다.

Data Lake 파일 시스템에 대한 옵션 인터페이스가 있는 작업

참조

• exists

generateSasUrl 작업을 구성하는 옵션입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

FileSystem_listBlobHierarchySegment 작업에 대한 헤더를 정의합니다.

FileSystem_listPaths 작업에 대한 헤더를 정의합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

HTTP 헤더 키/값 쌍의 컬렉션입니다.

core-v1(core-http)과 호환되는 Http 응답입니다.

core-http 요청 정책에 대한 호환되는 인터페이스

특정 임대에 대한 세부 정보입니다.

매개 변수 그룹

임대 작업을 구성합니다.

Blob 열거형

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

Path_appendData 작업에 대한 헤더를 정의합니다.

옵션 유형은 및 updateAccessControlRecursive 입니다removeAccessControlRecursivesetAccessControlRecursive.

및 updateAccessControlRecursiveremoveAccessControlRecursive에 대한 응답 형식입니다setAccessControlRecursive.

Path_create 작업에 대한 헤더를 정의합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

createIfNotExists 작업에 대한 응답 데이터를 포함합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

Path_delete 작업에 대한 헤더를 정의합니다.

deleteIfExists 작업에 대한 응답 데이터를 포함합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

Data Lake 디렉터리/파일에 대한 옵션 인터페이스가 있는 작업

참조

• exists

Path_flushData 작업에 대한 헤더를 정의합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

Path_getProperties 작업에 대한 헤더를 정의합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

Path_setAccessControl 작업에 대한 헤더를 정의합니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

Path_undelete 작업에 대한 헤더를 정의합니다.

Path_update 작업에 대한 헤더를 정의합니다.

HTTP 요청 정책을 포함하는 Pipeline 클래스에 대한 인터페이스입니다. newPipeline을 호출하여 기본 파이프라인을 만들 수 있습니다. 또는 Pipeline 생성자가 고유한 정책을 사용하여 파이프라인을 만들 수 있습니다.

사용자 지정된 파이프라인을 구현하기 전에 newPipeline 및 제공된 정책을 참조하세요.

파이프라인 생성자에 대한 옵션 인터페이스입니다.

core-http의 RequestPolicyFactory와의 호환성을 위한 인터페이스

RequestPolicy와의 호환성을 위한 인터페이스

SASQueryParameters를 생성하는 옵션입니다.

SAS에 허용되는 IP 범위입니다.

ServiceClientOptions의 @azure/core-http 하위 집합

generateAccountSasUrl 작업을 구성하는 옵션입니다.

모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다.

undeleteFileSystem을 구성하는 옵션입니다.

newPipeline 함수에 대한 옵션 인터페이스입니다.

Storage Blob 다시 시도 옵션 인터페이스.

사용자 위임 키

원격 서버에 대한 HTTP 요청에 대한 설명입니다.

getProperties 작업에 대한 응답 데이터를 포함합니다.

EncryptionAlgorithmType에 대한 값을 정의합니다.
<xref:KnownEncryptionAlgorithmType> EncryptionAlgorithmType과 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

서비스에서 지원하는 알려진 값

없음
AES256

PathExpiryOptions에 대한 값을 정의합니다.

Apache 화살표 형식으로 파일을 쿼리하는 옵션입니다. outputTextConfiguration에만 유효합니다.

작업에 대한 <xref:DataLakeServiceClient.renameFileSystem> 응답 데이터를 포함합니다.

undeleteFileSystem 작업에 대한 응답 데이터를 포함합니다.

요청에서 지원되는 본문 유형입니다. NodeJS.ReadableStream 및 () => NodeJS.ReadableStream은 노드 전용입니다. Blob, ReadableStream 및 () => ReadableStream은 브라우저 전용입니다.

임대를 만들거나 수정하거나 삭제하는 작업에 대한 응답 데이터를 포함합니다.

<xref:BlobLeaseClient>을 참조하세요.

PathGetPropertiesAction에 대한 값을 정의합니다.

PathRenameMode에 대한 값을 정의합니다.

PathResourceType에 대한 값을 정의합니다.

listContainersSegment 작업에 대한 응답 데이터를 포함합니다.

를 구성하는 <xref:DataLakeServiceClient.renameFileSystem>옵션입니다.

PathGetPropertiesAction에 대한 값을 정의합니다. 가능한 값은 'getAccessControl', 'getStatus'입니다.

PathRenameMode에 대한 값을 정의합니다. 가능한 값은 '레거시', 'posix'입니다.

PathResourceType에 대한 값을 정의합니다. 가능한 값은 'directory', 'file'입니다.

생성된 SAS에 대한 프로토콜입니다.

Storage에 대해 알려진 클라우드 대상 그룹을 정의합니다.

RetryPolicy 형식입니다.

NODE.JS 런타임에서만 사용할 수 있습니다.

실제 REST 요청을 만드는 데 필요한 모든 SAS 쿼리 매개 변수를 포함하는 SASQueryParameters 개체를 생성합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas를 참조하세요.

NODE.JS 런타임에서만 사용할 수 있습니다.

SASQueryParameters의 인스턴스를 만듭니다.

SAS를 만드는 데 필요한 설정만 허용합니다. 선택적 설정의 경우 권한, startsOn 및 식별자와 같은 해당 속성을 직접 설정하세요.

경고: 식별자가 제공되지 않으면 권한 및 expiresOn이 필요합니다. 이 생성자를 사용하여 초기화한 경우 식별자에 값을 할당하거나 expiresOn & 권한을 수동으로 할당해야 합니다.

다음 코드 조각을 실행하기 전에 필요한 세부 정보를 입력합니다.

예제

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

코드 조각을 실행하기 전에 필요한 세부 정보를 입력합니다.

예제

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

NODE.JS 런타임에서만 사용할 수 있습니다.

SASQueryParameters의 인스턴스를 만듭니다. 경고: 사용자 위임 SAS를 생성할 때 식별자가 무시되고 권한 및 expiresOn이 필요합니다.

예제

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

Datalake 서비스에 대한 스토리지 계정에 대한 OAuth 대상 그룹을 가져옵니다.

지정된 인수가 파이프라인 계약을 충족하는지 여부를 결정하는 도우미

자격 증명이 제공된 새 Pipeline 개체를 만듭니다.