共有のリスト

[アーティクル]
07/19/2023

操作は List Shares 、指定されたアカウントの共有と共有スナップショットの一覧を返します。この API は完全にサポートされていますが、レガシ管理 API です。代わりに、ストレージリソースプロバイダー (Microsoft.Storage) によって提供されるファイル共有 - リストを使用します。ストレージリソースプロバイダーを使用してプログラムでリソースを FileShare 操作する方法の詳細については、「 FileShares に対する操作」を参照してください。

プロトコルの可用性

有効なファイル共有プロトコル	利用可能
SMB
NFS

要求

要求は List Shares 次のように構築できます。 HTTPS が推奨されます。

Method	要求 URI	HTTP バージョン
`GET`	`https://myaccount.file.core.windows.net/?comp=list`	HTTP/1.1

次のように、要求 URI に示されたパスコンポーネントを独自の URI に置き換えます。

パスコンポーネント	Description
`myaccount`	ご利用のストレージアカウントの名前。

パスの名前付けの制限の詳細については、「共有、ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。

URI パラメーター

要求 URI には、次の追加パラメーターを指定できます。

パラメーター	説明
`prefix`	省略可能。結果をフィルター処理して、指定したプレフィックスで始まる名前を持つ共有のみを返します。
`marker`	省略可能。次の一覧操作で返される一覧の部分を識別する文字列値です。返されたリストが完了していない場合、操作は応答本文内のマーカー値を返します。その後、後続の呼び出しでマーカー値を使用して、リストアイテムの次のセットを要求できます。マーカー値はクライアントに対して非透過的です。
`maxresults`	省略可能。返される共有の最大数を指定します。要求でを指定 `maxresults`しない場合、または 5,000 を超える値を指定すると、サーバーは最大 5,000 個のアイテムを返します。パラメーターが 0 以下の値に設定されている場合、サーバーはステータスコード 400 (Bad Request) を返します。
`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) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。詳細については、「Azure Filesの監視」を参照してください。

要求本文

なし。

[応答]

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

状態コード

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

応答ヘッダー

この操作の応答には、次のヘッダーが含まれています。応答には、追加の標準 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>
      </Properties>  
      <Metadata>  
        <metadata-name>value</metadata-name>  
      </Metadata>  
    </Share>  
  </Shares>  
  <NextMarker>marker-value</NextMarker>  
</EnumerationResults>

要素は EnabledProtocols 、バージョン 2020-02-10 以降でのみ応答本文に表示されます。
有効なプロトコルに NFS が含まれている場合、要素は RootSquash バージョン 2020-02-10 以降でのみ応答本文に表示されます。
要素は Quota 、バージョン 2015-02-21 以降でのみ応答本文に表示されます。
、Deleted、DeletedTime、および RemainingRetentionDays 要素はVersion、バージョン 2019-12-12 以降でのみ応答本文に表示されます。
、PrefixMarker、および MaxResults 要素は、URI で指定した場合にのみ存在します。要素には NextMarker 、リストの結果が完了していない場合にのみ値があります。
要素は Metadata 、URI でパラメーターを指定した include=metadata 場合にのみ存在します。 Metadata 要素内では、名前と値の各ペアの値が、ペアの名前に対応する要素内に一覧表示されます。
スナップショットは、要求 URI にパラメーターを指定includeしたinclude=snapshots場合にのみ、応答に含まれます。
要素は AccessTier 共有の層を保持します。共有の層が変更されていない場合、このプロパティは汎用バージョン 2 (GPv2) ストレージアカウントの既定の層 TransactionOptimized になります。 Azure Filesストレージアカウントでは、プロパティはになりますPremium。これは、サポートされている唯一の層です。
要素は AccessTierChangeTime 、共有にアクセス層を明示的に設定した場合にのみ存在します。
要素は AccessTierTransitionState 、共有が 1 つの層から別の層に移行している場合にのみ存在します。これは、移行元の層を示します。
要素はProvisionedIngressMBps、Azure Files アカウントとバージョン 2019-07-07 以降にのみPremium存在します。 MiB/s でプロビジョニングされたイングレスが表示されます。
要素はProvisionedEgressMBps、Azure Files アカウントとバージョン 2019-07-07 以降にのみPremium存在します。 MiB/s でプロビジョニングされたエグレスが表示されます。
要素はProvisionedBandwidthMiBps、Azure Files アカウントとバージョン 2021-02-12 以降にのみPremium存在します。プロビジョニングされた帯域幅 (イングレス + エグレスの組み合わせ) が MiB/秒で示されています。

応答のサンプル

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

承認

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

注釈

パラメーターに値を 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>
        <RootSquash>RootSquash</RootSquash>
      </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