Поделиться через

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.
subscriptionId
 path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть UUID.
userId
 path True

string

minLength: 1
maxLength: 80

Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы управления API.
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

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementDeleteUser

Образец запроса

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

Объект ошибки.