다음을 통해 공유

DataLakeFileSystemClient class

  • 참조
패키지:
@azure/storage-file-datalake

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

Extends

StorageClient

생성자

DataLakeFileSystemClient(string, Pipeline)

URL 및 파이프라인에서 DataLakeFileSystemClient의 인스턴스를 만듭니다.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

속성

name

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

상속된 속성

accountName
credential

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

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

메서드

create(FileSystemCreateOptions)

지정된 계정 아래에 새 파일 시스템을 만듭니다. 이름이 같은 파일 시스템이 이미 있는 경우 작업이 실패합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/create-container 참조
createIfNotExists(FileSystemCreateOptions)

지정된 계정 아래에 새 파일 시스템을 만듭니다. 이름이 같은 파일 시스템이 이미 있는 경우 변경되지 않습니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/create-container 참조
delete(FileSystemDeleteOptions)

현재 파일 시스템을 삭제합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container 참조
deleteIfExists(FileSystemDeleteOptions)

현재 파일 시스템이 있는 경우 삭제합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container 참조
exists(FileSystemExistsOptions)

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

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

공유 키 자격 증명으로 생성된 DataLakeFileSystemClient에만 사용할 수 있습니다.

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

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

공유 키 자격 증명으로 생성된 DataLakeFileSystemClient에만 사용할 수 있습니다.

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

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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

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

지정된 파일 시스템에 대한 권한을 가져옵니다. 사용 권한은 파일 시스템 데이터에 공개적으로 액세스할 수 있는지 여부를 나타냅니다.

경고: 구문 분석이 시작되고 expiresOn 문자열이 만료될 때 JavaScript 날짜의 전체 자릿수가 손실될 수 있습니다. 예를 들어 새 날짜("2018-12-31T03:44:23.8827891Z").toISOString()은 "2018-12-31T03:44:23.882Z"를 가져옵니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl 참조
getDataLakeLeaseClient(string)

파일 시스템에서 임대를 관리하는 DataLakeLeaseClient 가져옵니다.
getDirectoryClient(string)

현재 파일 시스템에서 DataLakeDirectoryClient 개체를 만듭니다.
getFileClient(string)

현재 파일 시스템에서 DataLakeFileClient 개체를 만듭니다.
getProperties(FileSystemGetPropertiesOptions)

지정된 파일 시스템에 대한 모든 사용자 정의 메타데이터 및 시스템 속성을 반환합니다.

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

https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties 참조
listDeletedPaths(ListDeletedPathsOptions)

지정된 파일 시스템의 모든 경로(디렉터리 및 파일)를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지의 경로를 나열합니다.

for await 구문을 사용하는 예제:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

iter.next()을(를) 사용하는 예제:

let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
  console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
  pathItem = await iter.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  for (const deletePath of response.pathItems) {
    console.log(`Path ${i++}: ${deletePath.name}`);
  }
}

표식과 함께 페이징을 사용하는 예제:

let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

https://docs.microsoft.com/rest/api/storageservices/list-blobs 참조
listPaths(ListPathsOptions)

지정된 파일 시스템의 모든 경로(디렉터리 및 파일)를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지의 경로를 나열합니다.

for await 구문을 사용하는 예제:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

iter.next()을(를) 사용하는 예제:

let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
  console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
  pathItem = await iter.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
  }
}

표식과 함께 페이징을 사용하는 예제:

let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

https://docs.microsoft.com/rest/api/storageservices/list-blobs 참조
setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

지정된 파일 시스템에 대한 사용 권한을 설정합니다. 사용 권한은 파일 시스템의 디렉터리 또는 파일에 공개적으로 액세스할 수 있는지 여부를 나타냅니다.

파일 시스템에 대한 사용 권한을 설정하면 기존 사용 권한이 바뀝니다. 액세스 또는 containerAcl이 제공되지 않으면 기존 파일 시스템 ACL이 제거됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl 참조
setMetadata(Metadata, FileSystemSetMetadataOptions)

지정된 파일 시스템에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다.

옵션이 제공되지 않거나 매개 변수에 정의된 메타데이터가 없으면 파일 시스템 메타데이터가 제거됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata 참조
undeletePath(string, string, FileSystemUndeletePathOption)

일시 삭제된 경로를 복원합니다.

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

생성자 세부 정보

DataLakeFileSystemClient(string, Pipeline)

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

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

매개 변수

url

string

Azure Storage 데이터 레이크 파일 시스템을 가리키는 클라이언트 문자열(예: "https://myaccount.dfs.core.windows.net/filesystem")입니다. AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.dfs.core.windows.net/filesystem?sasString").

pipeline
Pipeline

newPipeline()을 호출하여 기본 파이프라인을 만들거나 사용자 지정된 파이프라인을 제공합니다.

DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

매개 변수

url

string

Azure Storage 데이터 레이크 파일 시스템을 가리키는 클라이언트 문자열(예: "https://myaccount.dfs.core.windows.net/filesystem")입니다. AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.dfs.core.windows.net/filesystem?sasString").

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

선택적. HTTP 파이프라인을 구성하는 옵션입니다.

속성 세부 정보

name

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

string name

속성 값

string

상속된 속성 세부 정보

accountName 

accountName: string

속성 값

string

StorageClient.accountName에서 상속된

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

속성 값

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

StorageClient.credential에서 상속된

url

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

url: string

속성 값

string

StorageClient.url에서 상속된

메서드 세부 정보

create(FileSystemCreateOptions)

지정된 계정 아래에 새 파일 시스템을 만듭니다. 이름이 같은 파일 시스템이 이미 있는 경우 작업이 실패합니다.

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

function create(options?: FileSystemCreateOptions): Promise<FileSystemCreateResponse>

매개 변수

options
FileSystemCreateOptions

선택적. 파일 시스템을 만들 때의 옵션입니다.

반환

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

지정된 계정 아래에 새 파일 시스템을 만듭니다. 이름이 같은 파일 시스템이 이미 있는 경우 변경되지 않습니다.

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

function createIfNotExists(options?: FileSystemCreateOptions): Promise<FileSystemCreateIfNotExistsResponse>

매개 변수

options
FileSystemCreateOptions

반환

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

현재 파일 시스템을 삭제합니다.

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

function delete(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteResponse>

매개 변수

options
FileSystemDeleteOptions

선택적. 파일 시스템을 삭제할 때의 옵션입니다.

반환

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

현재 파일 시스템이 있는 경우 삭제합니다.

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

function deleteIfExists(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteIfExistsResponse>

매개 변수

options
FileSystemDeleteOptions

반환

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

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

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

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

매개 변수

options
FileSystemExistsOptions

반환

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

공유 키 자격 증명으로 생성된 DataLakeFileSystemClient에만 사용할 수 있습니다.

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

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

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

매개 변수

options
FileSystemGenerateSasUrlOptions

선택적 매개 변수입니다.

반환

string

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

generateSasUrl(FileSystemGenerateSasUrlOptions)

공유 키 자격 증명으로 생성된 DataLakeFileSystemClient에만 사용할 수 있습니다.

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

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

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

매개 변수

options
FileSystemGenerateSasUrlOptions

선택적 매개 변수입니다.

반환

Promise<string>

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

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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

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

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

매개 변수

options
FileSystemGenerateSasUrlOptions

선택적 매개 변수입니다.

userDelegationKey
UserDelegationKey

blobServiceClient.getUserDelegationKey() 반환 값

반환

string

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

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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

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

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

매개 변수

options
FileSystemGenerateSasUrlOptions

선택적 매개 변수입니다.

userDelegationKey
UserDelegationKey

blobServiceClient.getUserDelegationKey() 반환 값

반환

Promise<string>

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

getAccessPolicy(FileSystemGetAccessPolicyOptions)

지정된 파일 시스템에 대한 권한을 가져옵니다. 사용 권한은 파일 시스템 데이터에 공개적으로 액세스할 수 있는지 여부를 나타냅니다.

경고: 구문 분석이 시작되고 expiresOn 문자열이 만료될 때 JavaScript 날짜의 전체 자릿수가 손실될 수 있습니다. 예를 들어 새 날짜("2018-12-31T03:44:23.8827891Z").toISOString()은 "2018-12-31T03:44:23.882Z"를 가져옵니다.

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

function getAccessPolicy(options?: FileSystemGetAccessPolicyOptions): Promise<FileSystemGetAccessPolicyResponse>

매개 변수

options
FileSystemGetAccessPolicyOptions

선택적. 파일 시스템 액세스 정책을 가져오는 경우의 옵션입니다.

반환

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

파일 시스템에서 임대를 관리하는 DataLakeLeaseClient 가져옵니다.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

매개 변수

proposeLeaseId

string

선택적. 처음 제안된 임대 ID입니다.

반환

DataLakeLeaseClient

getDirectoryClient(string)

현재 파일 시스템에서 DataLakeDirectoryClient 개체를 만듭니다.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

매개 변수

directoryName

string

반환

DataLakeDirectoryClient

getFileClient(string)

현재 파일 시스템에서 DataLakeFileClient 개체를 만듭니다.

function getFileClient(fileName: string): DataLakeFileClient

매개 변수

fileName

string

반환

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

지정된 파일 시스템에 대한 모든 사용자 정의 메타데이터 및 시스템 속성을 반환합니다.

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

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

function getProperties(options?: FileSystemGetPropertiesOptions): Promise<FileSystemGetPropertiesResponse>

매개 변수

options
FileSystemGetPropertiesOptions

선택적. 파일 시스템 속성을 가져오는 경우의 옵션입니다.

반환

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

지정된 파일 시스템의 모든 경로(디렉터리 및 파일)를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지의 경로를 나열합니다.

for await 구문을 사용하는 예제:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

iter.next()을(를) 사용하는 예제:

let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
  console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
  pathItem = await iter.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  for (const deletePath of response.pathItems) {
    console.log(`Path ${i++}: ${deletePath.name}`);
  }
}

표식과 함께 페이징을 사용하는 예제:

let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

https://docs.microsoft.com/rest/api/storageservices/list-blobs 참조

function listDeletedPaths(options?: ListDeletedPathsOptions): PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

매개 변수

options
ListDeletedPathsOptions

선택적. 삭제된 경로를 나열할 때의 옵션입니다.

반환

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

지정된 파일 시스템의 모든 경로(디렉터리 및 파일)를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지의 경로를 나열합니다.

for await 구문을 사용하는 예제:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

iter.next()을(를) 사용하는 예제:

let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
  console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
  pathItem = await iter.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
  }
}

표식과 함께 페이징을 사용하는 예제:

let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

https://docs.microsoft.com/rest/api/storageservices/list-blobs 참조

function listPaths(options?: ListPathsOptions): PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

매개 변수

options
ListPathsOptions

선택적. 경로를 나열할 때의 옵션입니다.

반환

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

지정된 파일 시스템에 대한 사용 권한을 설정합니다. 사용 권한은 파일 시스템의 디렉터리 또는 파일에 공개적으로 액세스할 수 있는지 여부를 나타냅니다.

파일 시스템에 대한 사용 권한을 설정하면 기존 사용 권한이 바뀝니다. 액세스 또는 containerAcl이 제공되지 않으면 기존 파일 시스템 ACL이 제거됩니다.

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

function setAccessPolicy(access?: PublicAccessType, fileSystemAcl?: SignedIdentifier<AccessPolicy>[], options?: FileSystemSetAccessPolicyOptions): Promise<FileSystemSetAccessPolicyResponse>

매개 변수

access
PublicAccessType

선택적. 파일 시스템의 데이터에 대한 공용 액세스 수준입니다.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

선택적. 각각 고유한 ID와 액세스 정책의 세부 정보를 갖는 요소의 배열입니다.

options
FileSystemSetAccessPolicyOptions

선택적. 파일 시스템 액세스 정책을 설정할 때의 옵션입니다.

반환

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

지정된 파일 시스템에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다.

옵션이 제공되지 않거나 매개 변수에 정의된 메타데이터가 없으면 파일 시스템 메타데이터가 제거됩니다.

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

function setMetadata(metadata?: Metadata, options?: FileSystemSetMetadataOptions): Promise<FileSystemSetMetadataResponse>

매개 변수

metadata
Metadata

기존 메타데이터를 이 값으로 대체합니다. 제공된 값이 없으면 기존 메타데이터가 제거됩니다.

options
FileSystemSetMetadataOptions

선택적. 파일 시스템 메타데이터를 설정할 때의 옵션입니다.

반환

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

일시 삭제된 경로를 복원합니다.

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

function undeletePath(deletedPath: string, deletionId: string, options?: FileSystemUndeletePathOption): Promise<FileSystemUndeletePathResponse>

매개 변수

deletedPath

string

필수. 삭제된 경로의 경로입니다.

deletionId

string

필수. 일시 삭제된 경로와 연결된 삭제 ID입니다.

options
FileSystemUndeletePathOption

반환

Promise<FileSystemUndeletePathResponse>