次の方法で共有

共有を一覧表示する

  • [アーティクル]

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 随意。 応答に含める 1 つ以上のデータセットを指定します。

- 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 随意。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を持つクライアント生成の不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。 詳細については、「Monitor Azure Files」を参照してください。

要求本文

何一つ。

応答

応答には、HTTP 状態コード、一連の応答ヘッダー、および XML 形式の応答本文が含まれます。

状態コード

操作が成功すると、状態コード 200 (OK) が返されます。 状態コードの詳細については、「状態コードとエラー コードを参照してください。

応答ヘッダー

この操作の応答には、次のヘッダーが含まれます。 応答には、追加の標準 HTTP ヘッダーも含まれます。 すべての標準ヘッダーは、HTTP/1.1 プロトコル仕様に準拠しています。

応答ヘッダー 形容
Content-Type Standard 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 要素は、共有の層を保持します。 共有の層が変更されていない場合、このプロパティは汎用バージョン 2 (GPv2) ストレージ アカウントで TransactionOptimized 既定の層になります。 Azure Files ストレージ アカウントでは、プロパティが Premiumされます。これは、サポートされている唯一のレベルです。
  • AccessTierChangeTime 要素は、共有にアクセス層を明示的に設定した場合にのみ存在します。
  • AccessTierTransitionState 要素は、共有が 1 つの層から別の層に移行している場合にのみ存在します。 切り替えの対象となる層を示します。
  • ProvisionedIngressMBps 要素は、Premium Azure Files アカウントとバージョン 2019-07-07 以降にのみ存在します。 MiB/秒でプロビジョニングされたイングレスが表示されます。
  • ProvisionedEgressMBps 要素は、Premium Azure Files アカウントとバージョン 2019-07-07 以降にのみ存在します。 プロビジョニングされたエグレスが MiB/秒で表示されます。
  • ProvisionedBandwidthMiBps 要素は、Premium Azure Files アカウントとバージョン 2021-02-12 以降にのみ存在します。 プロビジョニングされた帯域幅 (イングレス + エグレスの組み合わせ) が MiB/秒で表示されます。
  • EnableSnapshotVirtualDirectoryAccess 要素は、有効なプロトコルに NFS が含まれている場合、バージョン 2024-08-04 以降でのみ応答本文に表示されます。 この要素は、スナップショットではなく共有に対してのみ返されます。
  • PaidBurstingEnabled 要素は、バージョン 2024-11-04 以降の Premium Azure Files アカウントにのみ存在します。 この要素は、スナップショットではなく共有に対してのみ返されます。
  • PaidBurstingMaxIops 要素は、バージョン 2024-11-04 以降の Premium Azure Files アカウントにのみ存在します。 これは、共有に対して PaidBurstingEnabled が true の場合にのみ返されます。 この要素は、スナップショットではなく共有に対してのみ返されます。
  • PaidBurstingMaxBandwidthMibps 要素は、バージョン 2024-11-04 以降の Premium Azure Files アカウントにのみ存在します。 これは、共有に対して PaidBurstingEnabled が true の場合にのみ返されます。 この要素は、スナップショットではなく共有に対してのみ返されます。

応答のサンプル

このトピックで後述する「サンプルの要求と応答」セクションを参照してください。

認可

この操作を呼び出すことができるのは、アカウント所有者だけです。

備考

maxresults パラメーターの値を指定し、返す共有の数がこの値を超えているか、maxresultsの既定値を超えている場合、応答本文には NextMarker 要素が含まれます。 この要素は、後続の要求で返される次の共有を示します。 次の項目セットを返すには、後続の要求の URI のマーカー パラメーターとして NextMarker の値を指定します。

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 の