Package com.azure.analytics.purview.scanning

Class ScanRulesetsClient

java.lang.Object

com.azure.analytics.purview.scanning.ScanRulesetsClient

public final class ScanRulesetsClient
extends Object

Initializes a new instance of the synchronous PurviewScanningClient type.

Method Summary

Modifier and Type	Method	Description
Response<BinaryData>	createOrUpdateWithResponse(String scanRulesetName, RequestOptions requestOptions)	Creates or Updates a scan ruleset.
Response<BinaryData>	deleteWithResponse(String scanRulesetName, RequestOptions requestOptions)	Deletes a scan ruleset.
Response<BinaryData>	getWithResponse(String scanRulesetName, RequestOptions requestOptions)	Get a scan ruleset.
PagedIterable<BinaryData>	listAll(RequestOptions requestOptions)	List scan rulesets in Data catalog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getWithResponse

public Response<BinaryData> getWithResponse(String scanRulesetName,
 RequestOptions requestOptions)

Get a scan ruleset.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     id: String
     name: String
     scanRulesetType: String(Custom/System)
     status: String(Enabled/Disabled)
     version: Integer
 }
 

Parameters:

scanRulesetName - The scanRulesetName parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a scan ruleset along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

createOrUpdateWithResponse

public Response<BinaryData> createOrUpdateWithResponse(String scanRulesetName,
 RequestOptions requestOptions)

Creates or Updates a scan ruleset.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Request Body Schema

 {
     id: String
     name: String
     scanRulesetType: String(Custom/System)
     status: String(Enabled/Disabled)
     version: Integer
 }
 

Response Body Schema

 {
     id: String
     name: String
     scanRulesetType: String(Custom/System)
     status: String(Enabled/Disabled)
     version: Integer
 }
 

Parameters:

scanRulesetName - The scanRulesetName parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

deleteWithResponse

public Response<BinaryData> deleteWithResponse(String scanRulesetName,
 RequestOptions requestOptions)

Deletes a scan ruleset.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     id: String
     name: String
     scanRulesetType: String(Custom/System)
     status: String(Enabled/Disabled)
     version: Integer
 }
 

Parameters:

scanRulesetName - The scanRulesetName parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

listAll

public PagedIterable<BinaryData> listAll(RequestOptions requestOptions)

List scan rulesets in Data catalog.

Query Parameters

Query Parameters

Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema

 {
     value: [
         {
             id: String
             name: String
             scanRulesetType: String(Custom/System)
             status: String(Enabled/Disabled)
             version: Integer
         }
     ]
     nextLink: String
     count: Long
 }
 

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response.

Throws:

HttpResponseException - thrown if the request is rejected by server.