Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
DELETE /ambient-sessions/{correlationId}?api-version=2
Indicates that an ambient recording session has ended.
Parameters
| Type | Name | Required | Description | Schema |
|---|---|---|---|---|
| Path | correlationId |
Yes | The correlation ID of the ambient session to be deleted. Allowed characters: letters, numbers, underscore (_), hyphen (-) and pipe (|). | String |
| Query | api-version |
Yes | The supported API version. Must be set to 2. | Integer (int32) |
HTTP headers
| Name | Value |
|---|---|
Authorization |
Bearer <access token issued by your identity solution> |
Request body
None.
Sample request
DELETE /ambient-sessions/3fa85f64-5717-4562-b3fc-2c963f66afa6?api-version=2
Response codes
| Code | Description | Links |
|---|---|---|
| 200 | Success. The ambient session is deleted and returned. | No links |
| 400 | Bad request. Required validations aren't passed. | No links |
| 401 | Not authorized. The access token is missing or invalid. | No links |
| 403 | Forbidden. The caller isn't authorized to delete the ambient session. | No links |
| 404 | Not found. The specified ambient session wasn't found. | No links |
| 500 | Internal server error. Any other exceptional scenario where the application isn't able to complete the request. | No links |
| 5xx | The HTTP status is propagated from the handler application to the caller application for transparency of the problem. | No links |