TypeScript로 컨테이너 속성 및 메타데이터 관리

아티클
10/18/2023

BLOB 컨테이너는 포함된 데이터 외에도 시스템 속성 및 사용자 정의 메타데이터를 지원합니다. 이 문서에서는 JavaScript용 Azure Storage 클라이언트 라이브러리를 사용하여 관리 시스템 속성 및 사용자 정의 메타데이터를 관리하는 방법을 보여줍니다.

필수 조건

이 문서의 예제에서는 JavaScript용 Azure Blob Storage 클라이언트 라이브러리로 작업하도록 프로젝트가 이미 설정되어 있다고 가정합니다. 패키지 설치, 모듈 가져오기, 데이터 리소스 작업을 위한 권한 있는 클라이언트 개체 만들기 등 프로젝트를 설정하는 방법에 대한 자세한 내용은 Azure Blob Storage 및 TypeScript 시작을 참조하세요.
권한 부여 메커니즘에는 컨테이너 속성 또는 메타데이터를 사용하는 권한이 있어야 합니다. 자세한 내용은 다음 REST API 작업에 대한 권한 부여 지침을 참조하세요.

속성 및 메타데이터 정보

시스템 속성: 각 Blob Storage 리소스에는 시스템 속성이 있습니다. 그 중 일부를 읽거나 설정할 수 있지만 나머지는 읽기 전용입니다. 일부 시스템 속성은 내부적으로 특정 표준 HTTP 헤더에 해당합니다. JavaScript용 Azure Storage 클라이언트 라이브러리는 이러한 속성을 유지 관리합니다.
사용자 정의 메타데이터: 사용자 정의 메타데이터는 Blob Storage 리소스에 지정하는 하나 이상의 이름-값 쌍으로 구성됩니다. 메타데이터를 사용하여 리소스와 함께 추가 값을 저장할 수 있습니다. 메타데이터 값은 고유한 목적으로만 사용되며 리소스의 동작 방식에 영향을 주지 않습니다.

메타데이터 이름/값 쌍은 유효한 HTTP 헤더이므로 HTTP 헤더와 관련된 모든 제한 사항을 준수해야 합니다. 메타데이터 명명 요구 사항에 대한 자세한 내용은 메타데이터 이름을 참조하세요.

컨테이너 속성 검색

컨테이너 속성을 검색하려면 ContainerClient 개체를 만든 후 다음 방법을 사용합니다.

ContainerClient.getProperties(ContainerProperties 반환)

다음 코드 예제에서는 컨테이너의 속성을 가져오고 속성 값을 콘솔 창에 작성합니다.

async function getContainerProperties(
  containerClient: ContainerClient
): Promise<void> {
  const properties: ContainerGetPropertiesResponse =
    await containerClient.getProperties();

  if (properties.errorCode) throw Error(properties.errorCode);

  console.log(containerClient.containerName + ' properties: ');

  for (const property in properties) {
    switch (property) {
      // nested properties are stringified
      case 'metadata':
        //case 'objectReplicationRules':
        console.log(`    ${property}: ${JSON.stringify(properties[property])}`);
        break;
      default:
        console.log(`    ${property}: ${properties[property]}`);
        break;
    }
  }
}
/* Example output: 
{
    "metadata": {
        "lastfilereview": "3/20/2023",
        "reviewer": "johnh"
    },
    "etag": "\"0x8DB295348CDCD54\"",
    "lastModified": "2023-03-20T14:56:28.000Z",
    "leaseState": "available",
    "leaseStatus": "unlocked",
    "clientRequestId": "0bc8c31a-c607-477e-9846-f2121b10297a",
    "requestId": "1e4ee737-b01e-0042-4e3c-5b2207000000",
    "version": "2021-12-02",
    "date": "2023-03-20T14:56:28.000Z",
    "blobPublicAccess": "container",
    "hasImmutabilityPolicy": false,
    "hasLegalHold": false,
    "defaultEncryptionScope": "$account-encryption-key",
    "denyEncryptionScopeOverride": false,
    "isImmutableStorageWithVersioningEnabled": false
}
*/

메타데이터 설정 및 검색

메타데이터를 하나 이상의 이름-값 쌍 컨테이너 리소스로 지정할 수 있습니다. 메타데이터를 설정하려면 ContainerClient 개체를 만든 후 다음 메서드를 사용합니다.

ContainerClient.setMetadata

다음 코드 예제에서는 컨테이너에서 메타데이터를 설정합니다.

/*
const metadata = {
  // values must be strings
  lastFileReview: currentDate.toString(),
  reviewer: `johnh`
}
*/
async function setContainerMetadata(
  containerClient: ContainerClient,
  metadata: Metadata
) {
  await containerClient.setMetadata(metadata);
}

메타데이터를 검색하려면 컨테이너 속성을 가져온 다음, 반환된 메타데이터 속성을 사용합니다.

ContainerClient.getProperties

리소스

JavaScript용 Azure Blob Storage 클라이언트 라이브러리를 사용하여 컨테이너 속성 및 메타데이터를 설정하고 검색하는 방법에 대해 자세히 알아보려면 다음 리소스를 참조하세요.

REST API 작업

JavaScript용 Azure SDK에는 Azure REST API를 기반으로 빌드되는 라이브러리가 포함되어 있어 친숙한 JavaScript 패러다임을 통해 REST API 작업과 상호 작용할 수 있습니다. 속성 및 메타데이터를 설정하고 검색하기 위한 클라이언트 라이브러리 메서드는 다음 REST API 작업을 사용합니다.

getProperties 메서드는 Blob 속성 가져오기 작업과 Blob 메타데이터 가져오기 작업을 모두 호출하여 컨테이너 속성 및 메타데이터를 검색합니다.

코드 샘플

이 문서의 코드 샘플 보기(GitHub)

다음을 통해 공유