User - Delete
特定のユーザーを削除します。
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2022-08-01
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?deleteSubscriptions={deleteSubscriptions}¬ify={notify}&api-version=2022-08-01&appType={appType}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 Regex pattern: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
user
|
path | True |
string |
ユーザー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
app
|
query |
ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値は従来のパブリッシャー ポータルです。 |
||
delete
|
query |
boolean |
ユーザーのサブスクリプションを削除するかどうか。 |
|
notify
|
query |
boolean |
アカウントのクローズEmail通知をユーザーに送信します。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
If-Match | True |
string |
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
ユーザーの詳細が正常に削除されました。 |
|
204 No Content |
ユーザーの詳細が正常に削除されました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
ApiManagementDeleteUser
Sample Request
DELETE https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2022-08-01
Sample Response
定義
名前 | 説明 |
---|---|
App |
ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。 |
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
AppType
ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値はレガシ ポータルです。
名前 | 型 | 説明 |
---|---|---|
developerPortal |
string |
ユーザー作成要求は、新しい開発者ポータルによって送信されました。 |
portal |
string |
ユーザー作成要求は、レガシ開発者ポータルから送信されました。 |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |