AppendBlobClient class

참조

패키지:: @azure/storage-blob

AppendBlobClient는 추가 Blob에 적용할 수 있는 작업 집합을 정의합니다.

Extends: BlobClient

생성자

AppendBlobClient(string, PipelineLike)	AppendBlobClient의 인스턴스를 만듭니다. 이 메서드는 추가 Blob을 가리키는 인코딩된 URL 또는 인코딩하지 않은 URL을 허용합니다. 인코딩된 URL 문자열은 두 번 이스케이프되지 않으며 URL 경로의 특수 문자만 이스케이프됩니다. Blob 이름에 ? 또는 %, Blob 이름은 URL에 인코딩되어야 합니다.
AppendBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	AppendBlobClient의 인스턴스를 만듭니다. 이 메서드는 추가 Blob을 가리키는 인코딩된 URL 또는 인코딩하지 않은 URL을 허용합니다. 인코딩된 URL 문자열은 두 번 이스케이프되지 않으며 URL 경로의 특수 문자만 이스케이프됩니다. Blob 이름에 ? 또는 %, Blob 이름은 URL에 인코딩되어야 합니다.
AppendBlobClient(string, string, string, StoragePipelineOptions)	AppendBlobClient의 인스턴스를 만듭니다.

속성

containerName	Blob이 연결된 스토리지 컨테이너의 이름입니다.
name	blob의 이름입니다.

상속된 속성

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

메서드

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)	기존 추가 Blob의 끝에 새 데이터 블록을 커밋합니다. https://docs.microsoft.com/rest/api/storageservices/append-block를 참조하세요.
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	블록 추가 작업은 원본 URL에서 내용을 읽는 기존 추가 Blob의 끝에 새 데이터 블록을 커밋합니다. https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url를 참조하세요.
create(AppendBlobCreateOptions)	0 길이의 추가 Blob을 만듭니다. AppendBlock을 호출하여 추가 Blob에 데이터를 추가합니다. https://docs.microsoft.com/rest/api/storageservices/put-blob를 참조하세요.
createIfNotExists(AppendBlobCreateIfNotExistsOptions)	0 길이의 추가 Blob을 만듭니다. AppendBlock을 호출하여 추가 Blob에 데이터를 추가합니다. 이름이 같은 Blob이 이미 있는 경우 기존 Blob의 콘텐츠는 변경되지 않은 상태로 유지됩니다. https://docs.microsoft.com/rest/api/storageservices/put-blob를 참조하세요.
seal(AppendBlobSealOptions)	추가 Blob을 봉인하여 읽기 전용으로 만듭니다.
withSnapshot(string)	원본과 동일하지만 지정된 스냅샷 타임스탬프를 사용하여 새 AppendBlobClient 개체를 만듭니다. ""를 제공하면 스냅샷이 제거되고 클라이언트가 기본 Blob으로 반환됩니다.

상속된 메서드

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	보류 중인 비동기 Blob 복사 작업을 중단하고 길이가 0이고 전체 메타데이터가 있는 대상 Blob을 남깁니다. 버전 2012-02-12 이상. https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob를 참조하세요.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	스토리지 계정 내의 대상에 Blob을 비동기적으로 복사합니다. 이 메서드는 복사가 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다. 폴러에서 를 호출 `cancelOperation` 하여 복사본을 완료하기 전에 취소할 수도 있습니다. 첫 번째 요청에서 작업이 완료되고 완료된 복사본을 취소하려고 하면 오류가 throw되는 경우 onProgress 콜백이 호출되지 않습니다. 버전 2012-02-12 이상에서는 Blob 복사 작업의 원본이 모든 Azure Storage 계정에서 커밋된 Blob일 수 있습니다. 버전 2015-02-21부터 Blob 복사 작업의 원본은 모든 Azure Storage 계정의 Azure 파일일 수 있습니다. 다른 저장소 계정으로부터의 Blob 복사 작업은 2012년 6월 7일 이후 생성된 저장소 계정에서만 허용됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob를 참조하세요. 자동 폴링을 사용하는 예제: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` 수동 폴링을 사용하는 예제: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` 진행률 업데이트를 사용하는 예제: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); 폴링 간격 변경(기본값 15초)을 사용하는 예제: `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` 복사 취소를 사용하는 예제: `const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	Blob의 읽기 전용 스냅숏을 만듭니다. https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob를 참조하세요.
delete(BlobDeleteOptions)	삭제할 지정된 Blob 또는 스냅샷을 표시합니다. 이 blob는 나중에 가비지 수집 중에 삭제됩니다. Blob을 삭제하려면 해당 스냅숏을 모두 삭제해야 합니다. Blob 삭제 작업과 동시에 둘 다 삭제할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob를 참조하세요.
deleteIfExists(BlobDeleteOptions)	삭제할 지정된 Blob 또는 스냅샷(있는 경우)을 표시합니다. 이 blob는 나중에 가비지 수집 중에 삭제됩니다. Blob을 삭제하려면 해당 스냅숏을 모두 삭제해야 합니다. Blob 삭제 작업과 동시에 둘 다 삭제할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob를 참조하세요.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Blob에서 immutablility 정책을 삭제합니다.
download(number, number, BlobDownloadOptions)	메타데이터 및 속성을 포함하여 시스템에서 Blob을 읽거나 다운로드합니다. Blob 가져오기를 호출하여 스냅샷을 읽을 수도 있습니다. Node.js 데이터는 읽기 가능한 스트림 읽기 가능StreamBody에서 반환됩니다. 브라우저에서 데이터는 promise blobBody로 반환됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob를 참조하세요.
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	NODE.JS 런타임에서만 사용할 수 있습니다. 버퍼와 병렬로 Azure Blob을 다운로드합니다. 오프셋 및 개수는 선택 사항이며, 제공되지 않은 경우 전체 Blob을 다운로드합니다. 경고: 버퍼는 Node.js/V8의 제한으로 인해 32비트 시스템에서 최대 1기가바이트 또는 64비트 시스템에서 약 2기가바이트의 파일만 지원할 수 있습니다. 이 크기보다 큰 Blob의 경우 downloadToFile을 고려합니다.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NODE.JS 런타임에서만 사용할 수 있습니다. 버퍼와 병렬로 Azure Blob을 다운로드합니다. 오프셋 및 개수는 선택 사항이며, 제공되지 않은 경우 전체 Blob을 다운로드합니다. 경고: 버퍼는 Node.js/V8의 제한으로 인해 32비트 시스템에서 최대 1기가바이트 또는 64비트 시스템에서 약 2기가바이트의 파일만 지원할 수 있습니다. 이 크기보다 큰 Blob의 경우 downloadToFile을 고려합니다.
downloadToFile(string, number, number, BlobDownloadOptions)	NODE.JS 런타임에서만 사용할 수 있습니다. Azure Blob을 로컬 파일에 다운로드합니다. 지정된 파일 경로가 이미 종료되면 실패합니다. 오프셋 및 개수는 선택 사항이며, 전체 Blob을 다운로드하기 위해 각각 0 및 undefined를 전달합니다.
exists(BlobExistsOptions)	이 클라이언트가 나타내는 Azure Blob 리소스가 있으면 true를 반환합니다. false이면 이고, 그렇지 않으면 입니다. 참고: 기존 Blob이 다른 클라이언트 또는 애플리케이션에서 삭제될 수 있기 때문에 이 함수를 주의해서 사용합니다. 그 반대의 경우도 마찬가지입니다. 이 함수가 완료된 후 다른 클라이언트 또는 애플리케이션에서 새 Blob을 추가할 수 있습니다.
generateSasUrl(BlobGenerateSasUrlOptions)	공유 키 자격 증명을 사용하여 생성된 BlobClient에만 사용할 수 있습니다. 전달된 클라이언트 속성 및 매개 변수를 기반으로 Blob Service SAS(공유 액세스 서명) URI를 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas를 참조하세요.
getAppendBlobClient()	AppendBlobClient 개체를 만듭니다.
getBlobLeaseClient(string)	Blob에서 임대를 관리하는 BlobLeaseClient 를 가져옵니다.
getBlockBlobClient()	BlockBlobClient 개체를 만듭니다.
getPageBlobClient()	PageBlobClient 개체를 만듭니다.
getProperties(BlobGetPropertiesOptions)	blob에 대한 모든 사용자 정의 메타데이터, 표준 HTTP 속성 및 시스템 속성을 반환합니다. blob의 콘텐츠는 반환하지 않습니다. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties를 참조하세요. 경고: 응답에서 반환된 개체에는 `metadata` 원래 대문자가 포함되어 있더라도 해당 키가 소문자로 표시됩니다. 이는 원래 대/소문자를 유지하는 옵션을 사용하여 `includeMetadata` Blob을 나열하는 ContainerClient 메서드에서 반환하는 메타데이터 키와 다릅니다.
getTags(BlobGetTagsOptions)	기본 Blob과 연결된 태그를 가져옵니다.
setAccessTier(string, BlobSetTierOptions)	Blob에서 계층을 설정합니다. 이 작업은 Premium Storage 계정의 페이지 Blob 및 Blob Storage 계정의 블록 Blob에서 허용됩니다(로컬 중복 스토리지에만 해당). 프리미엄 페이지 Blob 계층은 Blob의 허용되는 크기, IOPS 및 대역폭을 결정합니다. 블록 Blob의 계층은 핫/쿨/보관 스토리지 유형을 결정합니다. 이 작업은 Blob의 ETag를 업데이트하지 않습니다. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier를 참조하세요.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Blob의 시스템 속성을 설정합니다. 값이 제공되지 않거나 지정된 Blob HTTP 헤더에 대해 제공된 값이 없는 경우 값이 없는 이러한 Blob HTTP 헤더는 지워질 것입니다. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties를 참조하세요.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Blob에서 immutablility 정책을 설정합니다.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Blob에 대한 법적 보존을 설정합니다.
setMetadata(Metadata, BlobSetMetadataOptions)	하나 이상의 이름 값 쌍으로 지정된 Blob에 대한 사용자 정의 메타데이터를 설정합니다. 옵션이 제공되지 않거나 매개 변수에 정의된 메타데이터가 없으면 Blob 메타데이터가 제거됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata를 참조하세요.
setTags(Tags, BlobSetTagsOptions)	기본 Blob에 태그를 설정합니다. Blob에는 최대 10개의 태그가 있을 수 있습니다. 태그 키는 1자에서 128자 사이여야 합니다. 태그 값은 0자에서 256자 사이여야 합니다. 유효한 태그 키 및 값 문자에는 소문자 및 대문자, 숫자(0-9), 공백(''), 더하기('+'), 빼기('-'), 마침표('.'), 슬래시('/'), 콜론(':'), 등호('=') 및 밑줄('_')이 포함됩니다.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	URL에서 동기 복사 작업은 Blob 또는 인터넷 리소스를 새 Blob에 복사합니다. 복사가 완료될 때까지 응답을 반환하지 않습니다. https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url를 참조하세요.
undelete(BlobUndeleteOptions)	일시 삭제된 Blob 및 연결된 일시 삭제된 스냅샷의 내용과 메타데이터를 복원합니다. 삭제 취소 Blob은 버전 2017-07-29 이상에서만 지원됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob를 참조하세요.
withVersion(string)	이 Blob의 버전을 가리키는 새 BlobClient 개체를 만듭니다. ""을 입력하면 versionId가 제거되고 클라이언트가 기본 Blob으로 반환됩니다.

생성자 세부 정보

AppendBlobClient(string, PipelineLike)

AppendBlobClient의 인스턴스를 만듭니다. 이 메서드는 추가 Blob을 가리키는 인코딩된 URL 또는 인코딩하지 않은 URL을 허용합니다. 인코딩된 URL 문자열은 두 번 이스케이프되지 않으며 URL 경로의 특수 문자만 이스케이프됩니다. Blob 이름에 ? 또는 %, Blob 이름은 URL에 인코딩되어야 합니다.

new AppendBlobClient(url: string, pipeline: PipelineLike)

매개 변수

url: string

Azure Storage 추가 Blob(예: "https://myaccount.blob.core.windows.net/mycontainer/appendblob")을 가리키는 URL 문자열입니다. AnonymousCredential(예: "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString")을 사용하는 경우 SAS를 추가할 수 있습니다. 이 메서드는 Blob을 가리키는 인코딩된 URL 또는 인코딩하지 않은 URL을 허용합니다. 인코딩된 URL 문자열은 두 번 이스케이프되지 않으며 URL 경로의 특수 문자만 이스케이프됩니다. 그러나 Blob 이름에 ? 또는 %, Blob 이름은 URL에 인코딩되어야 합니다. "my?blob%"이라는 Blob과 같이 URL은 "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"이어야 합니다.

pipeline: PipelineLike

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

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

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

매개 변수

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

(선택 사항) HTTP 파이프라인을 구성하는 옵션입니다.

AppendBlobClient(string, string, string, StoragePipelineOptions)

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

new AppendBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

매개 변수

connectionString: string

계정 연결 문자열 또는 Azure Storage 계정의 SAS 연결 문자열입니다. [ 참고 - 계정 연결 문자열은 NODE.JS 런타임에서만 사용할 수 있습니다. ] 계정 연결 문자열 예제 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS 연결 문자열 예제 - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName: string

컨테이너 이름

blobName: string

Blob 이름입니다.

options: StoragePipelineOptions

(선택 사항) HTTP 파이프라인을 구성하는 옵션입니다.

속성 세부 정보

containerName

Blob이 연결된 스토리지 컨테이너의 이름입니다.

string containerName

속성 값

string

name

blob의 이름입니다.

string name

속성 값

string

상속된 속성 세부 정보

accountName

accountName: string

속성 값

string

BlobClient.accountName에서 상속됨

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

속성 값

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

BlobClient.credential에서 상속됨

url

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

url: string

속성 값

string

BlobClient.url에서 상속됨

메서드 세부 정보

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

기존 추가 Blob의 끝에 새 데이터 블록을 커밋합니다.

https://docs.microsoft.com/rest/api/storageservices/append-block를 참조하세요.

function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

매개 변수

body: HttpRequestBody

추가할 데이터입니다.

contentLength: number

본문의 길이(바이트)입니다.

options: AppendBlobAppendBlockOptions

블록 추가 작업에 대한 옵션입니다.

예제 사용법:

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

반환

Promise<AppendBlobAppendBlockResponse>

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

블록 추가 작업은 원본 URL에서 내용을 읽는 기존 추가 Blob의 끝에 새 데이터 블록을 커밋합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url를 참조하세요.

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

매개 변수

sourceURL: string

복사본의 원본이 될 Blob의 URL입니다. 동일한 스토리지 계정의 원본 Blob은 공유 키를 통해 인증할 수 있습니다. 그러나 원본이 다른 계정의 Blob인 경우 원본 Blob은 공용이거나 공유 액세스 서명을 통해 인증되어야 합니다. 원본 Blob이 공용인 경우 작업을 수행하기 위해 인증이 필요하지 않습니다.

sourceOffset: number

추가할 원본의 오프셋

count: number

블록으로 추가할 바이트 수

options: AppendBlobAppendBlockFromURLOptions

반환

Promise<AppendBlobAppendBlockFromUrlResponse>

create(AppendBlobCreateOptions)

0 길이의 추가 Blob을 만듭니다. AppendBlock을 호출하여 추가 Blob에 데이터를 추가합니다.

https://docs.microsoft.com/rest/api/storageservices/put-blob를 참조하세요.

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

매개 변수

options: AppendBlobCreateOptions

블록 만들기 추가 작업에 대한 옵션입니다.

예제 사용법:

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

반환

Promise<AppendBlobCreateResponse>

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

0 길이의 추가 Blob을 만듭니다. AppendBlock을 호출하여 추가 Blob에 데이터를 추가합니다. 이름이 같은 Blob이 이미 있는 경우 기존 Blob의 콘텐츠는 변경되지 않은 상태로 유지됩니다.

https://docs.microsoft.com/rest/api/storageservices/put-blob를 참조하세요.

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

매개 변수

options: AppendBlobCreateIfNotExistsOptions

반환

Promise<AppendBlobCreateIfNotExistsResponse>

seal(AppendBlobSealOptions)

추가 Blob을 봉인하여 읽기 전용으로 만듭니다.

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

매개 변수

options: AppendBlobSealOptions

반환

Promise<AppendBlobAppendBlockResponse>

withSnapshot(string)

원본과 동일하지만 지정된 스냅샷 타임스탬프를 사용하여 새 AppendBlobClient 개체를 만듭니다. ""를 제공하면 스냅샷이 제거되고 클라이언트가 기본 Blob으로 반환됩니다.

function withSnapshot(snapshot: string): AppendBlobClient

매개 변수

snapshot: string

스냅샷 타임스탬프입니다.

반환

AppendBlobClient

원본과 동일하지만 지정된 스냅샷 타임스탬프가 있는 새 AppendBlobClient 개체입니다.

상속된 메서드 세부 정보

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

보류 중인 비동기 Blob 복사 작업을 중단하고 길이가 0이고 전체 메타데이터가 있는 대상 Blob을 남깁니다. 버전 2012-02-12 이상.

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

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

매개 변수

copyId: string

URL에서 복사 작업의 ID입니다.

options: BlobAbortCopyFromURLOptions

Blob URL에서 복사 중단 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobAbortCopyFromURLResponse>

BlobClient.abortCopyFromURL에서 상속됨

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

스토리지 계정 내의 대상에 Blob을 비동기적으로 복사합니다. 이 메서드는 복사가 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다. 폴러에서 를 호출 cancelOperation 하여 복사본을 완료하기 전에 취소할 수도 있습니다. 첫 번째 요청에서 작업이 완료되고 완료된 복사본을 취소하려고 하면 오류가 throw되는 경우 onProgress 콜백이 호출되지 않습니다.

버전 2012-02-12 이상에서는 Blob 복사 작업의 원본이 모든 Azure Storage 계정에서 커밋된 Blob일 수 있습니다. 버전 2015-02-21부터 Blob 복사 작업의 원본은 모든 Azure Storage 계정의 Azure 파일일 수 있습니다. 다른 저장소 계정으로부터의 Blob 복사 작업은 2012년 6월 7일 이후 생성된 저장소 계정에서만 허용됩니다.

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

자동 폴링을 사용하는 예제:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

수동 폴링을 사용하는 예제:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

진행률 업데이트를 사용하는 예제:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

폴링 간격 변경(기본값 15초)을 사용하는 예제:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

복사 취소를 사용하는 예제:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

매개 변수

copySource: string

원본 Azure Blob/File에 대한 URL입니다.

options: BlobBeginCopyFromURLOptions

Blob URL에서 복사 시작 작업에 대한 선택적 옵션입니다.

반환

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

BlobClient.beginCopyFromURL에서 상속됨

createSnapshot(BlobCreateSnapshotOptions)

Blob의 읽기 전용 스냅숏을 만듭니다.

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

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

매개 변수

options: BlobCreateSnapshotOptions

Blob 스냅샷 만들기 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobCreateSnapshotResponse>

BlobClient.createSnapshot에서 상속됨

delete(BlobDeleteOptions)

삭제할 지정된 Blob 또는 스냅샷을 표시합니다. 이 blob는 나중에 가비지 수집 중에 삭제됩니다. Blob을 삭제하려면 해당 스냅숏을 모두 삭제해야 합니다. Blob 삭제 작업과 동시에 둘 다 삭제할 수 있습니다.

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

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

매개 변수

options: BlobDeleteOptions

Blob 삭제 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobDeleteResponse>

BlobClient.delete에서 상속됨

deleteIfExists(BlobDeleteOptions)

삭제할 지정된 Blob 또는 스냅샷(있는 경우)을 표시합니다. 이 blob는 나중에 가비지 수집 중에 삭제됩니다. Blob을 삭제하려면 해당 스냅숏을 모두 삭제해야 합니다. Blob 삭제 작업과 동시에 둘 다 삭제할 수 있습니다.

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

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

매개 변수

options: BlobDeleteOptions

Blob 삭제 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobDeleteIfExistsResponse>

BlobClient.deleteIfExists에서 상속됨

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Blob에서 immutablility 정책을 삭제합니다.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

매개 변수

options: BlobDeleteImmutabilityPolicyOptions

Blob에서 불변성 정책을 삭제하는 옵션입니다.

반환

Promise<BlobDeleteImmutabilityPolicyResponse>

BlobClient.deleteImmutabilityPolicy에서 상속됨

download(number, number, BlobDownloadOptions)

메타데이터 및 속성을 포함하여 시스템에서 Blob을 읽거나 다운로드합니다. Blob 가져오기를 호출하여 스냅샷을 읽을 수도 있습니다.

Node.js 데이터는 읽기 가능한 스트림 읽기 가능StreamBody에서 반환됩니다.
브라우저에서 데이터는 promise blobBody로 반환됩니다.

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

매개 변수

offset: number

다운로드할 Blob의 위치(0보다 크거나 같음)

count: number

다운로드할 데이터의 양(0보다 큼)입니다. 정의되지 않은 경우 끝까지 다운로드됩니다.

options: BlobDownloadOptions

Blob 다운로드 작업에 대한 선택적 옵션입니다.

사용 예제(Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

사용 예(브라우저):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

반환

Promise<BlobDownloadResponseParsed>

BlobClient.download에서 상속됨

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

NODE.JS 런타임에서만 사용할 수 있습니다.

버퍼와 병렬로 Azure Blob을 다운로드합니다. 오프셋 및 개수는 선택 사항이며, 제공되지 않은 경우 전체 Blob을 다운로드합니다.

경고: 버퍼는 Node.js/V8의 제한으로 인해 32비트 시스템에서 최대 1기가바이트 또는 64비트 시스템에서 약 2기가바이트의 파일만 지원할 수 있습니다. 이 크기보다 큰 Blob의 경우 downloadToFile을 고려합니다.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

매개 변수

buffer: Buffer

채울 버퍼, 개수보다 큰 길이가 있어야 합니다.

offset: number

다운로드할 블록 Blob의 위치(바이트)

count: number

다운로드할 데이터 양(바이트)입니다. 정의되지 않은 상태로 전달할 때 끝까지 다운로드됩니다.

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

반환

Promise<Buffer>

BlobClient.downloadToBuffer에서 상속됨

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

NODE.JS 런타임에서만 사용할 수 있습니다.

버퍼와 병렬로 Azure Blob을 다운로드합니다. 오프셋 및 개수는 선택 사항이며, 제공되지 않은 경우 전체 Blob을 다운로드합니다.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

매개 변수

offset: number

다운로드할 블록 Blob의 위치(바이트)

count: number

다운로드할 데이터 양(바이트)입니다. 정의되지 않은 상태로 전달할 때 끝까지 다운로드됩니다.

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

반환

Promise<Buffer>

BlobClient.downloadToBuffer에서 상속됨

downloadToFile(string, number, number, BlobDownloadOptions)

NODE.JS 런타임에서만 사용할 수 있습니다.

Azure Blob을 로컬 파일에 다운로드합니다. 지정된 파일 경로가 이미 종료되면 실패합니다. 오프셋 및 개수는 선택 사항이며, 전체 Blob을 다운로드하기 위해 각각 0 및 undefined를 전달합니다.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

매개 변수

filePath: string

offset: number

다운로드할 블록 Blob의 위치입니다.

count: number

다운로드할 데이터의 양입니다. 정의되지 않은 상태로 전달할 때 끝까지 다운로드됩니다.

options: BlobDownloadOptions

Blob 다운로드 옵션에 대한 옵션입니다.

반환

Promise<BlobDownloadResponseParsed>

Blob 다운로드 작업에 대한 응답 데이터이지만 해당 콘텐츠가 이미 읽기 및 지정된 경로의 로컬 파일에 기록되어 있으므로 readableStreamBody가 정의되지 않은 상태로 설정됩니다.

BlobClient.downloadToFile에서 상속됨

exists(BlobExistsOptions)

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

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

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

매개 변수

options: BlobExistsOptions

옵션에서 Exists 작업으로

반환

Promise<boolean>

BlobClient.exists에서 상속됨

generateSasUrl(BlobGenerateSasUrlOptions)

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

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

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

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

매개 변수

options: BlobGenerateSasUrlOptions

선택적 매개 변수입니다.

반환

Promise<string>

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

BlobClient.generateSasUrl에서 상속됨

getAppendBlobClient()

AppendBlobClient 개체를 만듭니다.

function getAppendBlobClient(): AppendBlobClient

반환

AppendBlobClient

BlobClient.getAppendBlobClient에서 상속됨

getBlobLeaseClient(string)

Blob에서 임대를 관리하는 BlobLeaseClient 를 가져옵니다.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

매개 변수

proposeLeaseId: string

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

반환

BlobLeaseClient

Blob에서 임대를 관리하기 위한 새 BlobLeaseClient 개체입니다.

BlobClient.getBlobLeaseClient에서 상속됨

getBlockBlobClient()

BlockBlobClient 개체를 만듭니다.

function getBlockBlobClient(): BlockBlobClient

반환

BlockBlobClient

BlobClient.getBlockBlobClient에서 상속됨

getPageBlobClient()

PageBlobClient 개체를 만듭니다.

function getPageBlobClient(): PageBlobClient

반환

PageBlobClient

BlobClient.getPageBlobClient에서 상속됨

getProperties(BlobGetPropertiesOptions)

blob에 대한 모든 사용자 정의 메타데이터, 표준 HTTP 속성 및 시스템 속성을 반환합니다. blob의 콘텐츠는 반환하지 않습니다.

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

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

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

매개 변수

options: BlobGetPropertiesOptions

속성 가져오기 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobGetPropertiesResponse>

BlobClient.getProperties에서 상속됨

getTags(BlobGetTagsOptions)

기본 Blob과 연결된 태그를 가져옵니다.

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

매개 변수

options: BlobGetTagsOptions

반환

Promise<BlobGetTagsResponse>

BlobClient.getTags에서 상속됨

setAccessTier(string, BlobSetTierOptions)

Blob에서 계층을 설정합니다. 이 작업은 Premium Storage 계정의 페이지 Blob 및 Blob Storage 계정의 블록 Blob에서 허용됩니다(로컬 중복 스토리지에만 해당). 프리미엄 페이지 Blob 계층은 Blob의 허용되는 크기, IOPS 및 대역폭을 결정합니다. 블록 Blob의 계층은 핫/쿨/보관 스토리지 유형을 결정합니다. 이 작업은 Blob의 ETag를 업데이트하지 않습니다.

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

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

매개 변수

tier: string

Blob에 설정할 계층입니다. 유효한 값은 핫, 쿨 또는 보관입니다.

options: BlobSetTierOptions

Blob 계층 설정 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobSetTierResponse>

BlobClient.setAccessTier에서 상속됨

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Blob의 시스템 속성을 설정합니다.

값이 제공되지 않거나 지정된 Blob HTTP 헤더에 대해 제공된 값이 없는 경우 값이 없는 이러한 Blob HTTP 헤더는 지워질 것입니다.

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

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

매개 변수

blobHTTPHeaders: BlobHTTPHeaders

값이 제공되지 않거나 지정된 Blob HTTP 헤더에 대해 제공된 값이 없는 경우 값이 없는 이러한 Blob HTTP 헤더는 지워질 것입니다. 설정하는 일반적인 헤더는 blobContentType 브라우저에서 파일 형식에 따라 기능을 제공할 수 있도록 하는 것입니다.

options: BlobSetHTTPHeadersOptions

Blob HTTP 헤더 설정 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobSetHTTPHeadersResponse>

BlobClient.setHTTPHeaders에서 상속됨

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Blob에서 immutablility 정책을 설정합니다.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

매개 변수

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Blob에서 불변성 정책을 설정하는 선택적 옵션입니다.

반환

Promise<BlobSetImmutabilityPolicyResponse>

BlobClient.setImmutabilityPolicy에서 상속됨

setLegalHold(boolean, BlobSetLegalHoldOptions)

Blob에 대한 법적 보존을 설정합니다.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

매개 변수

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Blob에 대한 법적 보존을 설정하는 선택적 옵션입니다.

반환

Promise<BlobSetLegalHoldResponse>

BlobClient.setLegalHold에서 상속됨

setMetadata(Metadata, BlobSetMetadataOptions)

하나 이상의 이름 값 쌍으로 지정된 Blob에 대한 사용자 정의 메타데이터를 설정합니다.

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

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

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

매개 변수

metadata: Metadata

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

options: BlobSetMetadataOptions

메타데이터 설정 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobSetMetadataResponse>

BlobClient.setMetadata에서 상속됨

setTags(Tags, BlobSetTagsOptions)

기본 Blob에 태그를 설정합니다. Blob에는 최대 10개의 태그가 있을 수 있습니다. 태그 키는 1자에서 128자 사이여야 합니다. 태그 값은 0자에서 256자 사이여야 합니다. 유효한 태그 키 및 값 문자에는 소문자 및 대문자, 숫자(0-9), 공백(''), 더하기('+'), 빼기('-'), 마침표('.'), 슬래시('/'), 콜론(':'), 등호('=') 및 밑줄('_')이 포함됩니다.

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

매개 변수

tags: Tags

options: BlobSetTagsOptions

반환

Promise<BlobSetTagsResponse>

BlobClient.setTags에서 상속됨

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

URL에서 동기 복사 작업은 Blob 또는 인터넷 리소스를 새 Blob에 복사합니다. 복사가 완료될 때까지 응답을 반환하지 않습니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url를 참조하세요.

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

매개 변수

copySource: string

복사할 원본 URL로, 인증에 SAS(공유 액세스 서명)가 필요할 수 있습니다.

options: BlobSyncCopyFromURLOptions

반환

Promise<BlobCopyFromURLResponse>

BlobClient.syncCopyFromURL에서 상속됨

undelete(BlobUndeleteOptions)

일시 삭제된 Blob 및 연결된 일시 삭제된 스냅샷의 내용과 메타데이터를 복원합니다. 삭제 취소 Blob은 버전 2017-07-29 이상에서만 지원됩니다.

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

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

매개 변수

options: BlobUndeleteOptions

Blob 삭제 취소 작업에 대한 선택적 옵션입니다.

반환

Promise<BlobUndeleteResponse>

BlobClient.undelete에서 상속됨

withVersion(string)

이 Blob의 버전을 가리키는 새 BlobClient 개체를 만듭니다. ""을 입력하면 versionId가 제거되고 클라이언트가 기본 Blob으로 반환됩니다.

function withVersion(versionId: string): BlobClient

매개 변수

versionId: string

versionId입니다.

반환

BlobClient

이 Blob의 버전을 가리키는 새 BlobClient 개체입니다.

BlobClient.withVersion에서 상속됨