DataLakeServiceClient class

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

new DataLakeServiceClient(url: string, pipeline: Pipeline)

매개 변수

URL에서 DataLakeServiceClient의 인스턴스를 만듭니다.

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

매개 변수

accountName: string

속성 값

상속된 위치에서 StorageClient.accountName

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

속성 값

상속된 위치에서 StorageClient.credential

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

url: string

속성 값

상속된 위치에서 StorageClient.url

연결 문자열에서 DataLakeServiceClient의 인스턴스를 만듭니다.

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): DataLakeServiceClient

매개 변수

반환

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

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

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

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

매개 변수

반환

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

DataLakeFileSystemClient 개체를 만듭니다.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

매개 변수

반환

스토리지 분석 및 CORS(원본 간 리소스 공유) 규칙에 대한 속성을 포함하여 스토리지 계정의 Blob 서비스 엔드포인트 속성을 가져옵니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties를 참조하세요.

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

매개 변수

반환

서비스 속성 가져오기 작업에 대한 응답 데이터입니다.

전달자 토큰 인증(TokenCredential)을 사용하는 경우에만 사용할 수 있습니다.

Data Lake 서비스의 사용자 위임 키를 검색합니다. 이는 전달자 토큰 인증을 사용하는 경우에만 유효한 작업입니다.

예제

// 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, // Required. Date type
    expiresOn, // Optional. 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();

https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key를 참조하세요.

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

매개 변수

반환

지정된 계정 아래의 모든 파일 시스템을 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 파일 시스템을 페이지에 나열합니다.

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

let i = 1;
for await (const fileSystem of serviceClient.listFileSystems()) {
  console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}

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

let i = 1;
const iter = serviceClient.listFileSystems();
let fileSystemItem = await iter.next();
while (!fileSystemItem.done) {
  console.log(`FileSystem ${i++}: ${fileSystemItem.value.name}`);
  fileSystemItem = await iter.next();
}

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

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of serviceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
  if (response.fileSystemItems) {
    for (const fileSystem of response.fileSystemItems) {
      console.log(`FileSystem ${i++}: ${fileSystem.name}`);
    }
  }
}

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

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

// Prints 2 file system names
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`FileSystem ${i++}: ${fileSystem.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = serviceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 file system names
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
     console.log(`FileSystem ${i++}: ${fileSystem.name}`);
  }
}

https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2를 참조하세요.

function listFileSystems(options?: ServiceListFileSystemsOptions): PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

매개 변수

반환

스토리지 분석, CORS(원본 간 리소스 공유) 규칙 및 일시 삭제 설정에 대한 속성을 포함하여 스토리지 계정의 Blob 서비스 엔드포인트에 대한 속성을 설정합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties를 참조하세요.

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

매개 변수

반환

서비스 집합 속성 작업에 대한 응답 데이터입니다.

이전에 삭제한 파일 시스템을 복원합니다. 이 API는 스토리지 계정에 대해 컨테이너 일시 삭제를 사용하도록 설정한 경우에만 작동합니다.

function undeleteFileSystem(deletedFileSystemName: string, deleteFileSystemVersion: string, options?: ServiceUndeleteFileSystemOptions): Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>

매개 변수

반환