Lease Container操作は、削除操作のためにコンテナにロックを設定・管理します。 ロック期間は、15 ~ 60 秒にすることも、無限にすることもできます。
Lease Container操作は以下のいずれかのモードで呼び出せます:
Acquire、新しい賃貸契約を申請するために。Renew既存のリース契約を更新するために。Change既存のリース契約のIDを変更するために。Releaseリースが不要になった場合にリースを解除し、他の顧客がすぐにコンテナを担保にリースを取得することができるようにするためです。Breakリースを終了するために、他のクライアントが現在のリース期間が終了するまで新たなリース契約を取得できないようにすること。
Note
Lease Container操作はバージョン2012-02-12以降で利用可能です。
Request
Lease Container 要求は次のように構築できます。 HTTPS をお勧めします。 myaccount
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
PUT |
https://myaccount.blob.core.windows.net/mycontainer?comp=lease&restype=container |
HTTP/1.1 |
ルートコンテナを指定するには、コンテナ名として $root を入力します。
エミュレートされたストレージ サービス URI
エミュレートされたストレージ サービスに対して要求を行う場合は、エミュレーターのホスト名と Azure Blob Storage ポートを 127.0.0.1:10000として指定し、その後にエミュレートされたストレージ アカウント名を指定します。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
PUT |
http://127.0.0.1:10000/mycontainer?comp=lease&restype=container |
HTTP/1.0 HTTP/1.1 |
詳細については、「ローカルの Azure Storage 開発に Azurite エミュレーターを使用する
URI パラメーター
リクエストURIで以下の追加パラメータを指定できます。
| Parameter | Description |
|---|---|
timeout |
Optional.
timeout パラメーターは秒単位で表されます。 詳細については、「Blob Storage 操作のタイムアウトの設定」を参照してください。 |
リクエストヘッダー
次の表では、必須の要求ヘッダーと省略可能な要求ヘッダーについて説明します。
| リクエストヘッダー | Description |
|---|---|
Authorization |
Required. 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
Date または x-ms-date |
Required. 要求の世界協定時刻 (UTC) を指定します。 詳細については、「Azure Storageへの要求を承認する」を参照してください。 |
x-ms-version |
Optional. この要求に使用する操作のバージョンを指定します。 詳細については、Azure Storage サービスのバージョン管理の |
x-ms-lease-id: <ID> |
契約の更新、変更、または解除が必要。x-ms-lease-idの値は有効なGUID文字列形式で指定できます。 有効なフォーマットのリストについては Guid Constructor(String) を参照してください。 |
x-ms-lease-action: <acquire ¦ renew ¦ change ¦ release ¦ break> |
acquire:新しい賃貸契約を申請。 コンテナにアクティブなリースがない場合、Blob Storageはコンテナにリースを作成し、新しいリースIDを返します。 コンテナに有効なリースがある場合、新規リースを申請するには有効なリースIDを使ってのみ可能です。 ただし、期限切れのないリースに対しては、負の x-ms-lease duration(-1)を含む新しい契約を指定することは可能です。renew:リースを更新しろ。 リクエストで指定されたリースIDがコンテナに関連するものと一致すれば、リースを更新できます。 リース期間が切れていても、そのリース満了後にコンテナが再びリースされていない限り、契約は更新可能です。 リースを更新すると、リース期間クロックがリセットされます。change:有効なリースのリースIDを変更してください。
changeにはx-ms-lease-idの現在のリースIDと、x-ms-proposed-lease-idの新しいリースIDを含める必要があります。releaseリースを解除しろ。 リクエストで指定されたリースIDがコンテナに関連付けられているものと一致すれば、リース契約を解除できます。 リースを解除すると、リリース完了と同時に他のクライアントがすぐにコンテナのリースを取得することができます。break:コンテナに有効なリースがある場合はリースを解除してください。 契約が破棄されると、更新はできません。 いかなる許可された申請も契約解除の可能性があります。 リクエストで一致するリースIDを指定する必要はありません。 リースが解約されると、リース解除期間は経過します。 この期間中はコンテナに対して break および release リース作業のみができます。 リースが正常に切断されると、応答は、新しいリースを取得できるようになるまでの間隔を秒単位で示します。破棄されたリース契約も解除可能です。 クライアントは解除されたコンテナリースをすぐに取得できます。 |
x-ms-lease-break-period: N |
Optional.
break操作の場合、このヘッダーはリースが終了するまでに継続すべき提案時間、0秒から60秒の間を示します。 この休止期間は、リースの残り期間より短い場合にのみ使われます。 長い場合は、リースの残りの時間が使用されます。 新しいリース契約は休憩期間が終了するまでは利用できませんが、休憩期間より長くリースを保持することは可能です。 このヘッダーが break 操作に表示されない場合、残りのリース期間終了後に固定期間リースは解約され、無限リースは即座に解約されます。 |
x-ms-lease-duration: -1 ¦ n seconds |
acquireに必要です。 リースの期間を秒単位で指定するか、有効期限が切れないリースの負の 1 (-1) を指定します。 非無限リースは、15 ~ 60 秒の間で指定できます。 リース期間は、 renew や changeを使って変更することはできません。 |
x-ms-proposed-lease-id: <ID> |
acquireは任意で、changeは必須です。 提案されたリース ID (GUID 文字列形式)。 Blob Storage提案された賃貸契約IDが正しいフォーマットでなければ返400 (Invalid request)します。 有効なフォーマットのリストについては Guid Constructor(String) を参照してください。 |
Origin |
Optional. 請求が発行される出所を指定します。 このヘッダーが存在することで、応答にクロスオリジンリソース共有(CORS)ヘッダーが表示されます。 詳細は ストレージサービスに関するCORSサポート を参照してください。 |
x-ms-client-request-id |
Optional. ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を持つクライアント生成の不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティと、サーバーが受信する要求を関連付けすることを強くお勧めします。 詳細については、「Monitor Azure Blob Storage」を参照してください。 |
この操作は、指定された条件が満たされた場合にのみ条件付きヘッダーを用いて操作を実行することもサポートしています。 詳細については、「 Blob Storage 操作の条件付きヘッダーの指定」を参照してください。
リクエスト本文
None.
サンプル依頼
以下のサンプルリクエストは、リース取得方法を示しています:
Request Syntax:
PUT https://myaccount.blob.core.windows.net/mycontainer?restype=container&comp=lease HTTP/1.1
Request Headers:
x-ms-version: 2012-02-12
x-ms-lease-action: acquire
x-ms-lease-duration: -1
x-ms-proposed-lease-id: 1f812371-a41d-49e6-b123-f4b542e851c5
x-ms-date: Thu, 26 Jan 2012 23:30:18 GMT
Authorization: SharedKey testaccount1:esSKMOYdK4o+nGTuTyeOLBI+xqnqi6aBmiW4XI699+o=
Response
応答には、HTTP 状態コードと一連の応答ヘッダーが含まれます。
ステータスコード
リース運用で返される成功ステータスコードは以下の通りです:
Acquire: 成功した操作はステータスコード201(作成済み)を返します。Renew: 操作が成功するとステータスコード200(OK)が返されます。Change: 操作が成功するとステータスコード200(OK)が返されます。Release: 操作が成功するとステータスコード200(OK)が返されます。Break: 操作が成功するとステータスコード202(承認済み)が返されます。
状態コードの詳細については、「状態コードとエラー コードを参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれます。 応答には、追加の標準 HTTP ヘッダーを含めることもできます。 すべての標準ヘッダーは、HTTP/1.1 プロトコル仕様に準拠しています。
| Syntax | Description |
|---|---|
ETag |
コンテナの ETag 。 このヘッダーはバージョン2013-08-15以降に対して返されるリクエストに対して返され、 ETag 値は引用符で囲まれています。
Lease Container バージョン2013-08-15以降の操作はこの性質を変更しませんが、それ以前のバージョンは変更します。 |
Last-Modified |
バージョン2013-08-15以降のリクエストについて戻ってきました。 コンテナーが最後に変更された日時を返します。 詳細については、「ヘッダーの日時値の表現」を参照してください。 コンテナやそのプロパティ、メタデータを変更するすべての操作は、最後に修正された時間を更新します。 これにはコンテナの権限設定も含まれます。 ブロブに対する操作はコンテナの最後の修正時間には影響しません。 Lease Container バージョン2013-08-15以降の操作はこの性質を変更しませんが、それ以前のバージョンは変更します。 |
x-ms-lease-id: <id> |
リースをリクエストすると、Blob Storageは一意のリースIDを返します。 リースが有効な間は、コンテナの削除や更新、変更、解除の申請には必ずリースIDを記載してください。 更新が成功すると、有効なリースのリースIDも返されます。 |
x-ms-lease-time: seconds |
リース期間の残りのおおよその時間 (秒単位)。 このヘッダーはリース解除の成功リクエストでのみ返されます。 もしブレイクが即時に起こる場合は0が返されます。 |
x-ms-request-id |
このヘッダーは、作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用される Blob Storage のバージョンを示します。 このヘッダーは、バージョン 2009-09-19 以降に対して行われた要求に対して返されます。 |
| Date | 応答が開始された時刻を示す UTC 日付/時刻値。 サービスによってこの値が生成されます。 |
Access-Control-Allow-Origin |
リクエストに Origin ヘッダーが含まれ、CORSが対応するルールで有効になっている場合、返されます。 このヘッダーは、マッチした場合に元のリクエストヘッダーの値を返します。 |
Access-Control-Expose-Headers |
リクエストに Origin ヘッダーが含まれ、CORSが対応するルールで有効になっている場合、返されます。 クライアントまたはリクエスト発行者に公開されるレスポンスヘッダーのリストを返します。 |
Access-Control-Allow-Credentials |
リクエストに Origin ヘッダーが含まれていて、CORSがすべてのオリジンを許可しないマッチングルールで有効になっている場合に返されます。 このヘッダーは trueに設定されます。 |
x-ms-client-request-id |
このヘッダーを使用して、要求と対応する応答のトラブルシューティングを行うことができます。 このヘッダーの値は、要求に存在する場合、x-ms-client-request-id ヘッダーの値と同じです。 この値は、最大で 1,024 文字の表示 ASCII 文字です。
x-ms-client-request-id ヘッダーが要求に存在しない場合、応答には存在しません。 |
応答本文
None.
サンプル応答
以下はリース取得依頼のサンプル回答です:
Response Status:
HTTP/1.1 201 Created
Response Headers:
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0
x-ms-request-id: cc6b209a-b593-4be1-a38a-dde7c106f402
x-ms-version: 2012-02-12
x-ms-lease-id: 1f812371-a41d-49e6-b123-f4b542e851c5
Date: Thu, 26 Jan 2012 23:30:18 GMT
Authorization
Azure Storageでデータアクセス操作を呼び出す際には、認証が必要です。 以下のセクションで説明されているように Lease Container 操作を承認できます。
Important
Microsoft では、マネージド ID で Microsoft Entra ID を使用して、Azure Storage への要求を承認することをお勧めします。 Microsoft Entra ID は、共有キーの承認と比較して優れたセキュリティと使いやすさを提供します。
- Microsoft Entra ID (推奨)
- 共有アクセス署名
-
共有キー の
Azure Storage では、Microsoft Entra ID を使用して BLOB データへの要求を承認できます。 Microsoft Entra ID を使用すると、Azure ロールベースのアクセス制御 (Azure RBAC) を使用して、セキュリティ プリンシパルにアクセス許可を付与できます。 セキュリティプリンシパルはユーザー、グループ、アプリケーションサービスプリンシパル、またはAzureマネージドアイデンティティのいずれかです。 セキュリティ プリンシパルは、OAuth 2.0 トークンを返すために Microsoft Entra ID によって認証されます。 その後、トークンを使ってBlob Storageに対するリクエストを承認できます。
Microsoft Entra ID を使用した承認の詳細については、「Microsoft Entra IDを使用して BLOB へのアクセスを承認する」を参照してください。
Permissions
以下のRBACアクションは、Microsoft Entraユーザー、グループ、マネージドアイデンティティ、またはサービスプリンシパルがLease Container操作を呼び出すために必要なものであり、この動作を含む最小特権の組み込みRBAC役割Azure以下の通りです。
- Azure RBAC action: Microsoft.Storage/storageAccounts/blobServices/containers/write
- 最も権限の少ない組み込みロール: Storage Blob Data Contributor
Azure RBACを使ったロール割り当てについて詳しくは、「Assign an Azure role for access to blob data」をご覧ください。
Remarks
コンテナーのリースによって、コンテナーへの排他的削除アクセスが提供されます。 コンテナリースは、 Delete Container 操作を使ってコンテナを削除する権限のみを制御します。 アクティブなリースを使用してコンテナーを削除するには、クライアントが削除要求に有効なリース ID を含める必要があります。 リースIDが含まれていなければ、412(前提条件が失敗)で操作が失敗します。 その他のコンテナ操業はリースコンテナで成功しますが、リースIDは含まれません。 リースは、リース取得時に指定された期間(15秒から60秒)または無限の期間で付与されます。
クライアントがリースを取得すると、リースIDが返送されます。 Blob Storageは、取得リクエストでリースIDが指定されていない場合、リースIDを生成します。 クライアントはこのリースIDを使ってリースを更新したり、変更したり、リースを解除したりできます。 以下の図は、リースの可能な状態と、リース状態の変化を引き起こすコマンドやイベントを示しています。
リース契約は、リースがロックされているかロック解除されているか、またその州でリースが更新可能かどうかによって、5つの州のいずれかで契約できます。 前述の図に示されたリースアクションは状態遷移を引き起こします。
| 更新の状況 | ロックリース | アンロックリース |
|---|---|---|
| 更新可能なリース | リース | 有効期限切れ |
| 更新不可リース | 速報 | 壊れた、利用可能 |
Availableリースは解除され取得可能です。 許可された行動数:acquire。Leasedリースはロックされています。 許可されているアクション:acquire(同じリースIDのみ)、renew、change、release、break。Expiredリース期間が終了しました。 許可された行動:acquire、renew、release、break。Breakingリースは破棄されましたが、契約解除期間が終了するまでリースはロックされ続けます。 許可される行動:releaseとbreak。Brokenリースは破棄され、休止期間は終了しました。 許可された行動:acquire、release、break。
Blob Storageは、コンテナリースが満了した後もリースIDを維持します。 クライアントは期限切れのリースIDを使ってリースを更新または解除することができます。 クライアントが以前のリースIDで期限切れのリースを更新または解除しようとし、リクエストが失敗した場合、そのコンテナは再びリースされたか、クライアントのリースが最後に有効だったため削除されたことになります。
リースが明示的に解除されずに満了した場合、クライアントはコンテナの新しいリースを取得するまで最大1分待つ必要があるかもしれません。 ただし、クライアントは、有効期限切れのリース ID でリースを直ちに更新できます。
コンテナの Last-Modified-Time プロパティは Lease Containerへの呼び出しによって更新されません。
以下の表は、さまざまなリース州におけるリース契約を持つコンテナに関する措置の結果を示しています。 文字(A)、(B)、(C)はリースIDを表し、(X)はBlob Storageによって生成されるリースIDを表します。
リース州によるコンテナ使用試行の結果
| アクション | Available | リース(A) | ブレイキング(A) | ブロークン(A) | 期限切れ(A) |
|---|---|---|---|---|---|
| (A)で削除する | 失敗(412) | リース(A)、削除成功 | (A)を破ると、削除は成功します | 失敗(412) | 失敗(412) |
| (B)で削除 | 失敗(412) | 失敗数(409) | 失敗(412) | 失敗(412) | 失敗(412) |
| 削除、賃貸契約書の指定なし | 利用可能、削除は成功します | 失敗(412) | 失敗(412) | 利用可能、削除は成功します | 利用可能、削除は成功します |
| (A)を含むその他の演算 | 失敗(412) | リース(A)、操業成功 | 突破(A)、作戦成功 | 失敗(412) | 失敗(412) |
| その他の演算 (B) | 失敗(412) | 失敗数(409) | 失敗数(409) | 失敗(412) | 失敗(412) |
| 運営、リース契約は明記されていません | 利用可能、作戦成功 | リース(A)、操業成功 | 突破(A)、作戦成功 | 壊れた(A)、作戦成功 | 期限切れ(A)、手術成功 |
リース州ごとのコンテナリース運用の結果
| アクション | Available | リース(A) | ブレイキング(A) | ブロークン(A) | 期限切れ(A) |
|---|---|---|---|---|---|
Acquire提案された賃貸契約IDはありません |
リース(X) | 失敗数(409) | 失敗数(409) | リース(X) | リース(X) |
Acquire (A) |
リース(A) | リース(A)、新しい期間 | 失敗数(409) | リース(A) | リース(A) |
Acquire (B) |
リース(B) | 失敗数(409) | 失敗数(409) | リース(B) | リース(B) |
Break、周期=0 |
失敗数(409) | ブロークン(A) | ブロークン(A) | ブロークン(A) | ブロークン(A) |
Break、終わり>0 |
失敗数(409) | ブレイキング(A) | ブレイキング(A) | ブロークン(A) | ブロークン(A) |
Change、(A)から(B)へ |
失敗数(409) | リース(B) | 失敗数(409) | 失敗数(409) | 失敗数(409) |
Change、(B)から(A)へ |
失敗数(409) | リース(A) | 失敗数(409) | 失敗数(409) | 失敗数(409) |
Change、(B)から(C)まで |
失敗数(409) | 失敗数(409) | 失敗数(409) | 失敗数(409) | 失敗数(409) |
Renew (A) |
失敗数(409) | リース(A)、有効期限のリセット | 失敗数(409) | 失敗数(409) | リース(A) |
Renew (B) |
失敗数(409) | 失敗数(409) | 失敗数(409) | 失敗数(409) | 失敗数(409) |
Release (A) |
失敗数(409) | Available | Available | Available | Available |
Release (B) |
失敗数(409) | 失敗数(409) | 失敗数(409) | 失敗数(409) | 失敗数(409) |
| 期間満了 | Available | 期限切れ(A) | ブロークン(A) | ブロークン(A) | 期限切れ(A) |
Billing
価格要求は、Blob Storage API を使用するクライアントから、Blob Storage REST API を介して直接、または Azure Storage クライアント ライブラリから送信できます。 これらの要求には、トランザクションあたりの料金が発生します。 トランザクションの種類は、アカウントの課金方法に影響します。 たとえば、読み取りトランザクションは、書き込みトランザクションとは異なる課金カテゴリに発生します。 次の表に、ストレージ アカウントの種類に基づく Lease Container 要求の課金カテゴリを示します。
| Operation | ストレージ アカウントの種類 | 課金カテゴリ |
|---|---|---|
| リースコンテナ(取得、解除、更新) | プレミアム ブロック ブロブ 標準汎用 バージョン 2 |
その他の操作 |
| リースコンテナ(取得、解除、更新) | 標準汎用バージョン1 | 読み取り操作 |
| リースコンテナ(休止、変更) | プレミアム ブロック ブロブ 標準汎用 バージョン 2 |
その他の操作 |
| リースコンテナ(休止、変更) | 標準汎用バージョン1 | 書き込み操作 |
指定された課金カテゴリの価格については、Azure Blob Storage の価格
参照
Azure Storage への要求を承認する
状態とエラー コードの
Blob Storage のエラー コード
リース ブロブ