ShareURL class

패키지:

@azure/storage-file

ShareURL은 Azure Storage 공유에 대한 URL을 나타내며, 이를 통해 해당 디렉터리와 파일을 조작할 수 있습니다.

Extends

StorageURL

생성자

ShareURL(string, Pipeline)

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

속성

pipeline	요청 정책 파이프라인입니다.
url	URL 문자열 값입니다.

메서드

create(Aborter, IShareCreateOptions)	지정된 계정 아래에 새 공유를 만듭니다. 동일한 이름의 공유가 이미 있는 경우 작업이 실패합니다.
createPermission(Aborter, string)	공유 수준에서 파일 권한(보안 설명자)을 만듭니다. 만든 보안 설명자는 공유의 파일/디렉터리에 사용할 수 있습니다.
createSnapshot(Aborter, IShareCreateSnapshotOptions)	공유의 읽기 전용 스냅샷을 만듭니다.
delete(Aborter, IShareDeleteMethodOptions)	삭제할 지정된 공유를 표시합니다. 공유 및 그 안에 포함된 모든 디렉터리 또는 파일은 나중에 가비지 수집 중에 삭제됩니다.
fromServiceURL(ServiceURL, string)	ServiceURL에서 ShareURL 개체를 만듭니다.
getAccessPolicy(Aborter)	지정된 공유에 대한 사용 권한을 가져옵니다. 사용 권한은 공유 데이터에 공개적으로 액세스할 수 있는지 여부를 나타냅니다. 경고: JavaScript 날짜는 시작 및 만료 문자열을 구문 분석할 때 전체 자릿수가 손실될 수 있습니다. 예를 들어 새 날짜("2018-12-31T03:44:23.8827891Z").toISOString()은 "2018-12-31T03:44:23.882Z"를 가져옵니다.
getPermission(Aborter, string)	보안 설명자를 나타내는 지정된 파일 권한 키에 대한 SDDL(보안 설명자 정의 언어)을 가져옵니다.
getProperties(Aborter)	지정된 공유에 대한 모든 사용자 정의 메타데이터 및 시스템 속성을 반환합니다.
getStatistics(Aborter)	공유와 관련된 통계를 검색합니다.
newPipeline(Credential, INewPipelineOptions)	자격 증명이 제공된 새 Pipeline 개체를 만드는 데 사용되는 정적 메서드입니다.
setAccessPolicy(Aborter, ISignedIdentifier[])	지정된 공유에 대한 사용 권한을 설정합니다. 사용 권한은 공유의 디렉터리 또는 파일에 공개적으로 액세스할 수 있는지 여부를 나타냅니다. 공유에 대한 사용 권한을 설정하면 기존 사용 권한이 바뀝니다. shareAcl을 제공하지 않으면 기존 공유 ACL이 제거됩니다.
setMetadata(Aborter, IMetadata)	지정된 공유에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다. 옵션이 제공되지 않거나 옵션 매개 변수에 정의된 메타데이터가 없으면 공유 메타데이터가 제거됩니다.
setQuota(Aborter, number)	지정된 공유에 대한 할당량을 설정합니다.
withPipeline(Pipeline)	원본과 동일하지만 지정된 요청 정책 파이프라인을 사용하여 새 ShareURL 개체를 만듭니다.
withSnapshot(string)	원본과 동일하지만 지정된 스냅샷 타임스탬프를 사용하여 새 ShareURL 개체를 만듭니다. ""을 입력하면 스냅샷이 제거되고 URL이 기본 공유로 반환됩니다.

생성자 세부 정보

ShareURL(string, Pipeline)

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

new ShareURL(url: string, pipeline: Pipeline)

매개 변수

url

string

Azure Storage 파일 공유를 가리키는 URL 문자열(예: "https://myaccount.file.core.windows.net/share") AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.file.core.windows.net/share?sasString").

pipeline

Pipeline

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

속성 세부 정보

pipeline

요청 정책 파이프라인입니다.

pipeline: Pipeline

속성 값

Pipeline

url

URL 문자열 값입니다.

url: string

속성 값

string

메서드 세부 정보

create(Aborter, IShareCreateOptions)

지정된 계정 아래에 새 공유를 만듭니다. 동일한 이름의 공유가 이미 있는 경우 작업이 실패합니다.

function create(aborter: Aborter, options?: IShareCreateOptions)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

options

IShareCreateOptions

반환

Promise<Models.ShareCreateResponse>

createPermission(Aborter, string)

공유 수준에서 파일 권한(보안 설명자)을 만듭니다. 만든 보안 설명자는 공유의 파일/디렉터리에 사용할 수 있습니다.

function createPermission(aborter: Aborter, filePermission: string)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

filePermission

string

SDDL에 설명된 파일 권한

반환

Promise<Models.ShareCreatePermissionResponse>

createSnapshot(Aborter, IShareCreateSnapshotOptions)

공유의 읽기 전용 스냅샷을 만듭니다.

function createSnapshot(aborter: Aborter, options?: IShareCreateSnapshotOptions)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

options

IShareCreateSnapshotOptions

반환

Promise<Models.ShareCreateSnapshotResponse>

delete(Aborter, IShareDeleteMethodOptions)

삭제할 지정된 공유를 표시합니다. 공유 및 그 안에 포함된 모든 디렉터리 또는 파일은 나중에 가비지 수집 중에 삭제됩니다.

function delete(aborter: Aborter, options?: IShareDeleteMethodOptions)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

options

IShareDeleteMethodOptions

반환

Promise<Models.ShareDeleteResponse>

fromServiceURL(ServiceURL, string)

ServiceURL에서 ShareURL 개체를 만듭니다.

static function fromServiceURL(serviceURL: ServiceURL, shareName: string)

매개 변수

serviceURL

ServiceURL

shareName

string

반환

ShareURL

getAccessPolicy(Aborter)

지정된 공유에 대한 사용 권한을 가져옵니다. 사용 권한은 공유 데이터에 공개적으로 액세스할 수 있는지 여부를 나타냅니다. 경고: JavaScript 날짜는 시작 및 만료 문자열을 구문 분석할 때 전체 자릿수가 손실될 수 있습니다. 예를 들어 새 날짜("2018-12-31T03:44:23.8827891Z").toISOString()은 "2018-12-31T03:44:23.882Z"를 가져옵니다.

function getAccessPolicy(aborter: Aborter)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

반환

Promise<ShareGetAccessPolicyResponse>

getPermission(Aborter, string)

보안 설명자를 나타내는 지정된 파일 권한 키에 대한 SDDL(보안 설명자 정의 언어)을 가져옵니다.

function getPermission(aborter: Aborter, filePermissionKey: string)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

filePermissionKey

string

사용 권한의 보안 설명자를 나타내는 파일 권한 키입니다.

반환

Promise<Models.ShareGetPermissionResponse>

getProperties(Aborter)

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

function getProperties(aborter: Aborter)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

반환

Promise<Models.ShareGetPropertiesResponse>

getStatistics(Aborter)

공유와 관련된 통계를 검색합니다.

function getStatistics(aborter: Aborter)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

반환

Promise<ShareGetStatisticsResponse>

newPipeline(Credential, INewPipelineOptions)

자격 증명이 제공된 새 Pipeline 개체를 만드는 데 사용되는 정적 메서드입니다.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

매개 변수

credential

Credential

AnonymousCredential, SharedKeyCredential 등의

pipelineOptions

INewPipelineOptions

반환

Pipeline

새 Pipeline 개체입니다.

setAccessPolicy(Aborter, ISignedIdentifier[])

지정된 공유에 대한 사용 권한을 설정합니다. 사용 권한은 공유의 디렉터리 또는 파일에 공개적으로 액세스할 수 있는지 여부를 나타냅니다. 공유에 대한 사용 권한을 설정하면 기존 사용 권한이 바뀝니다. shareAcl을 제공하지 않으면 기존 공유 ACL이 제거됩니다.

function setAccessPolicy(aborter: Aborter, shareAcl?: ISignedIdentifier[])

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

shareAcl

ISignedIdentifier[]

반환

Promise<Models.ShareSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

지정된 공유에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다. 옵션이 제공되지 않거나 옵션 매개 변수에 정의된 메타데이터가 없으면 공유 메타데이터가 제거됩니다.

function setMetadata(aborter: Aborter, metadata?: IMetadata)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

metadata

IMetadata

반환

Promise<Models.ShareSetMetadataResponse>

setQuota(Aborter, number)

지정된 공유에 대한 할당량을 설정합니다.

function setQuota(aborter: Aborter, quotaInGB: number)

매개 변수

aborter

Aborter

Aborter.none 또는 Aborter.timeout()을 사용하여 새 Aborter 인스턴스를 만듭니다. 요청 취소에 대한 자세한 예제를 보려면 Aborter의 goto 문서

quotaInGB

number

공유의 최대 크기(기가바이트)를 지정합니다.

반환

Promise<Models.ShareSetQuotaResponse>

withPipeline(Pipeline)

원본과 동일하지만 지정된 요청 정책 파이프라인을 사용하여 새 ShareURL 개체를 만듭니다.

function withPipeline(pipeline: Pipeline)

매개 변수

pipeline

Pipeline

반환

ShareURL

withSnapshot(string)

원본과 동일하지만 지정된 스냅샷 타임스탬프를 사용하여 새 ShareURL 개체를 만듭니다. ""을 입력하면 스냅샷이 제거되고 URL이 기본 공유로 반환됩니다.

function withSnapshot(snapshot: string)

매개 변수

snapshot

string

반환

ShareURL

원본과 동일하지만 지정된 스냅샷 타임스탬프가 있는 새 ShareURL 개체