BlobServiceClient class
BlobServiceClient는 Blob 컨테이너를 조작할 수 있는 Azure Storage Blob 서비스에 대한 클라이언트를 나타냅니다.
- Extends
-
StorageClient
생성자
Blob |
BlobServiceClient의 인스턴스를 만듭니다. |
Blob |
BlobServiceClient의 인스턴스를 만듭니다. |
상속된 속성
account |
|
credential | AnonymousCredential, StorageSharedKeyCredential 또는 패키지의 |
url | 인코딩된 URL 문자열 값입니다. |
메서드
create |
Blob 컨테이너를 만듭니다. https://docs.microsoft.com/en-us/rest/api/storageservices/create-container를 참조하세요. |
delete |
Blob 컨테이너를 삭제합니다. |
find |
지정된 계정에서 지정된 태그가 있는 모든 Blob을 찾기 위한 비동기 반복기를 반환합니다. .byPage()는 페이지에 Blob을 나열하는 비동기 반복기를 반환합니다. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties를 참조하세요. 구문을 사용하는
표식과 함께 페이징을 사용하는 예제:
|
from |
연결 문자열에서 BlobServiceClient의 인스턴스를 만듭니다. |
generate |
공유 키 자격 증명을 사용하여 생성된 BlobServiceClient에만 사용할 수 있습니다. 전달된 클라이언트 속성 및 매개 변수를 기반으로 Blob 계정 SAS(공유 액세스 서명) URI를 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다. https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas를 참조하세요. |
get |
계정 정보 가져오기 작업은 지정된 계정에 대한 sku 이름 및 계정 종류를 반환합니다. 계정 정보 가져오기 작업은 버전 2018-03-28부터 서비스 버전에서 사용할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information를 참조하세요. |
get |
배치 작업을 수행하기 위해 BlobBatchClient 개체를 만듭니다. https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch를 참조하세요. |
get |
ContainerClient 개체를 만듭니다. |
get |
스토리지 분석 및 CORS(원본 간 리소스 공유) 규칙에 대한 속성을 포함하여 스토리지 계정 Blob 서비스의 속성을 가져옵니다. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties를 참조하세요. |
get |
Blob 서비스에 대한 복제와 관련된 통계를 검색합니다. 이 작업은 저장소 계정에 대해 읽기 액세스 지리적 중복 복제가 설정되어 있는 경우 보조 위치 엔드포인트에서만 사용할 수 있습니다. https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats를 참조하세요. |
get |
전달자 토큰 인증(TokenCredential)을 사용하는 경우에만 사용할 수 있습니다. Blob 서비스에 대한 사용자 위임 키를 검색합니다. 전달자 토큰 인증을 사용하는 경우에만 유효한 작업입니다. https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key를 참조하세요. |
list |
지정된 계정 아래의 모든 컨테이너를 나열하는 비동기 반복기를 반환합니다. .byPage()는 비동기 반복 반복기를 반환하여 페이지에 컨테이너를 나열합니다. 구문을 사용하는
표식과 함께 페이징을 사용하는 예제:
|
set |
스토리지 분석, CORS(원본 간 리소스 공유) 규칙 및 일시 삭제 설정에 대한 속성을 포함하여 스토리지 계정의 Blob Service 엔드포인트에 대한 속성을 설정합니다. https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties를 참조하세요. |
undelete |
이전에 삭제된 Blob 컨테이너를 복원합니다. 이 API는 컨테이너와 연결된 스토리지 계정에 대해 컨테이너 일시 삭제를 사용하도록 설정한 경우에만 작동합니다. |
생성자 세부 정보
BlobServiceClient(string, PipelineLike)
BlobServiceClient의 인스턴스를 만듭니다.
new BlobServiceClient(url: string, pipeline: PipelineLike)
매개 변수
- url
-
string
Azure Storage Blob 서비스를 가리키는 클라이언트 문자열(예: "https://myaccount.blob.core.windows.net") AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.blob.core.windows.net?sasString").
- pipeline
- PipelineLike
newPipeline()을 호출하여 기본 파이프라인을 만들거나 사용자 지정된 파이프라인을 제공합니다.
BlobServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
BlobServiceClient의 인스턴스를 만듭니다.
new BlobServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
매개 변수
- url
-
string
Azure Storage Blob 서비스를 가리키는 클라이언트 문자열(예: "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 파이프라인을 구성하는 옵션입니다.
에서 @azure/identity
DefaultAzureCredential을 사용하는 예제입니다.
const account = "<storage account name>";
const defaultAzureCredential = new DefaultAzureCredential();
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
defaultAzureCredential
);
계정 이름/키를 사용하는 예제:
const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");
const blobServiceClient = new BlobServiceClient(
`https://${account}.blob.core.windows.net`,
sharedKeyCredential
);
상속된 속성 세부 정보
accountName
accountName: string
속성 값
string
상속된 From StorageClient.accountName
credential
AnonymousCredential, StorageSharedKeyCredential 또는 패키지의 @azure/identity
자격 증명과 같이 서비스에 대한 요청을 인증합니다. TokenCredential 인터페이스를 구현하는 개체를 제공할 수도 있습니다. 지정하지 않으면 AnonymousCredential이 사용됩니다.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
속성 값
상속된 From StorageClient.credential
url
인코딩된 URL 문자열 값입니다.
url: string
속성 값
string
상속된 From StorageClient.url
메서드 세부 정보
createContainer(string, ContainerCreateOptions)
Blob 컨테이너를 만듭니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/create-container를 참조하세요.
function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
매개 변수
- containerName
-
string
만들 컨테이너의 이름입니다.
- options
- ContainerCreateOptions
컨테이너 만들기 작업을 구성하는 옵션입니다.
반환
Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>
컨테이너 만들기 응답 및 해당 컨테이너 클라이언트.
deleteContainer(string, ContainerDeleteMethodOptions)
Blob 컨테이너를 삭제합니다.
function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>
매개 변수
- containerName
-
string
삭제할 컨테이너의 이름입니다.
- options
- ContainerDeleteMethodOptions
컨테이너 삭제 작업을 구성하는 옵션입니다.
반환
Promise<ContainerDeleteResponse>
컨테이너 삭제 응답입니다.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)
지정된 계정에서 지정된 태그가 있는 모든 Blob을 찾기 위한 비동기 반복기를 반환합니다.
.byPage()는 페이지에 Blob을 나열하는 비동기 반복기를 반환합니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties를 참조하세요.
구문을 사용하는 for await
예제:
let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
console.log(`Blob ${i++}: ${container.name}`);
}
iter.next()
을(를) 사용하는 예제:
let i = 1;
const iter = blobServiceClient.findBlobsByTags("tagkey='tagvalue'");
let blobItem = await iter.next();
while (!blobItem.done) {
console.log(`Blob ${i++}: ${blobItem.value.name}`);
blobItem = await iter.next();
}
byPage()
을(를) 사용하는 예제:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
if (response.blobs) {
for (const blob of response.blobs) {
console.log(`Blob ${i++}: ${blob.name}`);
}
}
}
표식과 함께 페이징을 사용하는 예제:
let i = 1;
let iterator = blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 blob names
if (response.blobs) {
for (const blob of response.blobs) {
console.log(`Blob ${i++}: ${blob.name}`);
}
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
.findBlobsByTags("tagkey='tagvalue'")
.byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints blob names
if (response.blobs) {
for (const blob of response.blobs) {
console.log(`Blob ${i++}: ${blob.name}`);
}
}
function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse, PageSettings>
매개 변수
- tagFilterSqlExpression
-
string
where 매개 변수를 사용하면 호출자가 태그가 지정된 식과 일치하는 Blob을 쿼리할 수 있습니다. Blob이 결과에 반환되려면 지정된 식이 true로 평가되어야 합니다. [OData - ABNF] 필터 구문 규칙은 where 쿼리 매개 변수의 값에 대한 공식 문법을 정의합니다. 그러나 OData 필터 구문의 하위 집합만 Blob 서비스에서 지원됩니다.
- options
- ServiceFindBlobByTagsOptions
태그로 Blob을 찾는 옵션입니다.
반환
fromConnectionString(string, StoragePipelineOptions)
연결 문자열에서 BlobServiceClient의 인스턴스를 만듭니다.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient
매개 변수
- 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
- options
- StoragePipelineOptions
(선택 사항) HTTP 파이프라인을 구성하는 옵션입니다.
반환
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
공유 키 자격 증명을 사용하여 생성된 BlobServiceClient에만 사용할 수 있습니다.
전달된 클라이언트 속성 및 매개 변수를 기반으로 Blob 계정 SAS(공유 액세스 서명) URI를 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas를 참조하세요.
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
매개 변수
- expiresOn
-
Date
(선택 사항) 공유 액세스 서명이 유효하지 않은 시간입니다. 기본값은 1시간 후(제공되지 않은 경우)입니다.
- permissions
- AccountSASPermissions
SAS와 연결할 사용 권한 목록을 지정합니다.
- resourceTypes
-
string
공유 액세스 서명과 연결된 리소스 종류를 지정합니다.
선택적 매개 변수입니다.
반환
string
이 클라이언트가 나타내는 리소스에 대한 URI와 생성된 SAS 토큰으로 구성된 계정 SAS URI입니다.
getAccountInfo(ServiceGetAccountInfoOptions)
계정 정보 가져오기 작업은 지정된 계정에 대한 sku 이름 및 계정 종류를 반환합니다. 계정 정보 가져오기 작업은 버전 2018-03-28부터 서비스 버전에서 사용할 수 있습니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information를 참조하세요.
function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>
매개 변수
- options
- ServiceGetAccountInfoOptions
서비스 계정 정보 가져오기 작업에 대한 옵션입니다.
반환
Promise<ServiceGetAccountInfoResponse>
서비스 계정 정보 가져오기 작업에 대한 응답 데이터입니다.
getBlobBatchClient()
배치 작업을 수행하기 위해 BlobBatchClient 개체를 만듭니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch를 참조하세요.
function getBlobBatchClient(): BlobBatchClient
반환
이 서비스에 대한 새 BlobBatchClient 개체입니다.
getContainerClient(string)
ContainerClient 개체를 만듭니다.
function getContainerClient(containerName: string): ContainerClient
매개 변수
- containerName
-
string
컨테이너 이름
반환
지정된 컨테이너 이름에 대한 새 ContainerClient 개체입니다.
예제 사용법:
const containerClient = blobServiceClient.getContainerClient("<container name>");
getProperties(ServiceGetPropertiesOptions)
스토리지 분석 및 CORS(원본 간 리소스 공유) 규칙에 대한 속성을 포함하여 스토리지 계정 Blob 서비스의 속성을 가져옵니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties를 참조하세요.
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
매개 변수
- options
- ServiceGetPropertiesOptions
서비스 속성 가져오기 작업에 대한 옵션입니다.
반환
Promise<ServiceGetPropertiesResponse>
서비스 속성 가져오기 작업에 대한 응답 데이터입니다.
getStatistics(ServiceGetStatisticsOptions)
Blob 서비스에 대한 복제와 관련된 통계를 검색합니다. 이 작업은 저장소 계정에 대해 읽기 액세스 지리적 중복 복제가 설정되어 있는 경우 보조 위치 엔드포인트에서만 사용할 수 있습니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats를 참조하세요.
function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>
매개 변수
- options
- ServiceGetStatisticsOptions
서비스 통계 가져오기 작업에 대한 옵션입니다.
반환
Promise<ServiceGetStatisticsResponse>
Service Get Statistics 작업에 대한 응답 데이터입니다.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
전달자 토큰 인증(TokenCredential)을 사용하는 경우에만 사용할 수 있습니다.
Blob 서비스에 대한 사용자 위임 키를 검색합니다. 전달자 토큰 인증을 사용하는 경우에만 유효한 작업입니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key를 참조하세요.
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
매개 변수
- startsOn
-
Date
사용자 위임 SAS의 시작 시간입니다. 현재 시간에서 7일 이내여야 합니다.
- expiresOn
-
Date
사용자 위임 SAS의 종료 시간입니다. 현재 시간에서 7일 이내여야 합니다.
반환
Promise<ServiceGetUserDelegationKeyResponse>
listContainers(ServiceListContainersOptions)
지정된 계정 아래의 모든 컨테이너를 나열하는 비동기 반복기를 반환합니다.
.byPage()는 비동기 반복 반복기를 반환하여 페이지에 컨테이너를 나열합니다.
구문을 사용하는 for await
예제:
let i = 1;
for await (const container of blobServiceClient.listContainers()) {
console.log(`Container ${i++}: ${container.name}`);
}
iter.next()
을(를) 사용하는 예제:
let i = 1;
const iter = blobServiceClient.listContainers();
let containerItem = await iter.next();
while (!containerItem.done) {
console.log(`Container ${i++}: ${containerItem.value.name}`);
containerItem = await iter.next();
}
byPage()
을(를) 사용하는 예제:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
if (response.containerItems) {
for (const container of response.containerItems) {
console.log(`Container ${i++}: ${container.name}`);
}
}
}
표식과 함께 페이징을 사용하는 예제:
let i = 1;
let iterator = blobServiceClient.listContainers().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 container names
if (response.containerItems) {
for (const container of response.containerItems) {
console.log(`Container ${i++}: ${container.name}`);
}
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
.listContainers()
.byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 container names
if (response.containerItems) {
for (const container of response.containerItems) {
console.log(`Container ${i++}: ${container.name}`);
}
}
function listContainers(options?: ServiceListContainersOptions): PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>
매개 변수
- options
- ServiceListContainersOptions
컨테이너를 나열하는 옵션입니다.
반환
페이징을 지원하는 asyncIterableIterator입니다.
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
스토리지 분석, CORS(원본 간 리소스 공유) 규칙 및 일시 삭제 설정에 대한 속성을 포함하여 스토리지 계정의 Blob Service 엔드포인트에 대한 속성을 설정합니다.
https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties를 참조하세요.
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
매개 변수
- properties
- BlobServiceProperties
- options
- ServiceSetPropertiesOptions
서비스 설정 속성 작업에 대한 옵션입니다.
반환
Promise<ServiceSetPropertiesResponse>
서비스 집합 속성 작업에 대한 응답 데이터입니다.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)
이전에 삭제된 Blob 컨테이너를 복원합니다. 이 API는 컨테이너와 연결된 스토리지 계정에 대해 컨테이너 일시 삭제를 사용하도록 설정한 경우에만 작동합니다.
function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
매개 변수
- deletedContainerName
-
string
이전에 삭제된 컨테이너의 이름입니다.
- deletedContainerVersion
-
string
삭제된 컨테이너를 고유하게 식별하는 데 사용되는 이전에 삭제된 컨테이너의 버전입니다.
- options
- ServiceUndeleteContainerOptions
컨테이너 복원 작업을 구성하는 옵션입니다.
반환
Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>
컨테이너 삭제 응답입니다.