Set File Metadata

この操作では Set File Metadata 、指定したファイルのユーザー定義メタデータが設定されます。

プロトコルの可用性

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

Request

Set File Metadata 要求の構成は次のとおりです。 HTTPS が推奨されます。

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

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

パス コンポーネント 説明
myaccount ご利用のストレージ アカウントの名前。
myshare ファイル共有の名前。
mydirectorypath 省略可能。 親ディレクトリへのパス。
myfile ファイルの名前です。

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

URI パラメーター

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

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

要求ヘッダー

要求ヘッダー 説明
Authorization 必須。 承認スキーム、アカウント名、および署名を指定します。 詳細については、「Azure Storage要求を承認する」を参照してください。
Date または x-ms-date 必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage要求を承認する」を参照してください。
x-ms-version 承認されたすべての要求に必要です。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
x-ms-meta-name:value 省略可能。 ファイルの名前と値のペアを設定します。

この操作を呼び出すと、その都度、ファイルに関連付けられている既存のメタデータがすべて置き換えられます。 すべてのメタデータをファイルから削除するには、この操作をメタデータ ヘッダーなしで呼び出します。

メタデータ名は 、C# 識別子の名前付け規則に従う必要があります。
x-ms-lease-id:<ID> ファイルにアクティブなリースがある場合は必須です。 バージョン 2019-02-02 以降で使用できます。
x-ms-client-request-id 省略可能。 ストレージ分析ログが有効になっているときに分析ログに記録される 1 KiB 文字制限を持つ、クライアントによって生成された不透明な値を提供します。 クライアント側のアクティビティをサーバーが受信した要求と関連付けるには、このヘッダーを使用することが強く推奨されます。 詳細については、「 Azure Blob Storage の監視」を参照してください。

要求本文

[なし] :

応答

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

status code

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

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

応答ヘッダー

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

応答ヘッダー 説明
ETag ETag には、ファイルのバージョンを表す値が引用符で囲まれて含まれます。
x-ms-request-id このヘッダーは要求を一意に識別するので、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください
x-ms-version 要求の実行に使用するファイル サービスのバージョンを示します。
Date または x-ms-date サービスによって生成される、応答の開始時刻を示す UTC 日付/時刻値。
x-ms-request-server-encrypted: true/false バージョン 2017-04-17 以降。 このヘッダーの値は、指定したアルゴリズムを true 使用して要求の内容が正常に暗号化された場合に設定されます false 。それ以外の場合は、このヘッダーの値が設定されます。
x-ms-client-request-id このヘッダーは、要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、その値 x-ms-client-request-id が最大 1024 文字の ASCII 文字で表示される場合、ヘッダーの値と同じです。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、このヘッダーは応答に存在しません。

応答本文

[なし] :

承認

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

解説

Set File Metadata は共有スナップショットではサポートされていません。これは共有の読み取り専用コピーです。 共有スナップショットに対してこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します

ファイルにアクティブなリースがある場合、クライアントはメタデータをファイルに書き込むために、要求で有効なリース ID を指定する必要があります。 クライアントがリース ID を指定しない場合、または無効なリース ID を指定した場合、ファイル サービスは状態コード 412 (前提条件に失敗しました) を返します。 クライアントがリース ID を指定しても、ファイルにアクティブなリースがない場合、ファイル サービスは状態コード 412 (前提条件に失敗) も返します。

関連項目

ファイルの操作