共有プロパティの設定
Set Share Properties 操作は、指定された Azure ファイル共有のプロパティを設定します。 この操作は完全にサポートされていますが、レガシ管理操作です。 代わりに、ストレージ リソース プロバイダー (Microsoft.Storage) によって提供される ファイル共有 - 更新 操作を使用することをお勧めします。 ストレージ リソース プロバイダーを使用して FileShare リソースをプログラムで操作する方法の詳細については、「FileShare リソースに対する操作」を参照してください。
プロトコルの可用性
| 有効なファイル共有プロトコル | 利用できる |
|---|---|
| SMB |
|
| NFS |
|
依頼
Set Share Properties 要求は次のように構築できます。 HTTPS をお勧めします。 myaccount
| 方式 | 要求 URI | HTTP バージョン |
|---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=properties |
HTTP/1.1 |
次のように、要求 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-share-quota |
随意。 バージョン 2015-02-21 以降でサポートされています。 共有の最大サイズをギビバイト (GiB) 単位で指定します。 |
x-ms-access-tier |
随意。 バージョン 2019-12-12 以降でサポートされています。 共有のアクセス層を指定します。 有効な値は、TransactionOptimized、Hot、および Coolです。 ファイル共有の階層化の詳細については、「Azure Files ストレージ層の」を参照してください。 |
x-ms-root-squash: <NoRootSquash \| RootSquash \| AllSquash> |
随意。 バージョン 2020-02-10 以降でサポートされています。 NFS が有効な場合の共有のルート スカッシュ動作を指定します。
|
x-ms-enable-snapshot-virtual-directory-access: <true \| false> |
随意。 バージョン 2024-08-04 以降でサポートされています。 NFS が有効になっているときに、共有マウント ポイントのルートでスナップショット仮想ディレクトリにアクセスできるかどうかを指定します。 |
x-ms-client-request-id |
随意。 ログ記録の構成時に Storage Analytics ログに記録される 1 kibibyte (KiB) 文字の制限を持つ、クライアント生成の不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。 詳細については、「Monitor Azure Blob Storage」を参照してください。 |
x-ms-lease-id:<ID> |
コピー先のファイル共有にアクティブなリースがある場合に必要です。 バージョン 2020-02-10 以降で使用できます。 要求にリース ID が含まれていないか、有効でない場合、操作は状態コード 412 (前提条件に失敗) で失敗します。 このヘッダーが指定されていて、宛先ファイル共有に現在アクティブなリースがない場合、操作は状態コード 412 (前提条件に失敗) で失敗します。 |
x-ms-share-paid-bursting-enabled: <true \| false> |
随意。 バージョン 2024-11-04 以降でサポートされています。 Premium ファイル共有 (FileStorage ストレージ アカウントの種類内のファイル共有) に対してのみ許可されます。 このプロパティを使用して、有料バーストを有効または無効にすることができます。 プロパティが指定されていない場合、共有は既存の有料バースト有効化状態を保持します。 |
x-ms-share-paid-bursting-max-iops |
随意。 バージョン 2024-11-04 以降でサポートされています。 Premium ファイル共有に対してのみ許可されます。 共有に対して許可される 1 秒あたりの最大有料バースト入出力操作 (IOPS) を表す整数。 共有で有料バーストがまだ有効になっていない場合: この動作は、[共有の作成] の x-ms-share-paid-bursting-max-iops ヘッダーと同じです。 指定しない場合の既定値は、共有で許可される最大 IOPS です。 このヘッダーが設定されている場合は、x-ms-share-paid-bursting-enabled も true に設定する必要があります。共有で有料バーストが既に有効になっている場合: x-ms-share-paid-bursting-max-iops を使用して、共有の最大有料バースト IOPS を更新できます。 この場合、x-ms-share-paid-bursting-enabled を設定する必要はありません。
x-ms-share-paid-bursting-enabled が true に設定されていても、x-ms-share-paid-bursting-max-iops が設定されていない場合、有料バーストの最大 IOPS は変更されません。 |
x-ms-share-paid-bursting-max-bandwidth-mibps |
随意。 バージョン 2024-11-04 以降でサポートされています。 Premium ファイル共有に対してのみ許可されます。 共有で許可される 1 秒あたりの最大有料バースト メビバイト数 (MiB/秒) を表す整数。 共有で有料バーストがまだ有効になっていない場合: この動作は、[共有の作成] の x-ms-share-paid-bursting-max-bandwidth-mibps ヘッダーと同じです。 指定しない場合の既定値は、共有で許可される最大 MiB/秒です。 このヘッダーが設定されている場合は、x-ms-share-paid-bursting-enabled も true に設定する必要があります。共有で有料バーストが既に有効になっている場合: x-ms-share-paid-bursting-max-bandwidth-mibps を使用して、共有の最大有料バースト MiB/秒を更新できます。 この場合、x-ms-share-paid-bursting-enabled を設定する必要はありません。
x-ms-share-paid-bursting-enabled が true に設定されていても、x-ms-share-paid-bursting-max-bandwidth-mibps が設定されていない場合、最大有料バースト帯域幅は変更されません。 |
要求本文
何一つ。
要求のサンプル
PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=properties
Request Headers:
x-ms-version: 2020-02-10
x-ms-date: <date>
Authorization: SharedKey myaccount: Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00Jdjid0Q=
x-ms-share-quota: 55
x-ms-root-squash: RootSquash
応答
応答には、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 |
要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、値が最大 1,024 文字表示される ASCII 文字である場合、x-ms-client-request-id ヘッダーの値と等しくなります。
x-ms-client-request-id ヘッダーが要求に存在しない場合、このヘッダーは応答に存在しません。 |
応答本文
何一つ。
認可
この操作を呼び出すことができるのは、アカウント所有者だけです。
備考
共有クォータの設定の詳細については、「共有の作成」を参照してください。
共有クォータを共有上のデータのサイズよりも小さく設定すると、操作は成功します。 ただし、共有上のデータの量がクォータを下回るまで、共有にデータを追加することはできません。 ファイルを削除または圧縮することで、データの量を減らすことができます。
Set Share Properties は、共有スナップショットではサポートされていません。 共有スナップショットに対してこの操作を実行しようとすると、状態コード 400 (InvalidQueryParameterValue) で失敗します。
NFS 共有に x-ms-enable-snapshot-virtual-directory-access ヘッダーを設定した場合は、更新された動作を観察するために共有を再マウントします。
関連項目
FileShare リソースに対する 操作 (Azure Files)