刪除共用

作業 Delete Share 會刪除指定的共用或共用快照集。 此 API 完全受到支援,但請注意,這是舊版管理 API。

最好改用 檔案共用 - 刪除 。 儲存體資源提供者會提供 (Microsoft.Storage) 。 若要深入瞭解如何使用儲存體資源提供者以程式設計方式與 FileShare 資源互動,請參閱 FileShares 上的作業

通訊協定可用性

已啟用檔案共用通訊協定 可用
SMB 是
NFS 是

要求

您可以依照下列方式建構 Delete Share 要求。 建議使用 HTTPS。

方法 要求 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 中的路徑元件取代為您自己的路徑元件,如下所示:

路徑元件 Description
myaccount 儲存體帳戶的名稱。
myshare 檔案共用的名稱。

如需路徑命名限制的詳細資訊,請參閱 命名和參考共用、目錄、檔案和中繼資料

URI 參數

您可以在要求 URI 中指定下列其他參數。

參數 描述
sharesnapshot 選擇性。 版本 2017-04-17 和更新版本。 參數 sharesnapshot 是不透明 DateTime 值,當存在時,會指定要刪除的共用快照集。
timeout 選擇性。 timeout 參數以秒為單位。 如需詳細資訊,請參閱設定Azure 檔案儲存體作業的逾時

要求標頭

下表描述必要的和選用的要求標頭。

要求標頭 描述
Authorization 必要。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊,請參閱授權對 Azure 儲存體提出要求
Datex-ms-date 必要。 指定要求的「國際標準時間」(UTC)。 如需詳細資訊,請參閱授權對 Azure 儲存體提出要求
x-ms-version 所有授權要求都需要。 指定用於這個要求的作業版本。 如需詳細資訊,請參閱 Azure 儲存體服務的版本
x-ms-delete-snapshots: { include, include-leased } 如果共用有相關聯的快照集,則為選擇性。 指定下列其中一個選項:
  • include:刪除基底共用及其所有快照集。
  • include-leased:版本 2020-02-10 和更新版本。 刪除基底共用及其所有快照集,即使一或多個快照集有作用中的共用租用也一樣。
x-ms-client-request-id 選擇性。 提供用戶端產生的不透明值,其中包含 1-kibibyte (KiB) 設定記錄時記錄在記錄中的字元限制。 強烈建議您使用此標頭,將用戶端活動與伺服器收到的要求相互關聯。 如需詳細資訊,請參閱監視Azure 檔案儲存體
x-ms-lease-id: <ID> 如果目的地檔案共用具有作用中的租用,則為必要專案。 適用于 2020-02-10 版和更新版本。 如果要求不包含租用識別碼或無效,作業會失敗,狀態碼為 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  

回應

回應包括 HTTP 狀態碼和一組回應標頭。

狀態碼

成功的作業會傳回狀態碼「202 (已接受)」。 如需狀態碼的相關資訊,請參閱 狀態和錯誤碼

回應標頭

這項作業的回應包括下列標頭。 回應也可以包含額外的標準 HTTP 標頭。 所有標準標頭都符合 HTTP/1.1 通訊協定規格

回應標頭 描述
x-ms-request-id 此標頭可唯一識別已提出的要求,並可用於對要求進行疑難排解。 如需詳細資訊,請參閱 針對 API 作業進行疑難排解
x-ms-version 指出用來執行要求的Azure 檔案儲存體版本。
Datex-ms-date UTC 日期/時間值,指出起始回應的時間。 服務會產生此值。
x-ms-client-request-id 您可以使用此標頭來針對要求和對應的回應進行疑難排解。 如果此標頭存在於要求中,這個標頭的值會等於標頭的值 x-ms-client-request-id 。 此值最多為 1,024 個可見的 ASCII 字元。 x-ms-client-request-id如果要求中沒有標頭,則此標頭不會出現在回應中。

回應本文

無。

授權

只有帳戶擁有者可以呼叫這項作業。

備註

刪除共用時,您至少無法建立具有相同名稱的共用 30 秒。 刪除共用時,嘗試重新建立相同名稱的共用將會失敗,狀態碼為 409 (Conflict) 。 服務會傳回其他錯誤資訊,指出正在刪除共用。 正在刪除共用時,所有其他作業 (包括共用之下任何檔案中的作業) 將會失敗,並顯示狀態碼 404 (找不到)。

目前不允許刪除具有快照集的共用。 共用快照集可以個別刪除,或使用 標頭一起刪除共用 x-ms-delete-snapshots=include

您應該只針對基底共用資源指定 x-ms-delete-snapshots 要求。 如果您在刪除個別快照集的要求上指定此標頭,Azure 檔案儲存體傳回狀態碼 400 (不正確查詢參數值) 。 如果未在刪除要求上指定此標頭,且共用具有相關聯的快照集,則Azure 檔案儲存體會傳回狀態碼 409 (Share Has Snapshots) 。

另請參閱

共用作業 (Azure 檔案儲存體)