共有の作成 (FileREST API) - Azure Files

[アーティクル]
08/07/2024

Create Share 操作では、指定したアカウントの下に新しい Azure Files 共有が作成されます。この API は完全にサポートされていますが、これはレガシ管理 API です。代わりに、azure Storage リソースプロバイダー (Microsoft.Storage) によって提供されるファイル共有 -の作成を使用することをお勧めします。 Azure Storage リソースプロバイダーを使用してリソースをプログラムで操作する方法の詳細については、「FileSharesに対する操作」を参照してください。

同じ名前の共有が既に存在する場合、操作は失敗します。共有リソースには、その共有のメタデータとプロパティが含まれます。共有に含まれるファイルの一覧は含まれません。

プロトコルの可用性

有効なファイル共有プロトコル	利用できる
サーバーメッセージブロック (SMB)
ネットワークファイルシステム (NFS)

依頼

次に示すように、Create Share 要求を作成できます。 HTTPS を使用することをお勧めします。

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

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

パスコンポーネント	形容
`myaccount`	ストレージアカウントの名前。
`myshare`	ファイル共有の名前。名前には小文字のみを使用できます。

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

URI パラメーター

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

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

要求ヘッダー

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

要求ヘッダー	形容
`Authorization`	必須。承認スキーム、アカウント名、署名を指定します。詳細については、「Azure Storageへの要求を承認する」を参照してください。
`Date` または `x-ms-date`	必須。要求の協定世界時 (UTC) 時刻を指定します。詳細については、「Azure Storageへの要求を承認する」を参照してください。
`x-ms-version`	すべての承認された要求に必要です。この要求に使用する操作のバージョンを指定します。詳細については、「Azure Storage サービスのバージョン管理のを参照してください。
`x-ms-meta-name:value`	随意。共有にメタデータとして関連付ける名前と値のペア。メタデータ名は、C# 識別子の名前付け規則に従う必要があります。
`x-ms-share-quota`	随意。バージョン 2015-02-21 以降でサポートされています。共有の最大サイズをギビバイト (GiB) 単位で指定します。
`x-ms-access-tier`	随意。バージョン 2019-12-12 以降でサポートされています。共有のアクセス層を指定します。有効な値は、`TransactionOptimized`、`Hot`、および `Cool`です。ファイル共有層の詳細については、「Azure Files ストレージ層の」を参照してください。
`x-ms-enabled-protocols: <SMB \\| NFS>`	随意。バージョン 2019-07-07 以降でサポートされています。共有で有効なプロトコルを指定します。指定されていない場合、既定値は SMB です。 - `SMB`: 共有には SMBv3.0、SMBv2.1、REST でアクセスできます。 - `NFS`: 共有には NFSv4.1 からアクセスできます。このオプションには Premium アカウントが必要です。
`x-ms-root-squash: <NoRootSquash \\| RootSquash \\| AllSquash>`	随意。 NFS のみ。バージョン 2019-07-07 以降でサポートされています。 NFS が有効な場合の共有のルートスカッシュ動作を指定します。指定しない場合、既定値は NoRootSquash です。 - `NoRootSquash`: ルートスカッシュをオフにします。 - `RootSquash`: uid/gid 0 からの要求を匿名 uid/gid にマップします。 - `AllSquash`: すべての uid と gid を匿名ユーザーにマップします。
`x-ms-enable-snapshot-virtual-directory-access: <true \\| false>`	随意。バージョン 2024-08-04 以降でサポートされています。 NFS が有効になっているときに、共有マウントポイントのルートでスナップショット仮想ディレクトリにアクセスできるかどうかを指定します。指定しない場合、既定値は true です。
`x-ms-client-request-id`	随意。ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を持つクライアント生成の不透明な値を提供します。このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。詳細については、「Monitor Azure Files」を参照してください。
`x-ms-share-paid-bursting-enabled: <true \\| false>`	随意。バージョン 2024-11-04 以降でサポートされています。 Premium ファイル共有 (FileStorage ストレージアカウントの種類内のファイル共有) に対してのみ許可されます。このプロパティを使用すると、有料バーストが有効になります。プロパティが指定されていない場合、既定値は false です。
`x-ms-share-paid-bursting-max-iops`	随意。バージョン 2024-11-04 以降でサポートされています。 Premium ファイル共有に対してのみ許可されます。共有に対して許可される 1 秒あたりの最大有料バースト入出力操作 (IOPS) を表す整数。指定しない場合の既定値は、共有で許可される最大 IOPS です。このヘッダーが設定されている場合は、`x-ms-share-paid-bursting-enabled` も true に設定する必要があります。
`x-ms-share-paid-bursting-max-bandwidth-mibps`	随意。バージョン 2024-11-04 以降でサポートされています。 Premium ファイル共有に対してのみ許可されます。共有で許可される 1 秒あたりの最大有料バーストメビバイト数 (MiB/秒) を表す整数。指定しない場合の既定値は、共有で許可される最大 MiB/秒です。このヘッダーが設定されている場合は、`x-ms-share-paid-bursting-enabled` も true に設定する必要があります。

要求本文

何一つ。

要求のサンプル

PUT https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1  
  
Request Headers:  
x-ms-version: 2020-02-10  
x-ms-date: <date>  
x-ms-meta-Name: StorageSample  
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=

応答

応答には、HTTP 状態コードと一連の応答ヘッダーが含まれます。

状態コード

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

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

応答ヘッダー

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

応答ヘッダー	形容
`ETag`	共有のバージョンを表す値を引用符で囲んで格納します。
`Last-Modified`	共有が最後に変更された日時を返します。日付形式は RFC 1123 に従います。詳細については、「ヘッダーの日付/時刻値を表す」を参照してください。共有またはそのプロパティまたはメタデータを変更する操作は、最後に変更された時刻を更新します。ファイルに対する操作は、共有の最終変更時刻には影響しません。
`x-ms-request-id`	要求を一意に識別し、それを使用して要求のトラブルシューティングを行うことができます。詳細については、「API 操作のトラブルシューティング」を参照してください。
`x-ms-version`	要求の実行に使用された Azure Files のバージョンを示します。
`Date`	サービスによって生成される UTC 日付/時刻値。応答が開始された時刻を示します。
`x-ms-client-request-id`	要求と対応する応答のトラブルシューティングに使用できます。このヘッダーの値は、要求に存在し、1,024 文字以下の ASCII 文字が含まれている場合、`x-ms-client-request-id` ヘッダーの値と同じです。 `x-ms-client-request-id` ヘッダーが要求に存在しない場合、応答には存在しません。

応答本文

何一つ。

応答のサンプル

Response Status:  
HTTP/1.1 201 Created  
  
Response Headers:  
Transfer-Encoding: chunked  
Date: <date>  
ETag: "0x8CB14C3E29B7E82"  
Last-Modified: <date>  
x-ms-version: 2020-02-10  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

認可

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

備考

共有は、ストレージアカウント内にすぐに作成されます。 1 つの共有を別の共有内に入れ子にすることはできません。

要求に 1 つ以上のメタデータヘッダーを含めることで、共有の作成時にメタデータを指定できます。メタデータヘッダーの形式は x-ms-meta-name:value。

Create Shareを呼び出すときに同じ名前の共有が削除されている場合、サーバーは状態コード 409 (競合) を返し、追加のエラー情報は共有が削除されていることを示します。

共有サイズクォータを使用して、共有に格納されるファイルのサイズを制限できます。クォータによってスナップショットのサイズが制限されることはありません。ファイルに関連し、ストレージアカウントの課金サイズの計算に使用されるオーバーヘッドは、クォータでは考慮されません。

共有上のファイルのサイズの合計が共有に設定されているクォータを超えると、ファイルのサイズを増やそうとすると失敗し、空でない新しいファイル (REST 経由) の作成は失敗します。空のファイルは引き続き作成できます。

クォータを変更または設定しても、課金には影響しません。ファイルのサイズとオーバーヘッドに対する課金は引き続き行われます。

次の方法で共有