ShareServiceClient class

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

new ShareServiceClient(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions)

매개 변수

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

new ShareServiceClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

매개 변수

accountName: string

속성 값

StorageClient.accountName에서 상속된

URL 문자열 값입니다.

url: string

속성 값

StorageClient.url에서 상속된

공유를 만듭니다.

function createShare(shareName: string, options?: ShareCreateOptions): Promise<{ shareClient: ShareClient, shareCreateResponse: ShareCreateResponse }>

매개 변수

반환

만들기 응답 및 해당 공유 클라이언트를 공유합니다.

공유를 삭제합니다.

function deleteShare(shareName: string, options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

매개 변수

반환

삭제 응답 및 해당 공유 클라이언트를 공유합니다.

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

static function fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient

매개 변수

반환

지정된 연결 문자열의 새 ShareServiceClient입니다.

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

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

https://learn.microsoft.com/rest/api/storageservices/create-account-sas 참조

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

매개 변수

반환

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

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

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

https://learn.microsoft.com/rest/api/storageservices/create-account-sas 참조

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

매개 변수

반환

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

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

https://learn.microsoft.com/rest/api/storageservices/get-file-service-properties 참조

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

매개 변수

반환

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

ShareClient 개체를 만듭니다.

function getShareClient(shareName: string): ShareClient

매개 변수

반환

지정된 공유 이름의 ShareClient 개체입니다.

사용 예:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const shareClient = serviceClient.getShareClient(shareName);
await shareClient.create();

지정된 계정의 모든 공유를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지에 공유를 나열합니다.

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

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const share of serviceClient.listShares()) {
  console.log(`Share${i++}: ${share.name}`);
}

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

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareIter = serviceClient.listShares();
let i = 1;
let { value, done } = await shareIter.next();
while (!done) {
  console.log(`Share ${i++}: ${value.name}`);
  ({ value, done } = await shareIter.next());
}

byPage()사용하는 예제:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
  console.log(`Page ${i++}:`);
  for (const share of response.shareItems || []) {
    console.log(`\tShare: ${share.name}`);
  }
}

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

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

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

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

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

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

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

function listShares(options?: ServiceListSharesOptions): PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

매개 변수

반환

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

https://learn.microsoft.com/rest/api/storageservices/set-file-service-properties 참조

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

매개 변수

반환

속성 설정 작업에 대한 응답 데이터입니다.

이전에 삭제된 공유를 복원합니다. 이 API는 공유와 연결된 스토리지 계정에 대해 공유 일시 삭제를 사용하도록 설정한 경우에만 작동합니다.

function undeleteShare(deletedShareName: string, deletedShareVersion: string, options?: ServiceUndeleteShareOptions): Promise<ShareClient>

매개 변수

반환

복원된 공유.