다음을 통해 공유

PageBlobClient class

  • 참조
패키지:
@azure/storage-blob

PageBlobClient는 페이지 Blob에 적용할 수 있는 작업 집합을 정의합니다.

Extends
BlobClient

생성자

PageBlobClient(string, PipelineLike)

PageBlobClient의 인스턴스를 만듭니다.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

속성

containerName

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

blob의 이름입니다.

상속된 속성

accountName
credential

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

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

메서드

clearPages(number, number, PageBlobClearPagesOptions)

페이지 Blob에서 지정된 페이지를 해제합니다.

https://docs.microsoft.com/rest/api/storageservices/put-page을 참조하십시오.
create(number, PageBlobCreateOptions)

지정된 길이의 페이지 Blob을 만듭니다. uploadPages를 호출하여 데이터 데이터를 페이지 Blob에 업로드합니다.

https://docs.microsoft.com/rest/api/storageservices/put-blob을 참조하십시오.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

https://docs.microsoft.com/rest/api/storageservices/put-blob을 참조하십시오.
getPageRanges(number, number, PageBlobGetPageRangesOptions)

페이지 Blob 또는 페이지 Blob의 스냅샷에 대한 유효한 페이지 범위 목록을 반환합니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

지정된 스냅샷과 이 페이지 Blob 간에 다른 페이지 범위의 컬렉션을 가져옵니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

관리 디스크에 대해 지정된 스냅샷과 이 페이지 Blob 간에 다른 페이지 범위의 컬렉션을 가져옵니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.
listPageRanges(number, number, PageBlobListPageRangesOptions)

페이지 Blob의 페이지 범위 목록에 대한 비동기 반복기를 반환합니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.

.byPage()는 페이지 Blob의 페이지 범위 목록에 대한 비동기 반복기를 반환합니다.

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

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

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

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

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

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

지정된 스냅샷과 이 페이지 Blob 간에 다른 페이지 범위 목록에 대한 비동기 반복기를 반환합니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.

.byPage()는 지정된 스냅샷과 이 페이지 Blob 간에 다른 페이지 범위 목록에 대한 비동기 반복기를 반환합니다.

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

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

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

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

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

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

페이지 Blob의 크기를 지정된 크기로 조정합니다(512의 배수여야 합니다).

https://docs.microsoft.com/rest/api/storageservices/set-blob-properties을 참조하십시오.
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

한 페이지 Blob의 스냅샷에서 이 페이지 Blob으로의 증분 복사본을 시작하는 작업을 시작합니다. 스냅샷은 이전에 복사한 스냅샷 간의 차등 변경 내용만 대상으로 전송되도록 복사됩니다. 복사된 스냅샷은 원래 스냅샷의 전체 복사본이며 평소와 같이 읽거나 복사할 수 있습니다.

참조 https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

페이지 Blob의 시퀀스 번호를 설정합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties을 참조하십시오.
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

페이지 Blob에 1개 이상의 페이지를 씁니다. 시작 및 끝 오프셋은 512의 배수여야 합니다.

https://docs.microsoft.com/rest/api/storageservices/put-page을 참조하십시오.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

페이지 업로드 작업은 URL에서 콘텐츠를 읽는 페이지 Blob에 페이지 범위를 씁니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url을 참조하십시오.
withSnapshot(string)

원본과 동일하지만 지정된 스냅샷 타임스탬프를 사용하여 새 PageBlobClient 개체를 만듭니다. ""을 입력하면 스냅샷이 제거되고 클라이언트가 기본 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 데이터는 읽기 가능한 스트림 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비트 시스템에서 최대 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에서 불변성 정책을 설정합니다.
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으로 반환됩니다.

생성자 세부 정보

PageBlobClient(string, PipelineLike)

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

new PageBlobClient(url: string, pipeline: PipelineLike)

매개 변수

url

string

Azure Storage 페이지 Blob(예: "https://myaccount.blob.core.windows.net/mycontainer/pageblob")을 가리키는 URL 문자열입니다. AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString"). 이 메서드는 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()을 호출하여 기본 파이프라인을 만들거나 사용자 지정된 파이프라인을 제공합니다.

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

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

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

매개 변수

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

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

PageBlobClient(string, string, string, StoragePipelineOptions)

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

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

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

속성 값

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

BlobClient.credential에서 상속됨

url

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

url: string

속성 값

string

BlobClient.url에서 상속됨

메서드 세부 정보

clearPages(number, number, PageBlobClearPagesOptions)

페이지 Blob에서 지정된 페이지를 해제합니다.

https://docs.microsoft.com/rest/api/storageservices/put-page을 참조하십시오.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

매개 변수

offset

number

지울 페이지의 시작 바이트 위치입니다.

count

number

지울 바이트 수입니다.

options
PageBlobClearPagesOptions

페이지 Blob 페이지 지우기 작업에 대한 옵션입니다.

반환

Promise<PageBlobClearPagesResponse>

페이지 Blob 페이지 지우기 작업에 대한 응답 데이터입니다.

create(number, PageBlobCreateOptions)

지정된 길이의 페이지 Blob을 만듭니다. uploadPages를 호출하여 데이터 데이터를 페이지 Blob에 업로드합니다.

https://docs.microsoft.com/rest/api/storageservices/put-blob을 참조하십시오.

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

매개 변수

size

number

페이지 Blob의 크기입니다.

options
PageBlobCreateOptions

페이지 Blob 만들기 작업에 대한 옵션입니다.

반환

Promise<PageBlobCreateResponse>

페이지 Blob 만들기 작업에 대한 응답 데이터입니다.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

https://docs.microsoft.com/rest/api/storageservices/put-blob을 참조하십시오.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

매개 변수

size

number

페이지 Blob의 크기입니다.

options
PageBlobCreateIfNotExistsOptions

반환

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

페이지 Blob 또는 페이지 Blob의 스냅샷에 대한 유효한 페이지 범위 목록을 반환합니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

매개 변수

offset

number

페이지 범위의 시작 바이트 위치입니다.

count

number

가져올 바이트 수입니다.

options
PageBlobGetPageRangesOptions

페이지 Blob 범위 가져오기 작업에 대한 옵션입니다.

반환

Promise<PageBlobGetPageRangesResponse>

페이지 Blob 범위 가져오기 작업에 대한 응답 데이터입니다.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

지정된 스냅샷과 이 페이지 Blob 간에 다른 페이지 범위의 컬렉션을 가져옵니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

매개 변수

offset

number

페이지 Blob의 시작 바이트 위치

count

number

범위 차이를 가져올 바이트 수입니다.

prevSnapshot

string

차이를 검색하는 스냅샷의 타임스탬프입니다.

options
PageBlobGetPageRangesDiffOptions

페이지 Blob 페이지 범위 차이 가져오기 작업에 대한 옵션입니다.

반환

Promise<PageBlobGetPageRangesDiffResponse>

페이지 Blob 페이지 범위 차이 가져오기 작업에 대한 응답 데이터입니다.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

관리 디스크에 대해 지정된 스냅샷과 이 페이지 Blob 간에 다른 페이지 범위의 컬렉션을 가져옵니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

매개 변수

offset

number

페이지 Blob의 시작 바이트 위치

count

number

범위 차이를 가져올 바이트 수입니다.

prevSnapshotUrl

string

차이를 검색하는 스냅샷의 URL입니다.

options
PageBlobGetPageRangesDiffOptions

페이지 Blob 페이지 범위 차이 가져오기 작업에 대한 옵션입니다.

반환

Promise<PageBlobGetPageRangesDiffResponse>

페이지 Blob 페이지 범위 차이 가져오기 작업에 대한 응답 데이터입니다.

listPageRanges(number, number, PageBlobListPageRangesOptions)

페이지 Blob의 페이지 범위 목록에 대한 비동기 반복기를 반환합니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.

.byPage()는 페이지 Blob의 페이지 범위 목록에 대한 비동기 반복기를 반환합니다.

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

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

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

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

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

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

매개 변수

offset

number

페이지 범위의 시작 바이트 위치입니다.

count

number

가져올 바이트 수입니다.

options
PageBlobListPageRangesOptions

페이지 Blob 범위 가져오기 작업에 대한 옵션입니다.

반환

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

페이징을 지원하는 asyncIterableIterator입니다.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

지정된 스냅샷과 이 페이지 Blob 간에 다른 페이지 범위 목록에 대한 비동기 반복기를 반환합니다.

https://docs.microsoft.com/rest/api/storageservices/get-page-ranges을 참조하십시오.

.byPage()는 지정된 스냅샷과 이 페이지 Blob 간에 다른 페이지 범위 목록에 대한 비동기 반복기를 반환합니다.

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

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

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

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

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

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

매개 변수

offset

number

페이지 범위의 시작 바이트 위치입니다.

count

number

가져올 바이트 수입니다.

prevSnapshot

string

차이를 검색하는 스냅샷의 타임스탬프입니다.

options
PageBlobListPageRangesDiffOptions

페이지 Blob 범위 가져오기 작업에 대한 옵션입니다.

반환

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

페이징을 지원하는 asyncIterableIterator입니다.

resize(number, PageBlobResizeOptions)

페이지 Blob의 크기를 지정된 크기로 조정합니다(512의 배수여야 합니다).

https://docs.microsoft.com/rest/api/storageservices/set-blob-properties을 참조하십시오.

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

매개 변수

size

number

대상 크기

options
PageBlobResizeOptions

페이지 Blob 크기 조정 작업에 대한 옵션입니다.

반환

Promise<PageBlobResizeResponse>

페이지 Blob 크기 조정 작업에 대한 응답 데이터입니다.

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

한 페이지 Blob의 스냅샷에서 이 페이지 Blob으로의 증분 복사본을 시작하는 작업을 시작합니다. 스냅샷은 이전에 복사한 스냅샷 간의 차등 변경 내용만 대상으로 전송되도록 복사됩니다. 복사된 스냅샷은 원래 스냅샷의 전체 복사본이며 평소와 같이 읽거나 복사할 수 있습니다.

참조 https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

매개 변수

copySource

string

원본 페이지 Blob 스냅샷의 이름을 지정합니다. 예를 들어 https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

페이지 Blob 증분 복사 작업에 대한 옵션입니다.

반환

Promise<PageBlobCopyIncrementalResponse>

페이지 Blob 증분 복사 작업에 대한 응답 데이터입니다.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

페이지 Blob의 시퀀스 번호를 설정합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties을 참조하십시오.

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

매개 변수

sequenceNumberAction
SequenceNumberActionType

서비스에서 Blob의 시퀀스 번호를 수정하는 방법을 나타냅니다.

sequenceNumber

number

sequenceNumberAction이 max 또는 update인 경우 필수

options
PageBlobUpdateSequenceNumberOptions

페이지 Blob 업데이트 시퀀스 번호 작업에 대한 옵션입니다.

반환

Promise<PageBlobUpdateSequenceNumberResponse>

페이지 Blob 업데이트 시퀀스 번호 작업에 대한 응답 데이터입니다.

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

페이지 Blob에 1개 이상의 페이지를 씁니다. 시작 및 끝 오프셋은 512의 배수여야 합니다.

https://docs.microsoft.com/rest/api/storageservices/put-page을 참조하십시오.

function uploadPages(body: RequestBodyType, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

매개 변수

body
HttpRequestBody

업로드할 데이터

offset

number

대상 페이지 Blob의 오프셋

count

number

본문의 콘텐츠 길이, 업로드할 바이트 수

options
PageBlobUploadPagesOptions

페이지 Blob 페이지 업로드 작업에 대한 옵션입니다.

반환

Promise<PageBlobUploadPagesResponse>

페이지 Blob 페이지 업로드 작업에 대한 응답 데이터입니다.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

페이지 업로드 작업은 URL에서 콘텐츠를 읽는 페이지 Blob에 페이지 범위를 씁니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url을 참조하십시오.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

매개 변수

sourceURL

string

복사 원본에 대한 URL을 지정합니다. 인증에 SAS(공유 액세스 서명)가 필요할 수 있습니다.

sourceOffset

number

복사할 원본 오프셋입니다. 원본 페이지 Blob의 시작 부분에서 복사하려면 0을 전달합니다.

destOffset

number

대상 페이지 Blob의 오프셋

count

number

원본 페이지 Blob에서 업로드할 바이트 수

options
PageBlobUploadPagesFromURLOptions

반환

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): PageBlobClient

매개 변수

snapshot

string

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

반환

PageBlobClient

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

상속된 메서드 세부 정보

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 데이터는 읽기 가능한 스트림 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>

BlobClient.download에서 상속됨

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>

BlobClient.downloadToBuffer에서 상속됨

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

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

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

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에서 불변성 정책을 설정합니다.

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에서 상속됨