Dela via

User - Delete

  • Referens
Tjänst:
API Management
API-version:
2024-05-01

Tar bort en specifik användare.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2024-05-01
Med valfria parametrar: 
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-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Namnet på API Management-tjänsten.
subscriptionId
 path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.
userId
 path True

string

minLength: 1
maxLength: 80

Användaridentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.
api-version
 query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.
appType
 query

AppType

Avgör vilken typ av program som skickar begäran om att skapa användare. Standardvärdet är den äldre utgivarportalen.
deleteSubscriptions
 query

boolean

Om användarens prenumeration ska tas bort eller inte.
notify
 query

boolean

Skicka ett konto stängt e-postmeddelande till användaren.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match True

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

Svar

Name Typ Description
202 Accepted

Begäran om att ta bort användarinformation godkändes.

Sidhuvuden

  • location: string
  • Azure-AsyncOperation: string
204 No Content

Användarinformationen har tagits bort.
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementDeleteUser

Exempelbegäran

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

Exempelsvar

Statuskod:
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
Statuskod:
204

Definitioner

Name Description
AppType

Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar

AppType

Uppräkning

Avgör vilken typ av program som skickar begäran om att skapa användare. Standard är den äldre portalen.

Värde Description
developerPortal

Begäran om användarskapning skickades av den nya utvecklarportalen.
portal

Begäran om användarskapning skickades av den äldre utvecklarportalen.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.