Scan Rulesets - Delete

Service:
Purview
API Version:
2023-09-01

Deletes a scan ruleset.

DELETE {endpoint}/scan/scanrulesets/{scanRulesetName}?api-version=2023-09-01

URI Parameters

Name In Required Type Description
endpoint
 path True

string (url)

The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com.
scanRulesetName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

The scan ruleset name.
api-version
 query True

string

The api version to use.

Responses

Name Type Description
204 No Content

Success.
Other Status Codes

ErrorResponseModel

An error response received from the Scanning Service.

Headers

x-ms-error-code: string

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ScanRulesets_Delete

Sample request

DELETE {endpoint}/scan/scanrulesets/nyScanRulesetName?api-version=2023-09-01

Sample response

Status code:
204 
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

Definitions

Name Description
ErrorModel

The error model.
ErrorResponseModel

The error response model.

ErrorModel

Object

The error model.

Name Type Description
code

string

A unique error code that identifies the specific error.
details

ErrorModel[]

An array of nested ErrorModel objects that provides additional error details.
message

string

A human-readable error message that provides more details about the error.
target

string

The specific component that the error is associated with.

ErrorResponseModel

Object

The error response model.

Name Type Description
error

ErrorModel

The error model.