Sent Shares - Delete

Service:

Purview

API Version:

2023-02-15-preview

Deletes a sent share.
Delete a sent share

DELETE {endpoint}/sentShares/{sentShareId}?api-version=2023-02-15-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The sharing endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share
sentShareId	path	True	string maxLength: 36 pattern: ^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$	Id of the sent share
api-version	query	True	string	The api version to use

Responses

Name	Type	Description
202 Accepted	OperationResponse	Accepted Headers Operation-Location: string
Other Status Codes	PurviewShareError	Default error response. Headers x-ms-error-code: string

Security

azureAuth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://purview.azure.net/.default	Purview service scope

Examples

SentShares_Delete

Sample request

HTTP

DELETE accountName.purview.azure.com/share/sentShares/FF4A2AAE-8755-47BB-9C00-A774B5A7006E?api-version=2023-02-15-preview

Sample response

Status code:

202

Date: Fri, 17 Feb 2023 23:42:23 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
x-ms-long-running-operation: True
Operation-Location: https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview
Operation-Id: dad6baec-3a39-41df-a469-843a9ee94213

{
  "id": "dad6baec-3a39-41df-a469-843a9ee94213",
  "startTime": "2023-02-17T23:42:25.6688Z",
  "endTime": null,
  "status": "NotStarted",
  "error": null
}

Definitions

Name	Description
OperationResponse	Response for long running operation.
OperationStatus	States for long running operations.
PurviewShareError	The purview share error model.
PurviewShareErrorInfo	The purview share error body model.

OperationResponse

Object

Response for long running operation.

Name	Type	Description
endTime	string (date-time)	End time of the long running operation. Represented in the standard date-time format as defined by RFC 3339
error	PurviewShareErrorInfo	The purview share error body model.
id	string	Job id of the long running operation
startTime	string (date-time)	Start time of the long running operation. Represented in the standard date-time format as defined by RFC 3339
status	OperationStatus	States for long running operations.

OperationStatus

Enumeration

States for long running operations.

Value	Description
Failed	The long running operation is in 'Failed' state
NotStarted	The long running operation has not started
Running	The long running operation is in 'Running' state
Succeeded	The long running operation is in 'Succeeded' state
TransientFailure	The long running operation hit a transient failure

PurviewShareError

Object

The purview share error model.

Name	Type	Description
error	PurviewShareErrorInfo	The purview share error body model.

PurviewShareErrorInfo

Object

The purview share error body model.

Name	Type	Description
code	string	Code of the error
details	PurviewShareErrorInfo[]	Nested details of the error model
message	string	Message of the error
target	string	Target of the error