Items - Delete Notebook

Служба:

Notebook

Версия API:

v1

Удаляет указанную записную книжку.

Разрешения

Вызывающий объект должен иметь разрешения на запись записной книжки.

Обязательные делегированные области

Notebook.ReadWrite.All или Item.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}

С использованием необязательных параметров:

DELETE https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}?hardDelete={hardDelete}

Параметры URI

Имя	В	Обязательно	Тип	Описание
notebookId	path	True	string (uuid)	Идентификатор записной книжки.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
hardDelete	query		boolean	Указывает, следует ли выполнять жесткое удаление. Если задано значение true, элемент удаляется безвозвратно и не может быть восстановлен. Если задано false значение или не указано, элемент обратимо удаляется, если тип элемента поддерживает его.

Ответы

Имя	Тип	Описание
200 OK		Запрос успешно завершен.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — запрошенный элемент не найден. InsufficientWorkspaceRole — пользователь не имеет достаточной роли рабочей области. FeatureNotAvailable — это может быть связано с тем, что функция обратимого удаления недоступна. UnsupportedItemType — это может быть связано с функцией обратимого удаления, которая не поддерживается запрошенным типом элемента. TenantSwitchDisabled . Это может быть связано с функцией обратимого удаления, отключаемой администратором клиента. InvalidTargetItemStateForSoftDeletion — элемент находится в недопустимых состояниях для обратимого удаления. InvalidParentItemStateForSoftDeletion — родительский элемент элемента не находится в активном состоянии.

Примеры

Delete a notebook example

Hard delete a notebook example

Delete a notebook example

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

HTTP

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715

Пример ответа

Код состояния:

200

Hard delete a notebook example

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

HTTP

DELETE https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/notebooks/5b218778-e7a5-4d73-8187-f10824047715?hardDelete=True

Пример ответа

Код состояния:

200

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.