공유 나열

아티클
08/07/2024

List Shares 작업은 지정된 계정의 공유 및 공유 스냅샷 목록을 반환합니다. 이 API는 완전히 지원되지만 레거시 관리 API입니다. 대신 스토리지 리소스 공급자(Microsoft.Storage)에서 제공하는 파일 공유 -나열합니다. 스토리지 리소스 공급자를 사용하여 리소스와 프로그래밍 방식으로 상호 작용하는 방법에 대한 자세한 내용은 FileShares작업을 참조하세요.

프로토콜 가용성

파일 공유 프로토콜 사용	이용할 수 있는
SMB
NFS

요청

다음과 같이 List Shares 요청을 생성할 수 있습니다. HTTPS를 사용하는 것이 좋습니다.

메서드	요청 URI	HTTP 버전
`GET`	`https://myaccount.file.core.windows.net/?comp=list`	HTTP/1.1

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

경로 구성 요소	묘사
`myaccount`	스토리지 계정의 이름입니다.

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

URI 매개 변수

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

매개 변수	묘사
`prefix`	선택적. 지정된 접두사로 시작하는 이름이 있는 공유만 반환하도록 결과를 필터링합니다.
`marker`	선택적. 다음 목록 작업과 함께 반환될 목록의 부분을 식별하는 문자열 값입니다. 반환된 목록이 완료되지 않은 경우 작업은 응답 본문 내에서 표식 값을 반환합니다. 그런 다음 후속 호출에서 표식 값을 사용하여 다음 목록 항목 집합을 요청할 수 있습니다. 표식 값은 클라이언트에 불투명합니다.
`maxresults`	선택적. 반환할 최대 공유 수를 지정합니다. 요청이 `maxresults`지정하지 않거나 5,000보다 큰 값을 지정하는 경우 서버는 최대 5,000개의 항목을 반환합니다. 매개 변수가 0보다 작거나 같은 값으로 설정된 경우 서버는 상태 코드 400(잘못된 요청)을 반환합니다.
`include=metadata,snapshots,deleted`	선택적. 응답에 포함할 하나 이상의 데이터 세트를 지정합니다. - `snapshots`: 버전 2017-04-17 이상. 공유 스냅샷을 응답에 포함되도록 지정합니다. 공유 스냅샷은 응답에서 가장 오래된 스냅샷에서 최신 항목으로 나열됩니다. - `metadata`: 공유 메타데이터가 응답에 반환되도록 지정합니다. - `deleted`: 삭제된 파일 공유를 응답에 포함되도록 지정합니다. URI에서 이러한 옵션 중 하나 이상을 지정하려면 각 옵션을 URL로 인코딩된 쉼표("%82")로 구분해야 합니다. 모든 메타데이터 이름은C# 식별자에 대한 명명 규칙을 준수해야 합니다.
`timeout`	선택적. `timeout` 매개 변수는 초 단위로 표현됩니다. 자세한 내용은 Azure Files 작업대한 시간 제한 설정을 참조하세요.

요청 헤더

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

요청 헤더	묘사
`Authorization`	필수. 권한 부여 체계, 계정 이름 및 서명을 지정합니다. 자세한 내용은 Azure Storage대한 요청 권한 부여를 참조하세요.
`Date` 또는 `x-ms-date`	필수. 요청에 대한 UTC(협정 세계시)를 지정합니다. 자세한 내용은 Azure Storage대한 요청 권한 부여를 참조하세요.
`x-ms-version`	모든 권한 있는 요청에 필요합니다. 이 요청에 사용할 작업의 버전을 지정합니다. 자세한 내용은 Azure Storage 서비스대한 버전 관리를 참조하세요.
`x-ms-client-request-id`	선택적. 로깅이 구성될 때 로그에 기록되는 1kibibyte(KiB) 문자 제한으로 클라이언트에서 생성된 불투명 값을 제공합니다. 이 헤더를 사용하여 클라이언트 쪽 활동과 서버가 수신하는 요청의 상관 관계를 지정하는 것이 좋습니다. 자세한 내용은 Azure Files모니터링을 참조하세요.

요청 본문

없음.

응답

응답에는 HTTP 상태 코드, 응답 헤더 집합 및 XML 형식의 응답 본문이 포함됩니다.

상태 코드

작업이 성공하면 상태 코드 200(확인)이 반환됩니다. 상태 코드에 대한 자세한 내용은 상태 및 오류 코드참조하세요.

응답 헤더

이 작업에 대한 응답에는 다음 헤더가 포함됩니다. 응답에는 추가 표준 HTTP 헤더도 포함됩니다. 모든 표준 헤더는 HTTP/1.1 프로토콜 사양준수합니다.

응답 헤더	묘사
`Content-Type`	표준 HTTP/1.1 헤더. 결과가 반환되는 형식을 지정합니다. 현재 이 값은 `application/xml`.
`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` 헤더의 값과 같습니다. 값은 최대 1024개 표시 ASCII 문자입니다. 요청에 `x-ms-client-request-id` 헤더가 없으면 이 헤더가 응답에 표시되지 않습니다.

응답 본문

응답 본문의 형식은 다음과 같습니다.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults AccountName="https://myaccount.file.core.windows.net">  
  <Prefix>string-value</Prefix>  
  <Marker>string-value</Marker>  
  <MaxResults>int-value</MaxResults>  
  <Shares>  
    <Share>  
      <Name>share-name</Name>  
      <Snapshot>Date-Time Value</Snapshot>
      <Version>01D2AC0C18EDFE36</Version> 
      <Deleted>true</Deleted>  
      <Properties>  
        <Last-Modified>date/time-value</Last-Modified>  
        <Etag>etag</Etag>  
        <Quota>max-share-size</Quota>
        <DeletedTime>Mon, 24 Aug 2020 04:56:10 GMT</DeletedTime>  
        <RemainingRetentionDays>360</RemainingRetentionDays>
        <AccessTier>TransactionOptimized</AccessTier>
        <AccessTierChangeTime>Mon, 24 Aug 2020 03:56:10 GMT</AccessTierChangeTime>
        <AccessTierTransitionState>pending-from-cool</AccessTierTransitionState>
        <EnabledProtocols>SMB</EnabledProtocols>
        <PaidBurstingEnabled>true</PaidBurstingEnabled>
        <PaidBurstingMaxIops>20000</PaidBurstingMaxIops>
        <PaidBurstingMaxBandwidthMibps>4000</PaidBurstingMaxBandwidthMibps>
      </Properties>  
      <Metadata>  
        <metadata-name>value</metadata-name>  
      </Metadata>  
    </Share>  
  </Shares>  
  <NextMarker>marker-value</NextMarker>  
</EnumerationResults>

EnabledProtocols 요소는 2020-02-10 버전 이상에서만 응답 본문에 나타납니다.
RootSquash 요소는 활성화된 프로토콜에 NFS가 포함된 경우 버전 2020-02-10 이상에서만 응답 본문에 표시됩니다. 이 요소는 스냅샷이 아닌 공유에 대해서만 반환됩니다.
Quota 요소는 2015-02-21 버전 이상에서만 응답 본문에 나타납니다.
Version, Deleted, DeletedTime및 RemainingRetentionDays 요소는 2019-12-12 버전 이상에서만 응답 본문에 표시됩니다.
Prefix, Marker및 MaxResults 요소는 URI에 지정하는 경우에만 존재합니다. NextMarker 요소에는 목록 결과가 완료되지 않은 경우에만 값이 있습니다.
Metadata 요소는 URI에 include=metadata 매개 변수를 지정하는 경우에만 존재합니다. Metadata 요소 내에서 각 이름-값 쌍의 값은 쌍의 이름에 해당하는 요소 내에 나열됩니다.
스냅샷은 요청 URI에 include 매개 변수를 사용하여include=snapshots 매개 변수를 지정하는 경우에만 응답에 포함됩니다.
AccessTier 요소는 공유 계층을 보유합니다. 공유 계층이 변경되지 않은 경우 이 속성은 GPv2(범용 버전 2) 스토리지 계정에서 TransactionOptimized 기본 계층이 됩니다. Azure Files 스토리지 계정에서 속성은 지원되는 유일한 계층인 Premium됩니다.
AccessTierChangeTime 요소는 공유에서 액세스 계층을 명시적으로 설정한 경우에만 존재합니다.
AccessTierTransitionState 요소는 공유가 한 계층에서 다른 계층으로 전환되는 경우에만 존재합니다. 전환 중인 계층을 나타냅니다.
ProvisionedIngressMBps 요소는 Premium Azure Files 계정 및 버전 2019-07-07 이상에만 존재합니다. MiB/s에서 프로비전된 수신을 표시합니다.
ProvisionedEgressMBps 요소는 Premium Azure Files 계정 및 버전 2019-07-07 이상에만 존재합니다. MiB/s에서 프로비전된 송신을 표시합니다.
ProvisionedBandwidthMiBps 요소는 Premium Azure Files 계정 및 버전 2021-02-12 이상에만 존재합니다. MiB/s에서 프로비전된 대역폭(수신 + 송신 결합)을 보여 줍니다.
EnableSnapshotVirtualDirectoryAccess 요소는 활성화된 프로토콜에 NFS가 포함된 경우 버전 2024-08-04 이상에서만 응답 본문에 표시됩니다. 이 요소는 스냅샷이 아닌 공유에 대해서만 반환됩니다.
PaidBurstingEnabled 요소는 버전 2024-11-04 이상에서 Premium Azure Files 계정에만 존재합니다. 이 요소는 스냅샷이 아닌 공유에 대해서만 반환됩니다.
PaidBurstingMaxIops 요소는 버전 2024-11-04 이상에서 Premium Azure Files 계정에만 존재합니다. PayBurstingEnabled가 공유에 대해 true인 경우에만 반환됩니다. 이 요소는 스냅샷이 아닌 공유에 대해서만 반환됩니다.
PaidBurstingMaxBandwidthMibps 요소는 버전 2024-11-04 이상에서 Premium Azure Files 계정에만 존재합니다. PayBurstingEnabled가 공유에 대해 true인 경우에만 반환됩니다. 이 요소는 스냅샷이 아닌 공유에 대해서만 반환됩니다.

샘플 응답

이 항목의 뒷부분에 있는 샘플 요청 및 응답 섹션을 참조하세요.

권한 부여

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

발언

maxresults 매개 변수의 값을 지정하고 반환할 공유 수가 이 값을 초과하거나 maxresults기본값을 초과하면 응답 본문에 NextMarker 요소가 포함됩니다. 이 요소는 후속 요청에서 반환할 다음 공유를 나타냅니다. 다음 항목 집합을 반환하려면 NextMarker 값을 후속 요청에 대한 URI의 표식 매개 변수로 지정합니다.

NextMarker 값은 불투명한 것으로 처리되어야 합니다.

공유는 응답 본문에 사전순으로 나열됩니다.

List Shares 작업은 30초 후에 시간이 초과됩니다.

샘플 요청 및 응답

다음 샘플 URI는 계정에 대한 공유 목록을 요청합니다. 초기 작업에 대해 반환할 최대 결과를 3으로 설정합니다.

GET https://myaccount.file.core.windows.net/?comp=list&maxresults=3&include=snapshots HTTP/1.1

요청은 다음 헤더와 함께 전송됩니다.

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey myaccount:CY1OP3O3jGFpYFbTCBimLn0Xov0vt0khH/D5Gy0fXvg=

상태 코드 및 응답 헤더는 다음과 같이 반환됩니다.

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: <date>  
x-ms-version: 2020-02-10  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

이 요청에 대한 응답 XML은 다음과 같습니다. NextMarker 요소는 공유 집합을 따르고 반환할 다음 공유의 이름을 포함합니다.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint=" https://myaccount.file.core.windows.net">  
  <MaxResults>3</MaxResults>  
  <Shares>  
    <Share>  
      <Name>audio</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C6B1B2</Etag>  
        <Quota>55</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>  
      <Name>images</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C1EEEC</Etag>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>
      <Name>textfiles</Name>
      <Snapshot>2017-05-12T20:52:22.0000000Z</Snapshot>
      <Properties>
        <Last-Modified><date></Last-Modified>
        <Etag>0x8D3F2E1A9D14700</Etag>
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
      </Properties>
    </Share>
    <Share>  
      <Name>textfiles</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7BACAC3</Etag>  
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
        <RootSquash>AllSquash</RootSquash>  
      </Properties>  
    </Share>
  </Shares>  
  <NextMarker>video</NextMarker>  
</EnumerationResults>

후속 목록 작업은 다음과 같이 요청 URI의 표식을 지정합니다. 표식으로 지정된 공유부터 시작하여 다음 결과 집합이 반환됩니다.

https://myaccount.file.core.windows.net/?comp=list&maxresults=3&marker=video

참고 항목

Azure Files REST API

다음을 통해 공유