@azure/storage-file-datalake package
클래스
| AccountSASPermissions |
NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 serialize되고 <xref:AccountSASSignatureValues> 개체에 대한 사용 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| AccountSASResourceTypes |
NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 액세스할 수 있는 리소스를 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 사용 권한을 사용하는 모든 SAS가 해당 리소스 종류에 대한 액세스 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 serialize되고 <xref:AccountSASSignatureValues> 개체의 리소스 필드로 설정되어야 합니다. 이 클래스 없이 리소스 문자열을 생성할 수 있지만 리소스 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| AccountSASServices |
NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 액세스할 수 있는 서비스를 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 서비스에 대한 액세스 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 직렬화되고 <xref:AccountSASSignatureValues> 개체의 서비스 필드로 설정되어야 합니다. 이 클래스 없이 서비스 문자열을 생성할 수 있지만 서비스의 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| AnonymousCredential |
AnonymousCredential은 AnonymousCredentialPolicy 개체를 만드는 데 사용되는 credentialPolicyCreator 멤버를 제공합니다. AnonymousCredentialPolicy는 공용 리소스를 읽는 HTTP(S) 요청과 함께 사용되거나 SAS(공유 액세스 서명)와 함께 사용됩니다. |
| AnonymousCredentialPolicy |
AnonymousCredentialPolicy는 공용 리소스를 읽는 HTTP(S) 요청과 함께 사용되거나 SAS(공유 액세스 서명)와 함께 사용됩니다. |
| Credential |
자격 증명은 Azure Storage HTTP 요청 서명을 위한 추상 클래스입니다. 이 클래스는 CredentialPolicy를 생성하는 credentialPolicyCreator 팩터리를 호스트합니다. |
| CredentialPolicy |
보내기 전에 HTTP(S) 요청에 서명하는 데 사용되는 자격 증명 정책입니다. 추상 클래스입니다. |
| DataLakeAclChangeFailedError |
작업이 중단되고 나중에 계속할 수 있을 때 발생하는 오류입니다. |
| DataLakeDirectoryClient |
DataLakeDirectoryClient는 Azure Storage 디렉터리에 대한 URL을 나타냅니다. |
| DataLakeFileClient |
DataLakeFileClient는 Azure Storage 파일에 대한 URL을 나타냅니다. |
| DataLakeFileSystemClient |
DataLakeFileSystemClient는 해당 디렉터리와 파일을 조작할 수 있는 Azure Storage 파일 시스템의 URL을 나타냅니다. |
| DataLakeLeaseClient | |
| DataLakePathClient |
DataLakePathClient는 Azure Storage 경로(디렉터리 또는 파일)에 대한 URL을 나타냅니다. |
| DataLakeSASPermissions |
NODE.JS 런타임에서만 사용할 수 있습니다. ServiceSAS에서 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString으로 serialize되고 <xref:DataLakeSASSignatureValues> 개체에 대한 사용 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| DataLakeServiceClient |
DataLakeServiceClient를 사용하면 Azure Data Lake 서비스 리소스 및 파일 시스템을 조작할 수 있습니다. 스토리지 계정은 Data Lake 서비스에 대한 최상위 네임스페이스를 제공합니다. |
| DirectorySASPermissions |
ServiceSAS가 디렉터리에 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString으로 serialize되고 <xref:DataLakeSASSignatureValues> 개체에 대한 사용 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| FileSystemSASPermissions |
ServiceSAS가 컨테이너에 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString으로 serialize되고 <xref:DataLakeSASSignatureValues> 개체에 대한 사용 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| Pipeline |
HTTP 요청 정책을 포함하는 파이프라인 클래스입니다. <xref:newPipeline>호출하여 기본 파이프라인을 만들 수 있습니다. 또는 파이프라인 생성자가 고유한 정책을 사용하여 파이프라인을 만들 수 있습니다. 사용자 지정된 파이프라인을 구현하기 전에 <xref:newPipeline> 및 제공된 정책을 참조하세요. |
| SASQueryParameters |
Azure Storage SAS의 쿼리 매개 변수를 구성하는 구성 요소를 나타냅니다. 이 형식은 사용자가 직접 생성하지 않습니다. <xref:AccountSASSignatureValues> 및 <xref:BlobSASSignatureValues> 형식에서만 생성됩니다. 생성되면 <xref:String> 인코딩하고 URL에 직접 추가할 수 있습니다(기존 쿼리 매개 변수가 있는 경우 주의해야 하지만 이러한 쿼리 매개 변수를 추가하는 적절한 수단에 영향을 줄 수 있음). 참고: 이 클래스의 인스턴스는 변경할 수 없습니다. |
| StorageBrowserPolicy |
StorageBrowserPolicy는 다음을 포함하여 Node.js 브라우저 런타임 간의 차이를 처리합니다.
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory는 StorageBrowserPolicy 개체를 생성하는 데 도움이 되는 팩터리 클래스입니다. |
| StorageClient |
StorageClient는 <xref:BlobServiceClient>, <xref:ContainerClient> 등에 대한 기반 URL 클래스를 나타냅니다. |
| StorageClientContext | |
| StorageRetryPolicy |
지수 재시도 및 선형 재시도를 구현한 재시도 정책입니다. |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory는 <xref:StorageRetryPolicy> 개체를 생성하는 데 도움이 되는 팩터리 클래스입니다. |
| StorageSharedKeyCredential |
NODE.JS 런타임에서만 사용할 수 있습니다. Azure Storage 서비스의 계정 키 권한 부여에 대한 StorageSharedKeyCredential입니다. |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy는 공유 키를 사용하여 HTTP 요청에 서명하는 데 사용되는 정책입니다. |
인터페이스
| AccessControlChangeCounters |
AccessControlChangeCounters에는 액세스 제어 목록을 재귀적으로 변경하는 작업 수가 포함됩니다. |
| AccessControlChangeError |
|
| AccessControlChanges |
AccessControlChanges에는 Access Control 목록을 재귀적으로 변경하는 작업의 일괄 처리 및 누적 개수가 포함됩니다. 또한 이러한 작업이 진행되는 동안 업데이트하지 못한 경로 항목을 노출합니다. |
| AccessPolicy | |
| AccountSASSignatureValues |
NODE.JS 런타임에서만 사용할 수 있습니다. AccountSASSignatureValues는 Azure Storage 계정에 대한 SAS(공유 액세스 서명)를 생성하는 데 사용됩니다. 여기에 있는 모든 값이 적절하게 설정되면 <xref:generateAccountSASQueryParameters> 호출하여 실제로 데이터 레이크 URL에 적용할 수 있는 SAS의 표현을 가져옵니다. 참고: 이 클래스와 <xref:SASQueryParameters> 모두 존재합니다. 전자는 변경 가능하고 논리적 표현이지만 후자는 변경할 수 없으며 실제 REST 요청을 생성하는 데 사용되므로 존재합니다. |
| BlobHierarchyListSegment | |
| BlobItemModel |
Azure Storage Blob |
| BlobPrefix | |
| BlobPropertiesModel |
Blob의 속성 |
| CommonGenerateSasUrlOptions |
<xref:FileSystemGenerateSasUrlOptions>, <xref:DirectoryGenerateSasUrlOptions> 및 <xref:FileGenerateSasUrlOptions>일반적인 옵션입니다. |
| CommonOptions |
모든 원격 작업에 공통적인 옵션에 대한 인터페이스입니다. |
| DataLakeRequestConditions | |
| DataLakeSASSignatureValues |
NODE.JS 런타임에서만 사용할 수 있습니다. DataLakeSASSignatureValues는 컨테이너, Blob, 파일 시스템, 디렉터리 및 파일에 대한 Blob 및 DataLake 서비스 SAS 토큰을 생성하는 데 사용됩니다. |
| DeletedPath | |
| DeletedPathList | |
| DirectoryCreateIfNotExistsOptions | |
| DirectoryCreateIfNotExistsResponse | |
| DirectoryCreateOptions | |
| DirectoryCreateResponse | |
| DirectoryGenerateSasUrlOptions |
<xref:DataLakeDirectoryClient.generateSasUrl> 작업을 구성하는 옵션입니다. |
| FileAppendOptions | |
| FileCreateIfNotExistsOptions | |
| FileCreateIfNotExistsResponse | |
| FileCreateOptions | |
| FileCreateResponse | |
| FileFlushOptions | |
| FileGenerateSasUrlOptions |
<xref:DataLakeFileClient.generateSasUrl> 작업을 구성하는 옵션입니다. |
| FileParallelUploadOptions |
Data Lake 파일에 대한 옵션 인터페이스 - 업로드 작업은 다음을 참조하세요.
|
| FileQueryCsvTextConfiguration |
CSV 형식으로 파일을 쿼리하는 옵션입니다. |
| FileQueryError |
파일 쿼리 오류 유형입니다. |
| FileQueryJsonTextConfiguration |
JSON 형식으로 파일을 쿼리하는 옵션입니다. |
| FileQueryOptions |
Data Lake 파일에 대한 옵션 인터페이스 - 쿼리 작업은 다음을 참조하세요.
|
| FileQueryParquetConfiguration |
Parquet 형식으로 파일을 쿼리하는 옵션입니다. |
| FileReadHeaders | |
| FileReadOptions | |
| FileReadToBufferOptions |
Data Lake 파일에 대한 옵션 인터페이스 - readToBuffer 작업 참조:
|
| FileSetExpiryHeaders |
Path_setExpiry 작업에 대한 헤더를 정의합니다. |
| FileSetExpiryOptions |
<xref:DataLakeFileClient.setExpiry> 작업에 대한 옵션 인터페이스입니다. |
| FileSystemCreateHeaders | |
| FileSystemCreateIfNotExistsResponse |
<xref:DataLakeFileSystemClient.createIfNotExists> 작업에 대한 응답 데이터를 포함합니다. |
| FileSystemCreateOptions | |
| FileSystemDeleteHeaders | |
| FileSystemDeleteIfExistsResponse |
<xref:DataLakeFileSystemClient.deleteIfExists> 작업에 대한 응답 데이터를 포함합니다. |
| FileSystemDeleteOptions | |
| FileSystemExistsOptions |
Data Lake 파일 시스템에 대한 옵션 인터페이스가 존재합니다. 다음을 참조하세요.
|
| FileSystemGenerateSasUrlOptions |
<xref:DataLakeFileSystemClient.generateSasUrl> 작업을 구성하는 옵션입니다. |
| FileSystemGetAccessPolicyHeaders | |
| FileSystemGetAccessPolicyOptions | |
| FileSystemGetPropertiesHeaders | |
| FileSystemGetPropertiesOptions | |
| FileSystemItem | |
| FileSystemListBlobHierarchySegmentHeaders |
FileSystem_listBlobHierarchySegment 작업에 대한 헤더를 정의합니다. |
| FileSystemListPathsHeaders |
FileSystem_listPaths 작업에 대한 헤더를 정의합니다. |
| FileSystemProperties | |
| FileSystemSetAccessPolicyHeaders | |
| FileSystemSetAccessPolicyOptions | |
| FileSystemSetMetadataHeaders | |
| FileSystemSetMetadataOptions | |
| FileSystemUndeletePathOption | |
| ListBlobsHierarchySegmentResponse |
Blob의 열거형 |
| ListDeletedPathsOptions | |
| ListDeletedPathsSegmentOptions | |
| ListFileSystemsSegmentResponse | |
| ListPathsOptions | |
| ListPathsSegmentOptions | |
| Metadata | |
| Path | |
| PathAccessControl | |
| PathAccessControlItem | |
| PathAppendDataHeaders |
Path_appendData 작업에 대한 헤더를 정의합니다. |
| PathChangeAccessControlRecursiveOptions |
|
| PathChangeAccessControlRecursiveResponse |
|
| PathCreateHeaders |
Path_create 작업에 대한 헤더를 정의합니다. |
| PathCreateHttpHeaders | |
| PathCreateIfNotExistsOptions | |
| PathCreateIfNotExistsResponse |
<xref:DataLakePathClient.createIfNotExists> 작업에 대한 응답 데이터를 포함합니다. |
| PathCreateOptions | |
| PathDeleteHeaders |
Path_delete 작업에 대한 헤더를 정의합니다. |
| PathDeleteIfExistsResponse |
<xref:DataLakePathClient.deleteIfExists> 작업에 대한 응답 데이터를 포함합니다. |
| PathDeleteOptions | |
| PathExistsOptions |
Data Lake 디렉터리/파일에 대한 옵션 인터페이스가 있는 작업 참조:
|
| PathFlushDataHeaders |
Path_flushData 작업에 대한 헤더를 정의합니다. |
| PathGetAccessControlHeaders | |
| PathGetAccessControlOptions | |
| PathGetPropertiesHeaders | |
| PathGetPropertiesHeadersModel |
Path_getProperties 작업에 대한 헤더를 정의합니다. |
| PathGetPropertiesOptions | |
| PathHttpHeaders | |
| PathList | |
| PathListModel | |
| PathModel | |
| PathMoveOptions | |
| PathPermissions | |
| PathRemoveHeaders | |
| PathSetAccessControlHeaders |
Path_setAccessControl 작업에 대한 헤더를 정의합니다. |
| PathSetAccessControlOptions | |
| PathSetHttpHeadersHeaders | |
| PathSetHttpHeadersOptions | |
| PathSetMetadataHeaders | |
| PathSetMetadataOptions | |
| PathSetPermissionsOptions | |
| PathUndeleteHeaders |
Path_undelete 작업에 대한 헤더를 정의합니다. |
| PathUpdateHeaders |
Path_update 작업에 대한 헤더를 정의합니다. |
| PipelineOptions |
파이프라인 생성자에 대한 옵션 인터페이스입니다. |
| RawAccessPolicy | |
| RemovePathAccessControlItem | |
| RolePermissions | |
| SASQueryParametersOptions |
<xref:SASQueryParameters>생성하는 옵션입니다. |
| SasIPRange |
SAS에 허용되는 IP 범위입니다. |
| ServiceGenerateAccountSasUrlOptions |
<xref:DataLakeServiceClient.generateAccountSasUrl> 작업을 구성하는 옵션입니다. |
| ServiceGetUserDelegationKeyHeaders | |
| ServiceGetUserDelegationKeyOptions | |
| ServiceListFileSystemsOptions | |
| ServiceListFileSystemsSegmentHeaders | |
| ServiceUndeleteFileSystemOptions |
<xref:DataLakeServiceClient.undeleteFileSystem>구성하는 옵션입니다. |
| SignedIdentifier | |
| StorageClientOptionalParams |
선택적 매개 변수입니다. |
| StoragePipelineOptions |
<xref:newPipeline> 함수에 대한 옵션 인터페이스입니다. |
| StorageRetryOptions |
스토리지 Blob 다시 시도 옵션 인터페이스입니다. |
| UserDelegationKey | |
형식 별칭
열거형
| PathGetPropertiesAction |
PathGetPropertiesAction에 대한 값을 정의합니다. 가능한 값은 'getAccessControl', 'getStatus'입니다. |
| PathRenameMode |
PathRenameMode에 대한 값을 정의합니다. 가능한 값은 'legacy', 'posix'입니다. |
| PathResourceType |
PathResourceType에 대한 값을 정의합니다. 가능한 값은 'directory', 'file'입니다. |
| SASProtocol |
생성된 SAS에 대한 프로토콜입니다. |
| StorageRetryPolicyType |
RetryPolicy 형식입니다. |
함수
| generate |
NODE.JS 런타임에서만 사용할 수 있습니다. 실제 REST 요청을 만드는 데 필요한 모든 SAS 쿼리 매개 변수를 포함하는 <xref:SASQueryParameters> 개체를 생성합니다. |
| generate |
NODE.JS 런타임에서만 사용할 수 있습니다. SASQueryParameters의 인스턴스를 만듭니다. SAS를 만드는 데 필요한 설정만 허용합니다. 선택적 설정의 경우 사용 권한, startsOn 및 식별자와 같은 해당 속성을 직접 설정하세요. 경고: 식별자가 제공되지 않으면 사용 권한 및 expiresOn이 필요합니다. 이 생성자를 사용하여 초기화할 경우 ID에 값을 할당하거나 expiresOn & 권한을 수동으로 할당해야 합니다. 다음 코드 조각을 실행하기 전에 필요한 세부 정보를 입력합니다. |
| generate |
NODE.JS 런타임에서만 사용할 수 있습니다. SASQueryParameters의 인스턴스를 만듭니다. 경고: 사용자 위임 SAS를 생성할 때 식별자가 무시되고 권한 및 expiresOn이 필요합니다. |
| new |
자격 증명이 제공된 새 Pipeline 개체를 만듭니다. |
함수 세부 정보
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
NODE.JS 런타임에서만 사용할 수 있습니다. 실제 REST 요청을 만드는 데 필요한 모든 SAS 쿼리 매개 변수를 포함하는 <xref:SASQueryParameters> 개체를 생성합니다.
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
매개 변수
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
반환
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)
NODE.JS 런타임에서만 사용할 수 있습니다. SASQueryParameters의 인스턴스를 만듭니다.
SAS를 만드는 데 필요한 설정만 허용합니다. 선택적 설정의 경우 사용 권한, startsOn 및 식별자와 같은 해당 속성을 직접 설정하세요.
경고: 식별자가 제공되지 않으면 사용 권한 및 expiresOn이 필요합니다. 이 생성자를 사용하여 초기화할 경우 ID에 값을 할당하거나 expiresOn & 권한을 수동으로 할당해야 합니다.
다음 코드 조각을 실행하기 전에 필요한 세부 정보를 입력합니다.
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
매개 변수
- dataLakeSASSignatureValues
- DataLakeSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
반환
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)
NODE.JS 런타임에서만 사용할 수 있습니다. SASQueryParameters의 인스턴스를 만듭니다. 경고: 사용자 위임 SAS를 생성할 때 식별자가 무시되고 권한 및 expiresOn이 필요합니다.
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)
매개 변수
- dataLakeSASSignatureValues
- DataLakeSASSignatureValues
- userDelegationKey
- UserDelegationKey
blobServiceClient.getUserDelegationKey() 반환 값
- accountName
-
string
반환
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
자격 증명이 제공된 새 Pipeline 개체를 만듭니다.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)
매개 변수
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential, StorageSharedKeyCredential 또는 서비스에 대한 요청을 인증하는 @azure/identity 패키지의 자격 증명과 같은 TokenCredential 인터페이스를 구현하는 개체를 제공할 수도 있습니다. 지정하지 않으면 AnonymousCredential이 사용됩니다.
- pipelineOptions
- StoragePipelineOptions
선택적. 옵션.
반환
새 Pipeline 개체입니다.