共有の削除

  • [アーティクル]

操作によりDelete Share、指定した共有または共有スナップショットが削除されます。 この API は完全にサポートされていますが、これはレガシ管理 API であることに注意してください。

代わりに、 ファイル共有 - 削除 を使用することをお勧めします。 これは、ストレージ リソース プロバイダー (Microsoft.Storage) によって提供されます。 ストレージ リソース プロバイダーを使用してプログラムでリソースを FileShare 操作する方法の詳細については、「 FileShares に対する操作」を参照してください。

プロトコルの可用性

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

要求

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

Method 要求 URI HTTP バージョン
DELETE https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1
DELETE https://myaccount.file.core.windows.net/myshare?sharesnapshot=<DateTime>&restype=share HTTP/1.1

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

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

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

URI パラメーター

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

パラメーター 説明
sharesnapshot 省略可能。 バージョン 2017-04-17 以降。 パラメーターはsharesnapshot不透明DateTimeな値であり、存在する場合は、削除する共有スナップショットを指定します。
timeout 省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「Azure Files操作のタイムアウトの設定」を参照してください。

要求ヘッダー

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

要求ヘッダー 説明
Authorization 必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。
Date または x-ms-date 必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。
x-ms-version すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
x-ms-delete-snapshots: { include, include-leased } 共有にスナップショットが関連付けられている場合は省略可能です。 次のいずれかのオプションを指定します。
  • include: 基本共有とそのすべてのスナップショットを削除します。
  • include-leased: バージョン 2020-02-10 以降。 1 つ以上のスナップショットにアクティブな共有リースがある場合でも、基本共有とそのすべてのスナップショットを削除します。
x-ms-client-request-id 省略可能。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「Azure Filesの監視」を参照してください。
x-ms-lease-id: <ID> 宛先ファイル共有にアクティブなリースがある場合は必須です。 バージョン 2020-02-10 以降で使用できます。 要求にリース ID が含まれていないか、無効な場合、状態コード 412 (前提条件が失敗) で操作が失敗します。

このヘッダーが指定されていて、宛先ファイル共有に現在アクティブなリースがない場合、操作は状態コード 412 (前提条件に失敗) でも失敗します。

要求本文

なし。

要求のサンプル

DELETE https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1  
  
Request Headers:  
x-ms-version: 2014-02-14  
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT  
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ= TBD

Response

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

状態コード

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

応答ヘッダー

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

応答ヘッダー 説明
x-ms-request-id このヘッダーは、行われた要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。
x-ms-version 要求の実行に使用Azure Filesのバージョンを示します。
Date または x-ms-date 応答が開始された時刻を示す UTC 日付/時刻値。 サービスによってこの値が生成されます。
x-ms-client-request-id このヘッダーを使用して、要求と対応する応答のトラブルシューティングを行うことができます。 このヘッダーの値は、要求に存在する x-ms-client-request-id 場合、ヘッダーの値と同じです。 この値は、最大 1,024 文字の ASCII 文字で表示されます。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、このヘッダーは応答に存在しません。

応答本文

なし。

承認

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

注釈

共有を削除すると、同じ名前の共有を 30 秒以上作成することはできません。 共有が削除されている間、同じ名前の共有を再作成しようとすると、状態コード 409 (競合) で失敗します。 サービスは、共有が削除されていることを示す追加のエラー情報を返します。 共有の削除中、その他のすべての操作は (共有の下位にあるファイルの操作を含む)、ステータス コード 404 (Not Found) で失敗します。

現時点では、スナップショットを含む共有の削除は許可されていません。 共有スナップショットは、 ヘッダーを使用して x-ms-delete-snapshots=include 個別に削除することも、共有と共に削除することもできます。

基本共有リソースに対する要求のみを指定 x-ms-delete-snapshots する必要があります。 個々のスナップショットを削除する要求でこのヘッダーを指定した場合、Azure Filesは状態コード 400 (無効なクエリ パラメーター値) を返します。 削除要求でこのヘッダーが指定されておらず、共有にスナップショットが関連付けられている場合、Azure Filesは状態コード 409 (Share Has Snapshots) を返します。

関連項目

共有に対する操作 (Azure Files)