スナップショット共有 (FileREST API) - Azure Files

[アーティクル]
01/26/2024

バージョン 2017-04-17 以降では、操作によってSnapshot Share共有の読み取り専用スナップショットが作成されます。

プロトコルの可用性

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

要求

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

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

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

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

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

URI パラメーター

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

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

要求ヘッダー

必須要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。

要求ヘッダー	説明
`Authorization`	必須。承認スキーム、アカウント名、署名を指定します。詳細については、「Azure Storage への要求を承認する」をご覧ください。
`Date` または `x-ms-date`	必須。要求の世界協定時刻 (UTC) を指定します。詳細については、「Azure Storage への要求を承認する」をご覧ください。
`x-ms-version`	すべての承認された要求に必要です。この要求に使用する操作のバージョンを指定します。詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
`x-ms-meta-name:value`	省略可能。共有スナップショットに関連付けられたユーザー定義の名前と値のペアを指定します。名前と値のペアを指定しない場合、操作によって基本共有メタデータがスナップショットにコピーされます。 1 つ以上の名前と値のペアを指定すると、指定したメタデータを使用して共有スナップショットが作成されます。この場合、メタデータは基本共有からコピーされません。メタデータ名は、C# 識別子の名前付け規則に従う必要があります。
`x-ms-client-request-id`	省略可能。ログ記録の構成時にログに記録される 1 Kibibyte (KiB) 文字制限を持つ、クライアントによって生成された不透明な値を提供します。このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。詳細については、「Azure Blob Storageの監視」を参照してください。

要求本文

[なし] :

要求のサンプル

Request Syntax:  
PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=snapshot HTTP/1.1

Request Headers:
x-ms-version: 2017-04-17
x-ms-date: Mon, 10 May 2017 22:50:32 GMT
x-ms-meta-Name: StorageSample
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=

Response

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

status code

操作が正常に終了すると、状態コード 201 (Created) が返されます。状態コードの詳細については、「状態とエラーコード」を参照してください。

応答ヘッダー

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

応答ヘッダー	説明
`ETag`	共有スナップショットのバージョンを引用符で囲んで表す値を格納します。共有スナップショットは変更できないため、特定の共有のは`ETag`変更されませんスナップショット。ただし、要求に新しいメタデータを`Snapshot Share`指定した場合、`ETag`共有のスナップショットは基本共有とは異なります。要求でメタデータを指定しなかった場合、`ETag`共有スナップショットのは、共有スナップショットが取得された時点の基本共有のと同じです。
`Last-Modified`	共有が最後に更新された日時を返します。詳細については、「ヘッダーでの日時値の表現」を参照してください。共有スナップショットは変更できないため、特定の共有の最終変更時刻スナップショット変更されることはありません。ただし、要求に新しいメタデータを`Snapshot Share`指定した場合、共有の最終変更時刻スナップショット基本共有とは異なります。要求でメタデータを指定しなかった場合、共有スナップショットの最終変更時刻は、共有スナップショットが取得された時点の基本共有と同じです。
`x-ms-request-id`	行われた要求を一意に識別し、要求のトラブルシューティングに使用できます。詳細については、「 API 操作のトラブルシューティング」を参照してください。
`x-ms-version`	要求の実行に使用Azure Filesのバージョンを示します。
`Date` または `x-ms-date`	応答が開始された時刻を示す UTC 日付/時刻値。サービスによってこの値が生成されます。
`x-ms-snapshot`	`DateTime`共有スナップショットを一意に識別する値。後続の要求でこのヘッダーの値を使用して、共有スナップショットにアクセスできます。この値は不透明です。
`x-ms-client-request-id`	要求と対応する応答のトラブルシューティングに使用できます。このヘッダーの値は、要求に存在する `x-ms-client-request-id` 場合は、ヘッダーの値と同じです。この値は、最大 1,024 文字の可視 ASCII 文字です。ヘッダーが `x-ms-client-request-id` 要求に存在しない場合、応答には存在しません。

応答本文

[なし] :

応答のサンプル

Response Status:
HTTP/1.1 201 Created

Response Headers:
Content-Length: 0
Date: Mon, 10 May 2017 23:00:12 GMT
ETag: "0x8CB14C3E29B7E82"
Last-Modified: Mon, 10 May 2017 23:00:06 GMT
x-ms-version: 2017-04-17
x-ms-snapshot: 2017-05-10T17:52:33.9551861Z
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

承認

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

注釈

共有スナップショットは、共有の読み取り専用バージョンを提供します。共有スナップショットを作成した後は、変更できません。共有スナップショットは、共有上のすべてのファイルの一貫性のあるバックアップを作成するための便利な方法を提供します。

操作をSnapshot Share呼び出すたびに、新しい共有スナップショットが作成され、その基本共有に対する相対的な共有スナップショットを識別する一意DateTimeの値が使用されます。このDateTime値を使用すると、共有スナップショットとその内容に対してさらに操作を実行できます。この DateTime 値は不透明として扱う必要があります。

値はDateTime、要求 URI の共有スナップショットを識別します。たとえば、基本共有とそのスナップショット上のファイルには、次の例のような URI があります。

共有上のファイル: http://myaccount.file.core.windows.net/myshare/myfile
共有スナップショット上のファイル:http://myaccount.file.core.windows.net/myshare/myfile?sharesnapshot=<DateTime>

共有では、200 個の共有スナップショットの作成をサポートできます。 200 を超える共有スナップショットを作成しようとすると、サービスはエラーコード 409 (競合) を返します。前Snapshot Shareの操作の進行中に共有スナップショットを作成しようとすると、サービスはエラーコード 409 (競合) も返します。

既存の共有スナップショットは上書きされません。明示的に削除する必要があります。共有スナップショットを明示的に削除するには、Delete Share を呼び出し、ヘッダーとクエリパラメーターをsharesnapshot適切な値に設定x-ms-include-snapshotsします。

スナップショット共有 (Snapshot Share)