共有メタデータの設定

  • [アーティクル]

操作は Set Share Metadata 、指定された共有に対して 1 つ以上のユーザー定義の名前と値のペアを設定します。 この操作は完全にサポートされていますが、レガシ管理操作です。 代わりに、ストレージ リソース プロバイダー (Microsoft.Storage) によって提供される ファイル共有 - 更新 操作を使用することをお勧めします。 ストレージ リソース プロバイダーを使用してプログラムでリソースを FileShare 操作する方法の詳細については、「 FileShare リソースに対する操作」を参照してください。

プロトコルの可用性

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

要求

次のように要求を Set Share Metadata 作成します。 HTTPS をお勧めします。 myaccount をストレージ アカウントの名前に置き換えます。

Method 要求 URI HTTP バージョン
PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1

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

パス コンポーネント 説明
myaccount ご利用のストレージ アカウントの名前。
myshare ファイル共有の名前。

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

URI パラメーター

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

パラメーター 説明
timeout 省略可能。 秒単位で表されます。 詳細については、「Azure Files操作のタイムアウトを設定する」を参照してください。

要求ヘッダー

次の表では、必須および省略可能な要求ヘッダーについて説明します。

要求ヘッダー 説明
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 省略可能。 ログ記録の構成時にStorage Analytics ログに記録される 1 kibibyte (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=

Response

応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。

状態コード

操作に成功すると、状態コード 200 (OK) が返されます。

状態コードの詳細については、「 状態とエラー コード」を参照してください。

応答ヘッダー

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

応答ヘッダー 説明
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)