BlobClient class

참조

패키지:: @azure/storage-blob

BlobClient는 Azure Storage Blob에 대한 URL을 나타냅니다. Blob은 블록 Blob, 추가 Blob 또는 페이지 Blob일 수 있습니다.

Extends: StorageClient

생성자

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

속성

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

상속된 속성

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

메서드

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` 호출하여 복사본을 완료하기 전에 취소할 수도 있습니다. 첫 번째 요청에서 작업이 완료되면 onProgress 콜백이 호출되지 않으며 완료된 복사본을 취소하려고 하면 오류가 발생합니다. 버전 2012-02-12 이상에서는 Blob 복사 작업의 원본이 모든 Azure Storage 계정에서 커밋된 Blob일 수 있습니다. 버전 2015-02-21부터 Blob 복사 작업의 원본은 모든 Azure Storage 계정의 Azure 파일일 수 있습니다. 2012년 6월 7일 이후에 만든 스토리지 계정만 Blob 복사 작업을 다른 스토리지 계정에서 복사할 수 있습니다. 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읽기 가능한 스트림 ReadableStreamBody에서 데이터가 반환됩니다. 브라우저에서 데이터는 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비트 시스템에서 최대 1GB 또는 64비트 시스템에서 약 2GB의 파일만 지원할 수 있습니다. 이 크기보다 큰 Blob의 경우 downloadToFile것이 좋습니다.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	NODE.JS 런타임에서만 사용할 수 있습니다. 버퍼와 병렬로 Azure Blob을 다운로드합니다. 오프셋 및 개수는 선택 사항이며, 제공되지 않으면 전체 Blob을 다운로드합니다. 경고: 버퍼는 Node.js/V8의 제한으로 인해 32비트 시스템에서 최대 1GB 또는 64비트 시스템에서 약 2GB의 파일만 지원할 수 있습니다. 이 크기보다 큰 Blob의 경우 downloadToFile것이 좋습니다.
downloadToFile(string, number, number, BlobDownloadOptions)	NODE.JS 런타임에서만 사용할 수 있습니다. 로컬 파일에 Azure Blob을 다운로드합니다. 지정된 파일 경로가 이미 종료되면 실패합니다. 오프셋 및 개수는 선택 사항이며, 각각 0과 정의되지 않은 값을 전달하여 전체 Blob을 다운로드합니다.
exists(BlobExistsOptions)	이 클라이언트가 나타내는 Azure Blob 리소스가 있으면 true를 반환합니다. false이면 false입니다. 참고: 다른 클라이언트 또는 애플리케이션에서 기존 Blob을 삭제할 수 있기 때문에 이 함수를 주의해서 사용합니다. 그 반대로 이 함수가 완료된 후 다른 클라이언트 또는 애플리케이션에서 새 Blob을 추가할 수 있습니다.
generateSasStringToSign(BlobGenerateSasUrlOptions)	공유 키 자격 증명을 사용하여 생성된 BlobClient에만 사용할 수 있습니다. 전달된 클라이언트 속성 및 매개 변수를 기반으로 Blob Service SAS(공유 액세스 서명) URI에 서명하는 문자열을 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조
generateSasUrl(BlobGenerateSasUrlOptions)	공유 키 자격 증명을 사용하여 생성된 BlobClient에만 사용할 수 있습니다. 전달된 클라이언트 속성 및 매개 변수를 기반으로 Blob Service SAS(공유 액세스 서명) URI를 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)	공유 키 자격 증명을 사용하여 생성된 BlobClient에만 사용할 수 있습니다. 전달된 클라이언트 속성 및 매개 변수를 기반으로 Blob Service SAS(공유 액세스 서명) URI에 서명하는 문자열을 생성합니다. SAS는 입력 사용자 위임 키로 서명됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)	전달된 클라이언트 속성 및 매개 변수를 기반으로 Blob Service SAS(공유 액세스 서명) URI를 생성합니다. SAS는 입력 사용자 위임 키로 서명됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조
getAccountInfo(BlobGetAccountInfoOptions)	계정 정보 가져오기 작업은 지정된 계정에 대한 sku 이름 및 계정 종류를 반환합니다. 계정 정보 가져오기 작업은 버전 2018-03-28부터 서비스 버전에서 사용할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information 참조
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` 개체에는 원래 대문자가 포함되어 있더라도 해당 키가 소문자로 표시됩니다. 이는 원래 대/소문자를 유지하는 옵션을 사용하여 Blob을 나열하는 `includeMetadata` 메서드에서 반환하는 메타데이터 키와 다릅니다.
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에서 불변성 정책을 설정합니다.
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 참조
withSnapshot(string)	원본과 동일하지만 지정된 스냅샷 타임스탬프를 사용하여 새 BlobClient 개체를 만듭니다. ""를 입력하면 스냅샷이 제거되고 클라이언트가 기본 Blob으로 반환됩니다.
withVersion(string)	이 Blob의 버전을 가리키는 새 BlobClient 개체를 만듭니다. ""를 입력하면 versionId가 제거되고 클라이언트가 기본 Blob으로 반환됩니다.

생성자 세부 정보

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

매개 변수

url: string

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

pipeline: PipelineLike

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

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

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

매개 변수

url: string

Azure Storage Blob Service를 가리키는 클라이언트 문자열(예: "https://myaccount.blob.core.windows.net")입니다. AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.blob.core.windows.net?sasString").

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

선택적. HTTP 파이프라인을 구성하는 옵션입니다.

BlobClient(string, string, string, StoragePipelineOptions)

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

new BlobClient(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

StorageClient.accountName에서 상속된

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

속성 값

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

StorageClient.credential에서 상속된

url

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

url: string

속성 값

string

StorageClient.url에서 상속된

메서드 세부 정보

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>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

버전 2012-02-12 이상에서는 Blob 복사 작업의 원본이 모든 Azure Storage 계정에서 커밋된 Blob일 수 있습니다. 버전 2015-02-21부터 Blob 복사 작업의 원본은 모든 Azure Storage 계정의 Azure 파일일 수 있습니다. 2012년 6월 7일 이후에 만든 스토리지 계정만 Blob 복사 작업을 다른 스토리지 계정에서 복사할 수 있습니다.

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>>

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>

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>

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>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

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

매개 변수

options: BlobDeleteImmutabilityPolicyOptions

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

반환

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

Node.js읽기 가능한 스트림 ReadableStreamBody에서 데이터가 반환됩니다.
브라우저에서 데이터는 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>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

경고: 버퍼는 Node.js/V8의 제한으로 인해 32비트 시스템에서 최대 1GB 또는 64비트 시스템에서 약 2GB의 파일만 지원할 수 있습니다. 이 크기보다 큰 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>

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>

downloadToFile(string, number, number, BlobDownloadOptions)

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

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

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 다운로드 작업에 대한 응답 데이터이지만 읽기 가능한StreamBody는 해당 콘텐츠가 지정된 경로의 로컬 파일에 이미 읽고 쓰여졌기 때문에 정의되지 않은 상태로 설정됩니다.

exists(BlobExistsOptions)

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

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

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

매개 변수

options: BlobExistsOptions

옵션에서 Exists 연산을 수행할 수 있습니다.

반환

Promise<boolean>

generateSasStringToSign(BlobGenerateSasUrlOptions)

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

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

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

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

매개 변수

options: BlobGenerateSasUrlOptions

선택적 매개 변수입니다.

반환

string

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

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 URI와 생성된 SAS 토큰이 뒤따릅니다.

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

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

전달된 클라이언트 속성 및 매개 변수를 기반으로 Blob Service SAS(공유 액세스 서명) URI에 서명하는 문자열을 생성합니다. SAS는 입력 사용자 위임 키로 서명됩니다.

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

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

매개 변수

options: BlobGenerateSasUrlOptions

선택적 매개 변수입니다.

userDelegationKey: UserDelegationKey

blobServiceClient.getUserDelegationKey() 반환 값

반환

string

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

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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

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

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

매개 변수

options: BlobGenerateSasUrlOptions

선택적 매개 변수입니다.

userDelegationKey: UserDelegationKey

blobServiceClient.getUserDelegationKey() 반환 값

반환

Promise<string>

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

getAccountInfo(BlobGetAccountInfoOptions)

계정 정보 가져오기 작업은 지정된 계정에 대한 sku 이름 및 계정 종류를 반환합니다. 계정 정보 가져오기 작업은 버전 2018-03-28부터 서비스 버전에서 사용할 수 있습니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information 참조

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

매개 변수

options: BlobGetAccountInfoOptions

서비스 계정 정보 가져오기 작업에 대한 옵션입니다.

반환

Promise<BlobGetAccountInfoResponse>

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

getAppendBlobClient()

AppendBlobClient 개체를 만듭니다.

function getAppendBlobClient(): AppendBlobClient

반환

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

매개 변수

proposeLeaseId: string

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

반환

BlobLeaseClient

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

getBlockBlobClient()

BlockBlobClient 개체를 만듭니다.

function getBlockBlobClient(): BlockBlobClient

반환

BlockBlobClient

getPageBlobClient()

PageBlobClient 개체를 만듭니다.

function getPageBlobClient(): PageBlobClient

반환

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

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

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

매개 변수

options: BlobGetPropertiesOptions

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

반환

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

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

매개 변수

options: BlobGetTagsOptions

반환

Promise<BlobGetTagsResponse>

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>

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>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Blob에서 불변성 정책을 설정합니다.

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

매개 변수

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

반환

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

매개 변수

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

반환

Promise<BlobSetLegalHoldResponse>

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>

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>

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>

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>

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlobClient

매개 변수

snapshot: string

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

반환

BlobClient

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

withVersion(string)

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

function withVersion(versionId: string): BlobClient

매개 변수

versionId: string

versionId입니다.

반환

BlobClient

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

다음을 통해 공유

BlobClient class

생성자

속성

상속된 속성

메서드

생성자 세부 정보

BlobClient(string, PipelineLike)

매개 변수

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

매개 변수

BlobClient(string, string, string, StoragePipelineOptions)

매개 변수

속성 세부 정보

containerName

속성 값

name

속성 값

상속된 속성 세부 정보

accountName

속성 값

credential

속성 값

url

속성 값

메서드 세부 정보

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

매개 변수

반환

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

매개 변수

반환

createSnapshot(BlobCreateSnapshotOptions)

매개 변수

반환

delete(BlobDeleteOptions)

매개 변수

반환

deleteIfExists(BlobDeleteOptions)

매개 변수

반환

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

매개 변수

반환

download(number, number, BlobDownloadOptions)

매개 변수

반환

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

매개 변수

반환

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

매개 변수

반환

downloadToFile(string, number, number, BlobDownloadOptions)

매개 변수

반환

exists(BlobExistsOptions)

매개 변수

반환

generateSasStringToSign(BlobGenerateSasUrlOptions)

매개 변수

반환

generateSasUrl(BlobGenerateSasUrlOptions)

매개 변수

반환

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

매개 변수

반환

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

매개 변수

반환

getAccountInfo(BlobGetAccountInfoOptions)

매개 변수

반환

getAppendBlobClient()

반환

getBlobLeaseClient(string)

매개 변수

반환

getBlockBlobClient()