공유 메타데이터 설정(FileREST API) - Azure Files

아티클
08/05/2023

작업은 Set Share Metadata 지정된 공유에 대해 하나 이상의 사용자 정의 이름/값 쌍을 설정합니다. 이 작업은 완전히 지원되지만 레거시 관리 작업입니다. 대신 스토리지 리소스 공급자(Microsoft.Storage)에서 제공하는 파일 공유 - 업데이트 작업을 사용하는 것이 좋습니다. 스토리지 리소스 공급자를 사용하여 프로그래밍 방식으로 리소스와 FileShare 상호 작용하는 방법에 대한 자세한 내용은 FileShare 리소스에 대한 작업을 참조하세요.

프로토콜 가용성

활성화된 파일 공유 프로토콜	사용 가능
SMB
NFS

요청

다음과 같이 요청을 생성 Set Share Metadata 합니다. HTTPS를 사용하는 것이 좋습니다. myaccount를 스토리지 계정의 이름으로 바꿉니다.

메서드	요청 URI	HTTP 버전
`PUT`	`https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata`	HTTP/1.1

다음과 같이 요청 URI에 표시된 경로 구성 요소를 사용자 경로 구성 요소로 바꿉니다.

경로 구성 요소	Description
`myaccount`	사용자 스토리지 계정의 이름입니다.
`myshare`	파일 공유 이름입니다.

경로 명명 제한에 대한 자세한 내용은 공유, 디렉터리, 파일 및 메타데이터 명명 및 참조를 참조하세요.

URI 매개 변수

요청 URI에 다음과 같은 추가 매개 변수를 지정할 수 있습니다.

매개 변수	Description
`timeout`	선택 사항입니다. 초 단위로 표시됩니다. 자세한 내용은 Azure Files 작업에 대한 시간 제한 설정을 참조하세요.

요청 헤더

다음 표에서는 필수 및 선택적 요청 헤더에 대해 설명합니다.

요청 헤더	Description
`Authorization`	필수 요소. 권한 부여 체계, 계정 이름 및 서명을 지정합니다. 자세한 내용은 Azure Storage에 대한 요청 권한 부여를 참조하세요.
`Date` 또는 `x-ms-date`	필수 요소. 요청에 대한 UTC(협정 세계시)를 지정합니다. 자세한 내용은 Azure Storage에 대한 요청 권한 부여를 참조하세요.
`x-ms-version`	모든 권한 있는 요청에 필요합니다. 이 요청에 사용할 작업의 버전을 지정합니다. 자세한 내용은 Azure Storage 서비스에 대한 버전 관리를 참조하세요.
`x-ms-meta-name:value`	선택 사항입니다. 공유에 대한 메타데이터를 포함할 이름/값 쌍을 제공합니다. 이 작업을 호출할 때마다 공유에 연결된 기존의 모든 메타데이터가 바뀝니다. 공유에서 모든 메타데이터를 제거하려면 메타데이터 헤더 없이 이 작업을 호출하세요. 메타데이터 이름은 C# 식별자에 대한 명명 규칙을 준수해야 합니다.
`x-ms-client-request-id`	선택 사항입니다. 로깅이 구성될 때 스토리지 분석 로그에 기록되는 1키비바이트(KiB) 문자 제한을 사용하여 클라이언트에서 생성된 불투명 값을 제공합니다. 이 헤더를 사용하여 클라이언트 쪽 활동과 서버가 수신하는 요청의 상관 관계를 지정하는 것이 좋습니다. 자세한 내용은 Azure Blob Storage 모니터링을 참조하세요.
`x-ms-lease-id:<ID>`	대상 파일 공유에 활성 임대가 있는 경우 필요합니다. 버전 2020-02-10 이상에 사용할 수 있습니다. 요청에 임대 ID가 포함되어 있지 않거나 유효하지 않으면 상태 코드 412(사전 조건 실패)로 인해 작업이 실패합니다. 이 헤더를 지정하고 대상 파일 공유에 현재 활성 임대가 없는 경우 상태 코드 412(사전 조건 실패)로 인해 작업이 실패합니다.

요청 본문

없음

샘플 요청

PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1  
  
Request Headers:  
x-ms-version: 2014-02-14  
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT  
x-ms-meta-Category: Images  
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=

응답

응답에는 HTTP 상태 코드 및 응답 헤더 집합이 포함되어 있습니다.

상태 코드

작업에 성공하면 상태 코드 200(정상)이 반환됩니다.

상태 코드에 대한 자세한 내용은 상태 및 오류 코드를 참조하세요.

응답 헤더

이 작업의 응답에는 다음과 같은 헤더가 포함됩니다. 응답에는 추가 표준 HTTP 헤더도 포함될 수 있습니다. 모든 표준 헤더는 HTTP/1.1 프로토콜 사양을 준수합니다.

응답 헤더	Description
`Last-Modified`	공유가 마지막으로 수정된 날짜와 시간을 반환합니다. 날짜 형식은 RFC 1123을 따릅니다. 자세한 내용은 헤더의 날짜/시간 값 표현을 참조하세요. 공유 또는 해당 속성을 수정하는 모든 작업을 수행하면 마지막 수정 시간이 업데이트됩니다. 파일에 대한 작업은 공유의 마지막 수정 시간에 영향을 주지 않습니다.
`ETag`	공유 버전을 나타내는 값을 따옴표로 포함합니다.
`x-ms-request-id`	만들어진 요청을 고유하게 식별합니다. 이를 사용하여 요청 문제를 해결할 수 있습니다. 자세한 내용은 API 작업 문제 해결을 참조하세요.
`x-ms-version`	요청을 실행하는 데 사용된 Azure Files 버전을 나타냅니다.
`Date` 또는 `x-ms-date`	서비스가 응답을 보낸 시간을 나타내는 UTC 날짜/시간 값입니다.
`x-ms-client-request-id`	요청 및 해당 응답 문제를 해결하는 데 사용할 수 있습니다. 이 헤더의 값은 헤더의 값 `x-ms-client-request-id` 과 같으며, 요청에 있고 값이 최대 1,024자 표시 ASCII 문자인 경우 입니다. 헤더가 `x-ms-client-request-id` 요청에 없는 경우 이 헤더는 응답에 존재하지 않습니다.

응답 본문

없음

권한 부여

계정 소유자만 이 작업을 호출할 수 있습니다.

설명

를 호출 Set Share Metadata 하면 공유와 연결된 모든 기존 메타데이터가 덮어씁니다. 개별 이름/값 쌍을 수정할 수 없습니다.

공유 만들기 작업의 일부로 공유를 만들 때 공유에 대한 메타데이터를 설정할 수도 있습니다.

를 호출하면 Set Share Metadata 공유의 ETag 및 Last-Modified-Time 속성이 업데이트됩니다.

Set Share Metadata는 공유 스냅샷 지원되지 않습니다. 공유 스냅샷 이 작업을 수행하려는 시도는 상태 코드 400(InvalidQueryParameterValue)으로 실패합니다. 공유 스냅샷 만들 때 작업의 일부로 메타데이터를 Snapshot Share 설정할 수 있습니다.

추가 정보

FileShare 리소스에 대한 작업(Azure Files)

다음을 통해 공유