ShareClient class

ShareClient 인스턴스를 만듭니다.

new ShareClient(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions)

매개 변수

ShareClient 인스턴스를 만듭니다.

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

매개 변수

new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)

매개 변수

공유의 이름

string name

속성 값

이 공유의 루트 디렉터리에 대한 디렉터리 클라이언트를 가져옵니다. 루트 디렉터리가 항상 존재하며 삭제할 수 없습니다.

루트 디렉터리에 대한 새 ShareDirectoryClient 개체입니다.

ShareDirectoryClient rootDirectoryClient

속성 값

accountName: string

속성 값

상속된 위치에서 StorageClient.accountName

URL 문자열 값입니다.

url: string

속성 값

상속된 위치에서 StorageClient.url

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

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

function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

매개 변수

반환

공유 만들기 작업에 대한 응답 데이터입니다.

이 공유 아래에 새 하위 디렉터리를 만듭니다.

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

function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

매개 변수

반환

디렉터리 생성 응답 데이터 및 해당 디렉터리 클라이언트.

새 파일을 만들거나 이 공유의 루트 디렉터리 아래에 있는 파일을 바꿉니다. 콘텐츠가 없는 파일만 초기화합니다.

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

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

매개 변수

반환

파일 만들기 응답 데이터 및 해당 파일 클라이언트.

지정된 계정 아래에 새 공유를 만듭니다. 동일한 이름의 공유가 이미 있는 경우 변경되지 않습니다.

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

function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>

매개 변수

반환

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

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

function createPermission(filePermission: string, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

매개 변수

반환

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

function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

매개 변수

반환

스냅샷 만들기 작업에 대한 응답 데이터입니다.

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

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

function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

매개 변수

반환

공유 삭제 작업에 대한 응답 데이터입니다.

이 공유에서 지정된 빈 하위 디렉터리를 제거합니다. 디렉터리는 비어 있어야 삭제할 수 있습니다.

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

function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

매개 변수

반환

디렉터리 삭제 응답 데이터입니다.

스토리지 계정에서 이 공유의 루트 디렉터리 아래에 있는 파일을 제거합니다. 파일을 성공적으로 삭제하면 저장소 계정의 인덱스에서 즉시 제거되며, 클라이언트에서 더 이상 액세스할 수 없습니다. 파일의 데이터는 나중에 가비지 수집 중에 서비스에서 제거됩니다.

파일이 SMB 클라이언트에서 열려 있는 경우 파일 삭제는 상태 코드 409(충돌) 및 오류 코드 SharingViolation 로 실패합니다.

파일 삭제는 공유의 읽기 전용 복사본인 공유 스냅샷에서 지원되지 않습니다. 공유 스냅샷에서 이 작업을 수행하려고 하면 400(InvalidQueryParameterValue)으로 실패합니다.

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

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

매개 변수

반환

Promise 파일 삭제 응답 데이터입니다.

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

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

function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>

매개 변수

반환

이 클라이언트가 나타내는 Azrue 공유 리소스가 있으면 true를 반환합니다. false이면 이고, 그렇지 않으면 입니다.

참고: 다른 클라이언트 또는 애플리케이션에서 기존 공유를 삭제할 수 있기 때문에 이 함수를 주의해서 사용합니다. 그 반대의 경우도 마찬가지입니다. 이 함수가 완료된 후 다른 클라이언트 또는 애플리케이션에서 새 공유를 추가할 수 있습니다.

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

매개 변수

반환

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

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

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

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

매개 변수

반환

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

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

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

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

function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

매개 변수

반환

액세스 정책 공유 작업에 대한 응답 데이터입니다.

ShareDirectoryClient 개체를 만듭니다.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

매개 변수

반환

지정된 디렉터리 이름의 ShareDirectoryClient 개체입니다.

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

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

function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

매개 변수

반환

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

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

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

function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

매개 변수

반환

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

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

function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

매개 변수

반환

통계 가져오기 공유 작업에 대한 응답 데이터입니다.

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

공유에 대한 권한을 설정하면 기존 사용 권한이 대체됩니다. shareAcl이 제공되지 않으면 기존 공유 ACL이 제거됩니다.

공유에 저장된 액세스 정책을 설정하는 경우 적용하는 데 최대 30초가 걸릴 수 있습니다. 저장된 액세스 정책이 활성 상태가 될 때까지 이 간격 동안 해당 액세스 정책과 연결된 공유된 액세스 서명이 실패하면 상태 코드 403(사용할 수 없음)이 표시됩니다.

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

function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

매개 변수

반환

공유 집합 액세스 정책 작업에 대한 응답 데이터입니다.

지정된 공유에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다.

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

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

function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

매개 변수

반환

공유 집합 메타데이터 작업에 대한 응답 데이터입니다.

공유의 속성을 설정합니다.

function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>

매개 변수

반환

공유 집합 속성 작업에 대한 응답 데이터입니다.

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

function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

매개 변수

반환

공유 할당량 가져오기 작업에 대한 응답 데이터입니다.

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

function withSnapshot(snapshot: string): ShareClient

매개 변수

반환

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