User - Delete

Služba:

API Management

Verze rozhraní API:

2024-05-01

Odstraní konkrétního uživatele.

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

S volitelnými parametry:

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
userId	path	True	string minLength: 1 maxLength: 80	Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
appType	query		AppType	Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu vydavatele.
deleteSubscriptions	query		boolean	Jestli chcete odstranit předplatné uživatele, nebo ne.
notify	query		boolean	Odešlete uživateli oznámení o zavřeném e-mailu účtu.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match	True	string	ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

Odpovědi

Name	Typ	Description
202 Accepted		Žádost o odstranění podrobností o uživateli byla přijata. Hlavičky location: string Azure-AsyncOperation: string
204 No Content		Podrobnosti o uživateli byly úspěšně odstraněny.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementDeleteUser

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

204

Definice

Name	Description
AppType	Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď

AppType

Výčet

Určuje typ aplikace, která odešle žádost o vytvoření uživatele. Výchozí hodnota je starší verze portálu.

Hodnota	Description
developerPortal	Žádost o vytvoření uživatele odeslal nový portál pro vývojáře.
portal	Žádost o vytvoření uživatele odeslala starší verze portálu pro vývojáře.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.