@azure/storage-blob package
클래스
| AccountSASPermissions |
NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 직렬화하고 AccountSASSignatureValues 개체에 대한 사용 권한 필드로 설정해야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| AccountSASResourceTypes |
NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 액세스할 수 있는 리소스를 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 사용 권한을 사용하는 모든 SAS가 해당 리소스 종류에 대한 액세스 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 직렬화하고 AccountSASSignatureValues 개체의 리소스 필드로 설정해야 합니다. 이 클래스 없이 리소스 문자열을 생성할 수 있지만 리소스 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| AccountSASServices |
NODE.JS 런타임에서만 사용할 수 있습니다. AccountSAS에서 액세스할 수 있는 서비스를 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 서비스에 대한 액세스 권한을 부여합니다. 모든 값이 설정되면 toString으로 serialize되고 AccountSASSignatureValues 개체의 서비스 필드로 설정되어야 합니다. 이 클래스 없이 서비스 문자열을 생성할 수 있지만 서비스의 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| AnonymousCredential |
AnonymousCredential은 AnonymousCredentialPolicy 개체를 만드는 데 사용되는 credentialPolicyCreator 멤버를 제공합니다. AnonymousCredentialPolicy는 공용 리소스를 읽는 HTTP(S) 요청과 함께 사용되거나 SAS(공유 액세스 서명)와 함께 사용됩니다. |
| AnonymousCredentialPolicy |
AnonymousCredentialPolicy는 공용 리소스를 읽는 HTTP(S) 요청과 함께 사용되거나 SAS(공유 액세스 서명)와 함께 사용됩니다. |
| AppendBlobClient |
AppendBlobClient는 Blob을 추가하는 데 적용할 수 있는 작업 집합을 정의합니다. |
| BaseRequestPolicy |
모든 요청 정책이 파생되는 기본 클래스입니다. |
| BlobBatch |
BlobBatch는 Blob에 대해 집계된 작업 집합을 나타냅니다.
현재는 |
| BlobBatchClient |
BlobBatchClient를 사용하면 Azure Storage Blob 서비스에 일괄 처리를 요청할 수 있습니다. https://learn.microsoft.com/rest/api/storageservices/blob-batch 참조 |
| BlobClient |
BlobClient는 Azure Storage Blob에 대한 URL을 나타냅니다. Blob은 블록 Blob, 추가 Blob 또는 페이지 Blob일 수 있습니다. |
| BlobLeaseClient |
ContainerClient 또는 BlobClient대한 임대를 관리하는 클라이언트입니다. |
| BlobSASPermissions |
NODE.JS 런타임에서만 사용할 수 있습니다. ServiceSAS가 Blob에 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 직렬화되고 BlobSASSignatureValues 개체에 대한 사용 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| BlobServiceClient |
BlobServiceClient는 Blob 컨테이너를 조작할 수 있는 Azure Storage Blob 서비스에 대한 클라이언트를 나타냅니다. |
| BlockBlobClient |
BlockBlobClient는 블록 Blob에 적용할 수 있는 작업 집합을 정의합니다. |
| ContainerClient |
ContainerClient는 Blob을 조작할 수 있는 Azure Storage 컨테이너의 URL을 나타냅니다. |
| ContainerSASPermissions |
ServiceSAS가 컨테이너에 부여한 권한을 나타내는 문자열을 생성하는 도우미 클래스입니다. 값을 true로 설정하면 이러한 권한을 사용하는 모든 SAS가 해당 작업에 대한 권한을 부여합니다. 모든 값이 설정되면 toString을 사용하여 직렬화되고 BlobSASSignatureValues 개체에 대한 사용 권한 필드로 설정되어야 합니다. 이 클래스 없이 사용 권한 문자열을 생성할 수 있지만 사용 권한 순서는 특정하며 이 클래스는 정확성을 보장합니다. |
| Credential |
자격 증명은 Azure Storage HTTP 요청 서명을 위한 추상 클래스입니다. 이 클래스는 CredentialPolicy를 생성하는 credentialPolicyCreator 팩터리를 호스트합니다. |
| CredentialPolicy |
보내기 전에 HTTP(S) 요청에 서명하는 데 사용되는 자격 증명 정책입니다. 추상 클래스입니다. |
| PageBlobClient |
PageBlobClient는 페이지 Blob에 적용할 수 있는 작업 집합을 정의합니다. |
| Pipeline |
HTTP 요청 정책을 포함하는 파이프라인 클래스입니다. newPipeline호출하여 기본 파이프라인을 만들 수 있습니다. 또는 파이프라인 생성자가 고유한 정책을 사용하여 파이프라인을 만들 수 있습니다. 사용자 지정된 파이프라인을 구현하기 전에 newPipeline 및 제공된 정책을 참조하세요. |
| SASQueryParameters |
Azure Storage SAS의 쿼리 매개 변수를 구성하는 구성 요소를 나타냅니다. 이 형식은 사용자가 직접 생성하지 않습니다. AccountSASSignatureValues 및 BlobSASSignatureValues 형식에서만 생성됩니다. 생성되면 toString() 인코딩하고 URL에 직접 추가할 수 있습니다(기존 쿼리 매개 변수가 있는 경우 주의해야 하지만 이러한 쿼리 매개 변수를 추가하는 적절한 수단에 영향을 줄 수 있음). 참고: 이 클래스의 인스턴스는 변경할 수 없습니다. |
| StorageBrowserPolicy |
StorageBrowserPolicy는 다음을 포함하여 Node.js 브라우저 런타임 간의 차이를 처리합니다.
Node.js이 정책은 no-op 패스스루입니다. |
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory는 StorageBrowserPolicy 개체를 생성하는 데 도움이 되는 팩터리 클래스입니다. |
| StorageRetryPolicy |
지수 재시도 및 선형 재시도를 구현한 재시도 정책입니다. |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory는 StorageRetryPolicy 개체를 생성하는 데 도움이 되는 팩터리 클래스입니다. |
| StorageSharedKeyCredential |
NODE.JS 런타임에서만 사용할 수 있습니다. Azure Storage 서비스의 계정 키 권한 부여에 대한 StorageSharedKeyCredential입니다. |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy는 공유 키를 사용하여 HTTP 요청에 서명하는 데 사용되는 정책입니다. |
인터페이스
형식 별칭
| AccessTier |
AccessTier에 대한 값을 정의합니다. |
| AccountKind |
AccountKind에 대한 값을 정의합니다. |
| AppendBlobAppendBlockFromUrlResponse |
appendBlockFromUrl 작업에 대한 응답 데이터를 포함합니다. |
| AppendBlobAppendBlockResponse |
appendBlock 작업에 대한 응답 데이터를 포함합니다. |
| AppendBlobClientOptions |
AppendBlobClient 인스턴스 생성 옵션 |
| AppendBlobCreateResponse |
만들기 작업에 대한 응답 데이터를 포함합니다. |
| ArchiveStatus |
ArchiveStatus에 대한 값을 정의합니다. |
| BlobAbortCopyFromURLResponse |
abortCopyFromURL 작업에 대한 응답 데이터를 포함합니다. |
| BlobBatchDeleteBlobsResponse |
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) 작업에 대한 응답 데이터를 포함합니다. |
| BlobBatchSetBlobsAccessTierResponse |
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) 작업에 대한 응답 데이터를 포함합니다. |
| BlobBatchSubmitBatchResponse |
Blob 일괄 처리 작업에 대한 응답 데이터를 포함합니다. |
| BlobClientOptions |
BlobClient 인스턴스 생성 옵션 |
| BlobCopyFromURLResponse |
copyFromURL 작업에 대한 응답 데이터를 포함합니다. |
| BlobCopySourceTags |
BlobCopySourceTags에 대한 값을 정의합니다. |
| BlobCreateSnapshotResponse |
createSnapshot 작업에 대한 응답 데이터를 포함합니다. |
| BlobDeleteImmutabilityPolicyResponse |
deleteImmutabilityPolicy 작업에 대한 응답 데이터를 포함합니다. |
| BlobDeleteResponse |
삭제 작업에 대한 응답 데이터를 포함합니다. |
| BlobDownloadResponseInternal |
다운로드 작업(내부)에 대한 응답 데이터를 포함합니다. 이 버전은 NodeJS.ReadableStream 대신 NodeJSReadableStream을 사용하는 재정의된 버전입니다. |
| BlobDownloadResponseModel |
다운로드 작업에 대한 응답 데이터를 포함합니다. |
| BlobGetAccountInfoResponse |
getAccountInfo 작업에 대한 응답 데이터를 포함합니다. |
| BlobGetPropertiesResponseModel |
getProperties 작업에 대한 응답 데이터를 포함합니다. |
| BlobGetTagsResponse |
BlobClient.getTags 연산에 대한 응답 데이터를 포함하고 있습니다. |
| BlobImmutabilityPolicyMode |
BlobImmutabilityPolicyMode에 대한 값을 정의합니다. |
| BlobQueryArrowFieldType |
BlobQueryArrowField형식입니다. |
| BlobQueryResponseInternal |
쿼리 연산(내부)에 대한 응답 데이터를 포함합니다. 이 버전은 NodeJS.ReadableStream 대신 NodeJSReadableStream을 사용하는 재정의된 버전입니다. |
| BlobQueryResponseModel |
쿼리 작업에 대한 응답 데이터를 포함합니다. |
| BlobServiceClientOptions |
BlobServiceClient 인스턴스 생성 옵션 |
| BlobSetHTTPHeadersResponse |
setHttpHeaders 작업에 대한 응답 데이터를 포함합니다. |
| BlobSetImmutabilityPolicyResponse |
setImmutabilityPolicy 작업에 대한 응답 데이터를 포함합니다. |
| BlobSetLegalHoldResponse |
setLegalHold 작업에 대한 응답 데이터를 포함합니다. |
| BlobSetMetadataResponse |
setMetadata 작업에 대한 응답 데이터를 포함합니다. |
| BlobSetTagsResponse |
setTags 작업에 대한 응답 데이터를 포함합니다. |
| BlobSetTierResponse |
setTier 작업에 대한 응답 데이터를 포함합니다. |
| BlobStartCopyFromURLResponse |
startCopyFromURL 작업에 대한 응답 데이터를 포함합니다. |
| BlobType |
BlobType에 대한 값을 정의합니다. |
| BlobUndeleteResponse |
삭제 취소 작업에 대한 응답 데이터를 포함합니다. |
| BlobUploadCommonResponse |
BlockBlobClient.uploadFile, BlockBlobClient.uploadStream, 그리고 <xref:BlockBlobClient.uploadBrowserDate>. |
| BlockBlobClientOptions |
BlockBlobClient 인스턴스 생성 옵션 |
| BlockBlobCommitBlockListResponse |
commitBlockList 작업에 대한 응답 데이터를 포함합니다. |
| BlockBlobGetBlockListResponse |
getBlockList 작업에 대한 응답 데이터를 포함합니다. |
| BlockBlobGetBlockListResponseInternal |
getBlockList 작업에 대한 응답 데이터를 포함합니다. |
| BlockBlobPutBlobFromUrlResponse |
putBlobFromUrl 작업에 대한 응답 데이터를 포함합니다. |
| BlockBlobStageBlockFromURLResponse |
stageBlockFromURL 작업에 대한 응답 데이터를 포함합니다. |
| BlockBlobStageBlockResponse |
stageBlock 작업에 대한 응답 데이터를 포함합니다. |
| BlockBlobUploadResponse |
업로드 작업에 대한 응답 데이터를 포함합니다. |
| BlockListType |
BlockListType에 대한 값을 정의합니다. |
| ContainerClientOptions |
ContainerClient 인스턴스 생성 옵션 |
| ContainerCreateResponse |
만들기 작업에 대한 응답 데이터를 포함합니다. |
| ContainerDeleteResponse |
삭제 작업에 대한 응답 데이터를 포함합니다. |
| ContainerFilterBlobsResponse |
filterBlobs 작업에 대한 응답 데이터를 포함합니다. |
| ContainerFindBlobsByTagsSegmentResponse |
BlobServiceClient.findBlobsByTags 연산의 응답입니다. |
| ContainerGetAccessPolicyResponse |
ContainerClient.getAccessPolicy 작업에 대한 응답 데이터를 포함하고 있습니다. |
| ContainerGetAccessPolicyResponseModel |
getAccessPolicy 작업에 대한 응답 데이터를 포함합니다. |
| ContainerGetAccountInfoResponse |
getAccountInfo 작업에 대한 응답 데이터를 포함합니다. |
| ContainerGetPropertiesResponse |
getProperties 작업에 대한 응답 데이터를 포함합니다. |
| ContainerListBlobFlatSegmentResponse |
listBlobFlatSegment 작업에 대한 응답 데이터를 포함합니다. |
| ContainerListBlobHierarchySegmentResponse |
listBlobHierarchySegment 작업에 대한 응답 데이터를 포함합니다. |
| ContainerRenameResponse |
이름 바꾸기 작업에 대한 응답 데이터를 포함합니다. |
| ContainerSetAccessPolicyResponse |
setAccessPolicy 작업에 대한 응답 데이터를 포함합니다. |
| ContainerSetMetadataResponse |
setMetadata 작업에 대한 응답 데이터를 포함합니다. |
| ContainerUndeleteResponse |
복원 작업에 대한 응답 데이터를 포함합니다. |
| CopyPollerBlobClient |
BlobClient.beginCopyFromURL이 반환하는 폴러가 작동하기 위해 필요한 BlobClient 연산을 정의합니다. |
| CopyStatusType |
CopyStatusType에 대한 값을 정의합니다. |
| CredentialPolicyCreator |
제공된 nextPolicy를 사용하는 새 CredentialPolicy를 만드는 팩터리 함수입니다. |
| DeleteSnapshotsOptionType |
DeleteSnapshotsOptionType에 대한 값을 정의합니다. |
| EncryptionAlgorithmType |
EncryptionAlgorithmType에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값AES256 |
| FileShareTokenIntent |
FileShareTokenIntent에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값backup |
| GeoReplicationStatusType |
GeoReplicationStatusType에 대한 값을 정의합니다. |
| HttpRequestBody |
요청에서 지원되는 본문 유형입니다. NodeReadableStream 그리고 () => NodeReadableStream은 Node 전용 노드입니다. Blob, WebReadableStream<Uint8Array>, 그리고 () => WebReadableStream<Uint8Array> 는 브라우저 전용 기능입니다. |
| LeaseDurationType |
LeaseDurationType에 대한 값을 정의합니다. |
| LeaseOperationResponse |
임대를 만들거나 수정하거나 삭제하는 작업에 대한 응답 데이터를 포함합니다. BlobLeaseClient를 참조하세요. |
| LeaseStateType |
LeaseStateType에 대한 값을 정의합니다. |
| LeaseStatusType |
LeaseStatusType에 대한 값을 정의합니다. |
| ObjectReplicationStatus |
Blob의 복제 상태를 지정합니다. 스토리지 계정에 개체 복제 정책이 적용된 경우에 사용됩니다. ObjectReplicationPolicy 및 ObjectReplicationRule 참조하세요. |
| PageBlobClearPagesResponse |
clearPages 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobClientOptions |
PageBlobClient 인스턴스 생성 옵션 |
| PageBlobCopyIncrementalResponse |
copyIncremental 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobCreateResponse |
만들기 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobGetPageRangesDiffResponseInternal |
getPageRangesDiff 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobGetPageRangesDiffResponseModel |
getPageRangesDiff 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobGetPageRangesResponseInternal |
getPageRanges 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobGetPageRangesResponseModel |
getPageRanges 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobResizeResponse |
크기 조정 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobUpdateSequenceNumberResponse |
updateSequenceNumber 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobUploadPagesFromURLResponse |
uploadPagesFromURL 작업에 대한 응답 데이터를 포함합니다. |
| PageBlobUploadPagesResponse |
uploadPages 작업에 대한 응답 데이터를 포함합니다. |
| PublicAccessType |
PublicAccessType에 대한 값을 정의합니다. |
| RehydratePriority |
RehydratePriority에 대한 값을 정의합니다. |
| RequestHeaders |
SAS 토큰 생성에 사용되는 요청 헤더 |
| RequestQueryParameters |
SAS 토큰 생성에 사용되는 요청 쿼리 매개변수 |
| SequenceNumberActionType |
SequenceNumberActionType에 대한 값을 정의합니다. |
| ServiceFindBlobsByTagsSegmentResponse |
BlobServiceClient.findBlobsByTags 연산의 응답입니다. |
| ServiceGetAccountInfoResponse |
getAccountInfo 작업에 대한 응답 데이터를 포함합니다. |
| ServiceGetPropertiesResponse |
getProperties 작업에 대한 응답 데이터를 포함합니다. |
| ServiceGetPropertiesResponseInternal |
getProperties 작업에 대한 응답 데이터를 포함합니다. |
| ServiceGetStatisticsResponse |
getStatistics 작업에 대한 응답 데이터를 포함합니다. |
| ServiceGetStatisticsResponseInternal |
getStatistics 작업에 대한 응답 데이터를 포함합니다. |
| ServiceGetUserDelegationKeyResponse |
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) 작업에 대한 응답 데이터를 포함합니다. |
| ServiceListContainersSegmentResponse |
listContainersSegment 작업에 대한 응답 데이터를 포함합니다. |
| ServiceListContainersSegmentResponseInternal |
listContainersSegment 작업에 대한 응답 데이터를 포함합니다. |
| ServiceSetPropertiesResponse |
setProperties 작업에 대한 응답 데이터를 포함합니다. |
| ServiceSubmitBatchResponseInternal |
submitBatch 연산(내부)에 대한 응답 데이터를 포함하고 있습니다. 이 버전은 NodeJS.ReadableStream 대신 NodeJSReadableStream을 사용하는 재정의된 버전입니다. |
| ServiceSubmitBatchResponseModel |
submitBatch 작업에 대한 응답 데이터를 포함합니다. |
| SkuName |
SkuName에 대한 값을 정의합니다. |
| StorageChecksumAlgorithm |
콘텐츠 검증에 사용할 체크섬 알고리즘을 나타냅니다. |
| SyncCopyStatusType |
SyncCopyStatusType에 대한 값을 정의합니다. |
| Tags |
Blob 태그. |
| WithResponse |
알려진 _response 속성이 있는 작업 결과를 나타내는 형식입니다. |
열거형
| BlockBlobTier |
Blob의 액세스 계층을 나타냅니다. 블록 Blob 수준 계층화에 대한 자세한 내용은 핫, 쿨 및 보관 스토리지 계층 참조하세요. |
| KnownEncryptionAlgorithmType | |
| PremiumPageBlobTier |
Blob을 설정할 페이지 Blob 계층을 지정합니다. 이는 Premium Storage 계정의 페이지 Blob에만 적용됩니다. 해당 IOPS 및 PageBlobTier당 처리량에 대한 자세한 내용은 여기 참조하세요. |
| SASProtocol |
생성된 SAS에 대한 프로토콜입니다. |
| StorageBlobAudience |
Storage에 대해 알려진 클라우드 대상 그룹을 정의합니다. |
| StorageRetryPolicyType |
RetryPolicy 형식입니다. |
함수
| generate |
NODE.JS 런타임에서만 사용할 수 있습니다. 실제 REST 요청을 만드는 데 필요한 모든 SAS 쿼리 매개 변수를 포함하는 SASQueryParameters 개체를 생성합니다. https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas 참조 |
| generate |
NODE.JS 런타임에서만 사용할 수 있습니다. SASQueryParameters의 인스턴스를 만듭니다. SAS를 만드는 데 필요한 설정만 허용합니다. 선택적 설정의 경우 사용 권한, startsOn 및 식별자와 같은 해당 속성을 직접 설정하세요. 경고: 식별자가 제공되지 않으면 사용 권한 및 expiresOn이 필요합니다. 이 생성자를 사용하여 초기화할 경우 ID에 값을 할당하거나 expiresOn & 권한을 수동으로 할당해야 합니다. 다음 코드 조각을 실행하기 전에 필요한 세부 정보를 입력합니다. 사용 예: 식별자를 사용하는 예제: Blob 이름을 사용하는 예제: |
| generate |
NODE.JS 런타임에서만 사용할 수 있습니다. SASQueryParameters의 인스턴스를 만듭니다. 경고: 사용자 위임 SAS를 생성할 때 식별자가 무시되고 권한 및 expiresOn이 필요합니다. 사용 예: |
| get |
Blob 서비스에 대한 스토리지 계정에 대한 OAuth 대상 그룹을 가져옵니다. |
| is |
지정된 인수가 파이프라인 계약을 충족하는지 여부를 결정하는 도우미 |
| is |
RestError용 Typeguard |
| new |
자격 증명이 제공된 새 Pipeline 개체를 만듭니다. |
변수
| Rest |
실패한 파이프라인 요청에 대한 사용자 지정 오류 유형입니다. |
| Storage |
서비스가 목록을 반환할 때 사용해야 할 형식을 지정합니다. |
| Storage |
Azure 스토리지와 함께 사용할 수 있는 OAuth 범위입니다. |
| logger | 이 패키지의 구성입니다 |
함수 세부 정보
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
NODE.JS 런타임에서만 사용할 수 있습니다.
실제 REST 요청을 만드는 데 필요한 모든 SAS 쿼리 매개 변수를 포함하는 SASQueryParameters 개체를 생성합니다.
https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas 참조
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters매개 변수
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
반품
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)
NODE.JS 런타임에서만 사용할 수 있습니다.
SASQueryParameters의 인스턴스를 만듭니다.
SAS를 만드는 데 필요한 설정만 허용합니다. 선택적 설정의 경우 사용 권한, startsOn 및 식별자와 같은 해당 속성을 직접 설정하세요.
경고: 식별자가 제공되지 않으면 사용 권한 및 expiresOn이 필요합니다. 이 생성자를 사용하여 초기화할 경우 ID에 값을 할당하거나 expiresOn & 권한을 수동으로 할당해야 합니다.
다음 코드 조각을 실행하기 전에 필요한 세부 정보를 입력합니다.
사용 예:
import {
StorageSharedKeyCredential,
generateBlobSASQueryParameters,
ContainerSASPermissions,
SASProtocol,
} from "@azure/storage-blob";
const account = "<account>";
const accountKey = "<accountkey>";
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
const containerName = "<container name>";
// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters(
{
containerName, // Required
permissions: ContainerSASPermissions.parse("racwdl"), // Required
startsOn: new Date(), // Optional
expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Required. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2016-05-31", // Optional
},
sharedKeyCredential,
).toString();
식별자를 사용하는 예제:
import {
StorageSharedKeyCredential,
BlobServiceClient,
ContainerSASPermissions,
generateBlobSASQueryParameters,
} from "@azure/storage-blob";
const account = "<account>";
const accountKey = "<accountkey>";
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
sharedKeyCredential,
);
const containerName = "<container name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
{
accessPolicy: {
expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Date type
permissions: ContainerSASPermissions.parse("racwdl").toString(),
startsOn: new Date(), // Date type
},
id: identifier,
},
]);
const containerSAS = generateBlobSASQueryParameters(
{
containerName, // Required
identifier, // Required
},
sharedKeyCredential,
).toString();
Blob 이름을 사용하는 예제:
import {
StorageSharedKeyCredential,
generateBlobSASQueryParameters,
BlobSASPermissions,
SASProtocol,
} from "@azure/storage-blob";
const account = "<account>";
const accountKey = "<accountkey>";
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
const containerName = "<container name>";
const blobName = "<blob name>";
// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters(
{
containerName, // Required
blobName, // Required
permissions: BlobSASPermissions.parse("racwd"), // Required
startsOn: new Date(), // Optional
expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Required. Date type
cacheControl: "cache-control-override", // Optional
contentDisposition: "content-disposition-override", // Optional
contentEncoding: "content-encoding-override", // Optional
contentLanguage: "content-language-override", // Optional
contentType: "content-type-override", // Optional
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2016-05-31", // Optional
},
sharedKeyCredential,
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters매개 변수
- blobSASSignatureValues
- BlobSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
반품
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)
NODE.JS 런타임에서만 사용할 수 있습니다.
SASQueryParameters의 인스턴스를 만듭니다. 경고: 사용자 위임 SAS를 생성할 때 식별자가 무시되고 권한 및 expiresOn이 필요합니다.
사용 예:
import {
BlobServiceClient,
generateBlobSASQueryParameters,
ContainerSASPermissions,
SASProtocol,
} from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";
const account = "<account>";
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
new DefaultAzureCredential(),
);
const containerName = "<container name>";
const accountName = "<account name>";
const startsOn = new Date();
const expiresOn = new Date(new Date().valueOf() + 86400 * 1000);
// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters(
{
containerName, // Required
permissions: ContainerSASPermissions.parse("racwdl"), // Required
startsOn, // Optional. Date type
expiresOn, // Required. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2018-11-09", // Must greater than or equal to 2018-11-09 to generate user delegation SAS
},
userDelegationKey, // UserDelegationKey
accountName,
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters매개 변수
- blobSASSignatureValues
- BlobSASSignatureValues
- userDelegationKey
- UserDelegationKey
blobServiceClient.getUserDelegationKey() 반환 값
- accountName
-
string
반품
getBlobServiceAccountAudience(string)
Blob 서비스에 대한 스토리지 계정에 대한 OAuth 대상 그룹을 가져옵니다.
function getBlobServiceAccountAudience(storageAccountName: string): string매개 변수
- storageAccountName
-
string
반품
string
isPipelineLike(unknown)
지정된 인수가 파이프라인 계약을 충족하는지 여부를 결정하는 도우미
function isPipelineLike(pipeline: unknown): pipeline is PipelineLike매개 변수
- pipeline
-
unknown
파이프라인일 수 있는 인수
반품
pipeline is PipelineLike
인수가 파이프라인 계약을 충족하는 경우 true입니다.
isRestError(unknown)
RestError용 Typeguard
function isRestError(e: unknown): e is RestError매개 변수
- e
-
unknown
캐치 절에 의해 잡힌 무언가.
반품
e is RestError
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
자격 증명이 제공된 새 Pipeline 개체를 만듭니다.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline매개 변수
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential, StorageSharedKeyCredential 또는 서비스에 대한 요청을 인증하는 @azure/identity 패키지의 자격 증명과 같은 TokenCredential 인터페이스를 구현하는 개체를 제공할 수도 있습니다. 지정하지 않으면 AnonymousCredential이 사용됩니다.
- pipelineOptions
- StoragePipelineOptions
Optional. Options.
반품
새 Pipeline 개체입니다.
변수 세부 정보
RestError
StorageResponseFormat
서비스가 목록을 반환할 때 사용해야 할 형식을 지정합니다.
StorageResponseFormat: { Arrow: "Arrow", Auto: "Auto", Xml: "Xml" }형식
{ Arrow: "Arrow", Auto: "Auto", Xml: "Xml" }
StorageOAuthScopes
Azure 스토리지와 함께 사용할 수 있는 OAuth 범위입니다.
StorageOAuthScopes: string | string[]형식
string | string[]