共用方式為


User - Delete

刪除特定使用者。

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2021-08-01
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?deleteSubscriptions={deleteSubscriptions}&notify={notify}&api-version=2021-08-01&appType={appType}

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

資源群組的名稱。

serviceName
path True

string

API 管理 服務的名稱。

Regex 模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

userId
path True

string

使用者識別碼。 目前 API 管理 服務實例中必須是唯一的。

api-version
query True

string

要與用戶端要求搭配使用的 API 版本。

appType
query

AppType

決定傳送建立使用者要求的應用程式類型。 預設值為舊版發行者入口網站。

deleteSubscriptions
query

boolean

是否要刪除使用者的訂用帳戶。

notify
query

boolean

傳送帳戶已關閉 Email 通知給使用者。

要求標頭

名稱 必要 類型 Description
If-Match True

string

實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態,否則應該為 * 進行無條件更新。

回應

名稱 類型 Description
200 OK

已成功刪除使用者詳細數據。

204 No Content

已成功刪除使用者詳細數據。

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

ApiManagementDeleteUser

範例要求

DELETE https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2021-08-01

範例回覆

定義

名稱 Description
AppType

決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。

ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

AppType

決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。

名稱 類型 Description
developerPortal

string

使用者建立要求是由新的開發人員入口網站傳送。

portal

string

使用者建立要求是由舊版開發人員入口網站傳送。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

人類可讀取的屬性層級錯誤表示法。

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

ErrorFieldContract[]

在驗證錯誤時,要求中傳送的無效欄位清單。

error.message

string

人類可閱讀的錯誤表示法。