User - Delete

サービス:

API Management

API バージョン:

2024-05-01

特定のユーザーを削除します。

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2024-05-01

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
userId	path	True	string minLength: 1 maxLength: 80	ユーザー識別子。 現在の API Management サービス インスタンスで一意である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
appType	query		AppType	ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値は従来のパブリッシャー ポータルです。
deleteSubscriptions	query		boolean	ユーザーのサブスクリプションを削除するかどうか。
notify	query		boolean	アカウント終了メール通知をユーザーに送信します。

要求ヘッダー

名前	必須	型	説明
If-Match	True	string	エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。

応答

名前	型	説明
202 Accepted		ユーザーの詳細を削除する要求が受け入れられました。 ヘッダー location: string Azure-AsyncOperation: string
204 No Content		ユーザーの詳細が正常に削除されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ApiManagementDeleteUser

要求のサンプル

HTTP

DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2024-05-01

応答のサンプル

状態コード:

202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=204
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

状態コード:

204

定義

名前	説明
AppType	ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

AppType

列挙

ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。

値	説明
developerPortal	ユーザー作成要求が新しい開発者ポータルによって送信されました。
portal	ユーザー作成要求は、レガシ開発者ポータルによって送信されました。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。