User - Delete

Löscht den angegebenen Benutzer

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-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe.

serviceName
path True

string

Der Name des API Management-Diensts.

RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

userId
path True

string

Benutzer-ID. Muss im aktuellen API Management Dienst instance eindeutig sein.

api-version
query True

string

Version der API, die mit der Clientanforderung verwendet werden soll.

appType
query

AppType

Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyherausgeberportal.

deleteSubscriptions
query

boolean

Gibt an, ob das Abonnement des Benutzers gelöscht werden soll oder nicht.

notify
query

boolean

Senden Sie eine Benachrichtigung zum geschlossenen Email für den Benutzer.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match True

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Antworten

Name Typ Beschreibung
200 OK

Die Benutzerdetails wurden erfolgreich gelöscht.

204 No Content

Die Benutzerdetails wurden erfolgreich gelöscht.

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementDeleteUser

Beispielanforderung

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

Beispiel für eine Antwort

Definitionen

Name Beschreibung
AppType

Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyportal.

ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

AppType

Bestimmt den Typ der Anwendung, die die Create-Benutzeranforderung sendet. Der Standardwert ist das Legacyportal.

Name Typ Beschreibung
developerPortal

string

Die Benutzererstellungsanforderung wurde vom neuen Entwicklerportal gesendet.

portal

string

Die Benutzererstellungsanforderung wurde vom Legacy-Entwicklerportal gesendet.

ErrorFieldContract

Fehlerfeldvertrag.

Name Typ Beschreibung
code

string

Fehlercode auf Eigenschaftsebene.

message

string

Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.

target

string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error.code

string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

ErrorFieldContract[]

Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.

error.message

string

Lesbare Darstellung des Fehlers.