Class DataSafeClient

Service client instance for DataSafe.

Inheritance

object

ClientBase

RegionalClientBase

DataSafeClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class DataSafeClient : RegionalClientBase, IDisposable

Constructors

DataSafeClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public DataSafeClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public DataSafePaginators Paginators { get; }

Property Value

Type	Description
DataSafePaginators

Waiters

Declaration

public DataSafeWaiters Waiters { get; }

Property Value

Type	Description
DataSafeWaiters

Methods

ActivateTargetDatabase(ActivateTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Reactivates a previously deactivated Data Safe target database.

Declaration

public Task<ActivateTargetDatabaseResponse> ActivateTargetDatabase(ActivateTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ActivateTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ActivateTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ActivateTargetDatabase API.

AddMaskingColumnsFromSdm(AddMaskingColumnsFromSdmRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds columns to the specified masking policy from the associated sensitive data model. It automatically pulls all the sensitive columns and their relationships from the sensitive data model and uses this information to create columns in the masking policy. It also assigns default masking formats to these columns based on the associated sensitive types.

Declaration

public Task<AddMaskingColumnsFromSdmResponse> AddMaskingColumnsFromSdm(AddMaskingColumnsFromSdmRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddMaskingColumnsFromSdmRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AddMaskingColumnsFromSdmResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddMaskingColumnsFromSdm API.

AlertsUpdate(AlertsUpdateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates alerts in the specified compartment.

Declaration

public Task<AlertsUpdateResponse> AlertsUpdate(AlertsUpdateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AlertsUpdateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AlertsUpdateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AlertsUpdate API.

ApplyDiscoveryJobResults(ApplyDiscoveryJobResultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Applies the results of a discovery job to the specified sensitive data model. Note that the plannedAction attribute of discovery results is used for processing them. You should first use PatchDiscoveryJobResults to set the plannedAction attribute of the discovery results you want to process. ApplyDiscoveryJobResults automatically reads the plannedAction attribute and updates the sensitive data model to reflect the actions you planned.

Declaration

public Task<ApplyDiscoveryJobResultsResponse> ApplyDiscoveryJobResults(ApplyDiscoveryJobResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ApplyDiscoveryJobResultsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ApplyDiscoveryJobResultsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ApplyDiscoveryJobResults API.

ApplySdmMaskingPolicyDifference(ApplySdmMaskingPolicyDifferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Applies the difference of a SDM Masking policy difference resource to the specified masking policy. Note that the plannedAction attribute of difference columns is used for processing. You should first use PatchSdmMaskingPolicyDifferenceColumns to set the plannedAction attribute of the difference columns you want to process. ApplySdmMaskingPolicyDifference automatically reads the plannedAction attribute and updates the masking policy to reflect the actions you planned. If the sdmMaskingPolicydifferenceId is not passed, the latest sdmMaskingPolicydifference is used. Note that if the masking policy associated with the SdmMaskingPolicyDifference used for this operation is not associated with the original SDM anymore, this operation won't be allowed.

Declaration

public Task<ApplySdmMaskingPolicyDifferenceResponse> ApplySdmMaskingPolicyDifference(ApplySdmMaskingPolicyDifferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ApplySdmMaskingPolicyDifferenceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ApplySdmMaskingPolicyDifferenceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ApplySdmMaskingPolicyDifference API.

BulkCreateSqlFirewallAllowedSqls(BulkCreateSqlFirewallAllowedSqlsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Appends the allowedSqls with entries from the logs.

Declaration

public Task<BulkCreateSqlFirewallAllowedSqlsResponse> BulkCreateSqlFirewallAllowedSqls(BulkCreateSqlFirewallAllowedSqlsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
BulkCreateSqlFirewallAllowedSqlsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<BulkCreateSqlFirewallAllowedSqlsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use BulkCreateSqlFirewallAllowedSqls API.

BulkDeleteSqlFirewallAllowedSqls(BulkDeleteSqlFirewallAllowedSqlsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete multiple allowed sqls from the SQL firewall policy.

Declaration

public Task<BulkDeleteSqlFirewallAllowedSqlsResponse> BulkDeleteSqlFirewallAllowedSqls(BulkDeleteSqlFirewallAllowedSqlsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
BulkDeleteSqlFirewallAllowedSqlsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<BulkDeleteSqlFirewallAllowedSqlsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use BulkDeleteSqlFirewallAllowedSqls API.

CalculateAuditVolumeAvailable(CalculateAuditVolumeAvailableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Calculates the volume of audit events available on the target database to be collected. Measurable up to the defined retention period of the audit target resource.

Declaration

public Task<CalculateAuditVolumeAvailableResponse> CalculateAuditVolumeAvailable(CalculateAuditVolumeAvailableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CalculateAuditVolumeAvailableRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CalculateAuditVolumeAvailableResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CalculateAuditVolumeAvailable API.

CalculateAuditVolumeCollected(CalculateAuditVolumeCollectedRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Calculates the volume of audit events collected by data safe.

Declaration

public Task<CalculateAuditVolumeCollectedResponse> CalculateAuditVolumeCollected(CalculateAuditVolumeCollectedRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CalculateAuditVolumeCollectedRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CalculateAuditVolumeCollectedResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CalculateAuditVolumeCollected API.

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel the specified work request.

Declaration

public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CancelWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelWorkRequest API.

ChangeAlertCompartment(ChangeAlertCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified alert into a different compartment.

Declaration

public Task<ChangeAlertCompartmentResponse> ChangeAlertCompartment(ChangeAlertCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAlertCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeAlertCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAlertCompartment API.

ChangeAlertPolicyCompartment(ChangeAlertPolicyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified alert policy into a different compartment.

Declaration

public Task<ChangeAlertPolicyCompartmentResponse> ChangeAlertPolicyCompartment(ChangeAlertPolicyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAlertPolicyCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeAlertPolicyCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAlertPolicyCompartment API.

ChangeAuditArchiveRetrievalCompartment(ChangeAuditArchiveRetrievalCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the archive retreival to the specified compartment. When provided, if-Match is checked against ETag value of the resource.

Declaration

public Task<ChangeAuditArchiveRetrievalCompartmentResponse> ChangeAuditArchiveRetrievalCompartment(ChangeAuditArchiveRetrievalCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAuditArchiveRetrievalCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeAuditArchiveRetrievalCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAuditArchiveRetrievalCompartment API.

ChangeAuditPolicyCompartment(ChangeAuditPolicyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified audit policy and its dependent resources into a different compartment.

Declaration

public Task<ChangeAuditPolicyCompartmentResponse> ChangeAuditPolicyCompartment(ChangeAuditPolicyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAuditPolicyCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeAuditPolicyCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAuditPolicyCompartment API.

ChangeAuditProfileCompartment(ChangeAuditProfileCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified audit profile and its dependent resources into a different compartment.

Declaration

public Task<ChangeAuditProfileCompartmentResponse> ChangeAuditProfileCompartment(ChangeAuditProfileCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAuditProfileCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeAuditProfileCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAuditProfileCompartment API.

ChangeDataSafePrivateEndpointCompartment(ChangeDataSafePrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the Data Safe private endpoint and its dependent resources to the specified compartment.

Declaration

public Task<ChangeDataSafePrivateEndpointCompartmentResponse> ChangeDataSafePrivateEndpointCompartment(ChangeDataSafePrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDataSafePrivateEndpointCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeDataSafePrivateEndpointCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDataSafePrivateEndpointCompartment API.

ChangeDatabaseSecurityConfigCompartment(ChangeDatabaseSecurityConfigCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified database security configuration and its dependent resources into a different compartment.

Declaration

public Task<ChangeDatabaseSecurityConfigCompartmentResponse> ChangeDatabaseSecurityConfigCompartment(ChangeDatabaseSecurityConfigCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDatabaseSecurityConfigCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeDatabaseSecurityConfigCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDatabaseSecurityConfigCompartment API.

ChangeDiscoveryJobCompartment(ChangeDiscoveryJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified discovery job and its dependent resources into a different compartment.

Declaration

public Task<ChangeDiscoveryJobCompartmentResponse> ChangeDiscoveryJobCompartment(ChangeDiscoveryJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDiscoveryJobCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeDiscoveryJobCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDiscoveryJobCompartment API.

ChangeLibraryMaskingFormatCompartment(ChangeLibraryMaskingFormatCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified library masking format into a different compartment.

Declaration

public Task<ChangeLibraryMaskingFormatCompartmentResponse> ChangeLibraryMaskingFormatCompartment(ChangeLibraryMaskingFormatCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeLibraryMaskingFormatCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeLibraryMaskingFormatCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeLibraryMaskingFormatCompartment API.

ChangeMaskingPolicyCompartment(ChangeMaskingPolicyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified masking policy and its dependent resources into a different compartment.

Declaration

public Task<ChangeMaskingPolicyCompartmentResponse> ChangeMaskingPolicyCompartment(ChangeMaskingPolicyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeMaskingPolicyCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeMaskingPolicyCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeMaskingPolicyCompartment API.

ChangeMaskingPolicyHealthReportCompartment(ChangeMaskingPolicyHealthReportCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified masking policy health report and its dependent resources into a different compartment.

Declaration

public Task<ChangeMaskingPolicyHealthReportCompartmentResponse> ChangeMaskingPolicyHealthReportCompartment(ChangeMaskingPolicyHealthReportCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeMaskingPolicyHealthReportCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeMaskingPolicyHealthReportCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeMaskingPolicyHealthReportCompartment API.

ChangeOnPremConnectorCompartment(ChangeOnPremConnectorCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified on-premises connector into a different compartment.

Declaration

public Task<ChangeOnPremConnectorCompartmentResponse> ChangeOnPremConnectorCompartment(ChangeOnPremConnectorCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeOnPremConnectorCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeOnPremConnectorCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeOnPremConnectorCompartment API.

ChangeReportCompartment(ChangeReportCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeReportCompartmentResponse> ChangeReportCompartment(ChangeReportCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeReportCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeReportCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeReportCompartment API.

ChangeReportDefinitionCompartment(ChangeReportDefinitionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeReportDefinitionCompartmentResponse> ChangeReportDefinitionCompartment(ChangeReportDefinitionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeReportDefinitionCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeReportDefinitionCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeReportDefinitionCompartment API.

ChangeRetention(ChangeRetentionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change the online and offline months .

Declaration

public Task<ChangeRetentionResponse> ChangeRetention(ChangeRetentionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeRetentionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeRetentionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeRetention API.

ChangeSdmMaskingPolicyDifferenceCompartment(ChangeSdmMaskingPolicyDifferenceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified SDM masking policy difference into a different compartment.

Declaration

public Task<ChangeSdmMaskingPolicyDifferenceCompartmentResponse> ChangeSdmMaskingPolicyDifferenceCompartment(ChangeSdmMaskingPolicyDifferenceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSdmMaskingPolicyDifferenceCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSdmMaskingPolicyDifferenceCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSdmMaskingPolicyDifferenceCompartment API.

ChangeSecurityAssessmentCompartment(ChangeSecurityAssessmentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified saved security assessment or future scheduled assessments into a different compartment. <br/> To start, call first the operation ListSecurityAssessments with filters "type = save_schedule". This returns the scheduleAssessmentId. Then, call this changeCompartment with the scheduleAssessmentId. <br/> The existing saved security assessments created due to the schedule are not moved. However, all new saves will be associated with the new compartment.

Declaration

public Task<ChangeSecurityAssessmentCompartmentResponse> ChangeSecurityAssessmentCompartment(ChangeSecurityAssessmentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSecurityAssessmentCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSecurityAssessmentCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSecurityAssessmentCompartment API.

ChangeSecurityPolicyCompartment(ChangeSecurityPolicyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified security policy and its dependent resources into a different compartment.

Declaration

public Task<ChangeSecurityPolicyCompartmentResponse> ChangeSecurityPolicyCompartment(ChangeSecurityPolicyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSecurityPolicyCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSecurityPolicyCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSecurityPolicyCompartment API.

ChangeSecurityPolicyDeploymentCompartment(ChangeSecurityPolicyDeploymentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified security policy deployment and its dependent resources into a different compartment.

Declaration

public Task<ChangeSecurityPolicyDeploymentCompartmentResponse> ChangeSecurityPolicyDeploymentCompartment(ChangeSecurityPolicyDeploymentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSecurityPolicyDeploymentCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSecurityPolicyDeploymentCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSecurityPolicyDeploymentCompartment API.

ChangeSensitiveDataModelCompartment(ChangeSensitiveDataModelCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified sensitive data model and its dependent resources into a different compartment.

Declaration

public Task<ChangeSensitiveDataModelCompartmentResponse> ChangeSensitiveDataModelCompartment(ChangeSensitiveDataModelCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSensitiveDataModelCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSensitiveDataModelCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSensitiveDataModelCompartment API.

ChangeSensitiveTypeCompartment(ChangeSensitiveTypeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified sensitive type into a different compartment.

Declaration

public Task<ChangeSensitiveTypeCompartmentResponse> ChangeSensitiveTypeCompartment(ChangeSensitiveTypeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSensitiveTypeCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSensitiveTypeCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSensitiveTypeCompartment API.

ChangeSqlCollectionCompartment(ChangeSqlCollectionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified SQL collection and its dependent resources into a different compartment.

Declaration

public Task<ChangeSqlCollectionCompartmentResponse> ChangeSqlCollectionCompartment(ChangeSqlCollectionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSqlCollectionCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSqlCollectionCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSqlCollectionCompartment API.

ChangeSqlFirewallPolicyCompartment(ChangeSqlFirewallPolicyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified SQL Firewall policy and its dependent resources into a different compartment.

Declaration

public Task<ChangeSqlFirewallPolicyCompartmentResponse> ChangeSqlFirewallPolicyCompartment(ChangeSqlFirewallPolicyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSqlFirewallPolicyCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeSqlFirewallPolicyCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSqlFirewallPolicyCompartment API.

ChangeTargetAlertPolicyAssociationCompartment(ChangeTargetAlertPolicyAssociationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified target-alert policy Association into a different compartment.

Declaration

public Task<ChangeTargetAlertPolicyAssociationCompartmentResponse> ChangeTargetAlertPolicyAssociationCompartment(ChangeTargetAlertPolicyAssociationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeTargetAlertPolicyAssociationCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeTargetAlertPolicyAssociationCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeTargetAlertPolicyAssociationCompartment API.

ChangeTargetDatabaseCompartment(ChangeTargetDatabaseCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the Data Safe target database to the specified compartment.

Declaration

public Task<ChangeTargetDatabaseCompartmentResponse> ChangeTargetDatabaseCompartment(ChangeTargetDatabaseCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeTargetDatabaseCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeTargetDatabaseCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeTargetDatabaseCompartment API.

ChangeUserAssessmentCompartment(ChangeUserAssessmentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified saved user assessment or future scheduled assessments into a different compartment. To start storing scheduled user assessments on a different compartment, first call the operation ListUserAssessments with the filters "type = save_schedule". That call returns the scheduleAssessmentId. Then call ChangeUserAssessmentCompartment with the scheduleAssessmentId. The existing saved user assessments created per the schedule are not be moved. However, all new saves will be associated with the new compartment.

Declaration

public Task<ChangeUserAssessmentCompartmentResponse> ChangeUserAssessmentCompartment(ChangeUserAssessmentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeUserAssessmentCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeUserAssessmentCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeUserAssessmentCompartment API.

CompareSecurityAssessment(CompareSecurityAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Compares two security assessments. For this comparison, a security assessment can be a saved assessment, a latest assessment, or a baseline assessment. For example, you can compare saved assessment or a latest assessment against a baseline.

Declaration

public Task<CompareSecurityAssessmentResponse> CompareSecurityAssessment(CompareSecurityAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CompareSecurityAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CompareSecurityAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CompareSecurityAssessment API.

CompareUserAssessment(CompareUserAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Compares two user assessments. For this comparison, a user assessment can be a saved, a latest assessment, or a baseline. As an example, it can be used to compare a user assessment saved or a latest assessment with a baseline.

Declaration

public Task<CompareUserAssessmentResponse> CompareUserAssessment(CompareUserAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CompareUserAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CompareUserAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CompareUserAssessment API.

CreateAlertPolicy(CreateAlertPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new user-defined alert policy.

Declaration

public Task<CreateAlertPolicyResponse> CreateAlertPolicy(CreateAlertPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAlertPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateAlertPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAlertPolicy API.

CreateAlertPolicyRule(CreateAlertPolicyRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new rule for the alert policy.

Declaration

public Task<CreateAlertPolicyRuleResponse> CreateAlertPolicyRule(CreateAlertPolicyRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAlertPolicyRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateAlertPolicyRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAlertPolicyRule API.

CreateAuditArchiveRetrieval(CreateAuditArchiveRetrievalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a work request to retrieve archived audit data. This asynchronous process will usually take over an hour to complete. Save the id from the response of this operation. Call GetAuditArchiveRetrieval operation after an hour, passing the id to know the status of this operation.

Declaration

public Task<CreateAuditArchiveRetrievalResponse> CreateAuditArchiveRetrieval(CreateAuditArchiveRetrievalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAuditArchiveRetrievalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateAuditArchiveRetrievalResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAuditArchiveRetrieval API.

CreateDataSafePrivateEndpoint(CreateDataSafePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Data Safe private endpoint.

Declaration

public Task<CreateDataSafePrivateEndpointResponse> CreateDataSafePrivateEndpoint(CreateDataSafePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDataSafePrivateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDataSafePrivateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDataSafePrivateEndpoint API.

CreateDiscoveryJob(CreateDiscoveryJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Performs incremental data discovery for the specified sensitive data model. It uses the target database associated with the sensitive data model. After performing data discovery, you can use ListDiscoveryJobResults to view the discovery results, PatchDiscoveryJobResults to specify the action you want perform on these results, and then ApplyDiscoveryJobResults to process the results and apply them to the sensitive data model.

Declaration

public Task<CreateDiscoveryJobResponse> CreateDiscoveryJob(CreateDiscoveryJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDiscoveryJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDiscoveryJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDiscoveryJob API.

CreateLibraryMaskingFormat(CreateLibraryMaskingFormatRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new library masking format. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking. Note that you cannot define masking condition in a library masking format.

Declaration

public Task<CreateLibraryMaskingFormatResponse> CreateLibraryMaskingFormat(CreateLibraryMaskingFormatRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateLibraryMaskingFormatRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateLibraryMaskingFormatResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateLibraryMaskingFormat API.

CreateMaskingColumn(CreateMaskingColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new masking column in the specified masking policy. Use this operation to add parent columns only. It automatically adds the child columns from the associated sensitive data model or target database. If you provide the sensitiveTypeId attribute but not the maskingFormats attribute, it automatically assigns the default masking format associated with the specified sensitive type. Alternatively, if you provide the maskingFormats attribute, the specified masking formats are assigned to the column. <br/> Using the maskingFormats attribute, you can assign one or more masking formats to a column. You need to specify a condition as part of each masking format. It enables you to do <a href="https://docs.oracle.com/en/cloud/paas/data-safe/udscs/conditional-masking.html">conditional masking</a> so that you can mask the column data values differently using different masking conditions. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking. <br/> You can use the maskingColumnGroup attribute to group the columns that you would like to mask together. It enables you to do <a href="https://docs.oracle.com/en/cloud/paas/data-safe/udscs/group-masking1.html#GUID-755056B9-9540-48C0-9491-262A44A85037">group or compound masking</a> that ensures that the masked data across the columns in a group continue to retain the same logical relationship.

Declaration

public Task<CreateMaskingColumnResponse> CreateMaskingColumn(CreateMaskingColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMaskingColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMaskingColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMaskingColumn API.

CreateMaskingPolicy(CreateMaskingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new masking policy and associates it with a sensitive data model or a target database. <br/> To use a sensitive data model as the source of masking columns, set the columnSource attribute to SENSITIVE_DATA_MODEL and provide the sensitiveDataModelId attribute. After creating a masking policy, you can use the AddMaskingColumnsFromSdm operation to automatically add all the columns from the associated sensitive data model. In this case, the target database associated with the sensitive data model is used for column and masking format validations. <br/> You can also create a masking policy without using a sensitive data model. In this case, you need to associate your masking policy with a target database by setting the columnSource attribute to TARGET and providing the targetId attribute. The specified target database is used for column and masking format validations. <br/> After creating a masking policy, you can use the CreateMaskingColumn or PatchMaskingColumns operation to manually add columns to the policy. You need to add the parent columns only, and it automatically adds the child columns (in referential relationship with the parent columns) from the associated sensitive data model or target database.

Declaration

public Task<CreateMaskingPolicyResponse> CreateMaskingPolicy(CreateMaskingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMaskingPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMaskingPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMaskingPolicy API.

CreateOnPremConnector(CreateOnPremConnectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new on-premises connector.

Declaration

public Task<CreateOnPremConnectorResponse> CreateOnPremConnector(CreateOnPremConnectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOnPremConnectorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateOnPremConnectorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOnPremConnector API.

CreatePeerTargetDatabase(CreatePeerTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates the peer target database under the primary target database in Data Safe.

Declaration

public Task<CreatePeerTargetDatabaseResponse> CreatePeerTargetDatabase(CreatePeerTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreatePeerTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreatePeerTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreatePeerTargetDatabase API.

CreateReportDefinition(CreateReportDefinitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new report definition with parameters specified in the body. The report definition is stored in the specified compartment.

Declaration

public Task<CreateReportDefinitionResponse> CreateReportDefinition(CreateReportDefinitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateReportDefinitionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateReportDefinitionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateReportDefinition API.

CreateSdmMaskingPolicyDifference(CreateSdmMaskingPolicyDifferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates SDM masking policy difference for the specified masking policy. It finds the difference between masking columns of the masking policy and sensitive columns of the SDM. After performing this operation, you can use ListDifferenceColumns to view the difference columns, PatchSdmMaskingPolicyDifferenceColumns to specify the action you want perform on these columns, and then ApplySdmMaskingPolicyDifference to process the difference columns and apply them to the masking policy.

Declaration

public Task<CreateSdmMaskingPolicyDifferenceResponse> CreateSdmMaskingPolicyDifference(CreateSdmMaskingPolicyDifferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSdmMaskingPolicyDifferenceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSdmMaskingPolicyDifferenceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSdmMaskingPolicyDifference API.

CreateSecurityAssessment(CreateSecurityAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new saved security assessment for one or multiple targets in a compartment. When this operation is performed, it will save the latest assessments in the specified compartment. If a schedule is passed, it will persist the latest assessments, at the defined date and time, in the format defined by RFC3339.

Declaration

public Task<CreateSecurityAssessmentResponse> CreateSecurityAssessment(CreateSecurityAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSecurityAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSecurityAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSecurityAssessment API.

CreateSensitiveColumn(CreateSensitiveColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new sensitive column in the specified sensitive data model.

Declaration

public Task<CreateSensitiveColumnResponse> CreateSensitiveColumn(CreateSensitiveColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSensitiveColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSensitiveColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSensitiveColumn API.

CreateSensitiveDataModel(CreateSensitiveDataModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model that can be updated later.

Declaration

public Task<CreateSensitiveDataModelResponse> CreateSensitiveDataModel(CreateSensitiveDataModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSensitiveDataModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSensitiveDataModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSensitiveDataModel API.

CreateSensitiveType(CreateSensitiveTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new sensitive type, which can be a basic sensitive type with regular expressions or a sensitive category. While sensitive types are used for data discovery, sensitive categories are used for logically grouping the related or similar sensitive types.

Declaration

public Task<CreateSensitiveTypeResponse> CreateSensitiveType(CreateSensitiveTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSensitiveTypeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSensitiveTypeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSensitiveType API.

CreateSqlCollection(CreateSqlCollectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new SQL collection resource.

Declaration

public Task<CreateSqlCollectionResponse> CreateSqlCollection(CreateSqlCollectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSqlCollectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSqlCollectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSqlCollection API.

CreateTargetAlertPolicyAssociation(CreateTargetAlertPolicyAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new target-alert policy association to track a alert policy applied on target.

Declaration

public Task<CreateTargetAlertPolicyAssociationResponse> CreateTargetAlertPolicyAssociation(CreateTargetAlertPolicyAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateTargetAlertPolicyAssociationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateTargetAlertPolicyAssociationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateTargetAlertPolicyAssociation API.

CreateTargetDatabase(CreateTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Registers the specified database with Data Safe and creates a Data Safe target database in the Data Safe Console.

Declaration

public Task<CreateTargetDatabaseResponse> CreateTargetDatabase(CreateTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateTargetDatabase API.

CreateUserAssessment(CreateUserAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new saved user assessment for one or multiple targets in a compartment. It saves the latest assessments in the specified compartment. If a scheduled is passed in, this operation persists the latest assessments that exist at the defined date and time, in the format defined by RFC3339.

Declaration

public Task<CreateUserAssessmentResponse> CreateUserAssessment(CreateUserAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateUserAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateUserAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateUserAssessment API.

DeactivateTargetDatabase(DeactivateTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deactivates a target database in Data Safe.

Declaration

public Task<DeactivateTargetDatabaseResponse> DeactivateTargetDatabase(DeactivateTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeactivateTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeactivateTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeactivateTargetDatabase API.

DeleteAlertPolicy(DeleteAlertPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified user-defined alert policy.

Declaration

public Task<DeleteAlertPolicyResponse> DeleteAlertPolicy(DeleteAlertPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAlertPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteAlertPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAlertPolicy API.

DeleteAlertPolicyRule(DeleteAlertPolicyRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified user-defined alert policy rule.

Declaration

public Task<DeleteAlertPolicyRuleResponse> DeleteAlertPolicyRule(DeleteAlertPolicyRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAlertPolicyRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteAlertPolicyRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAlertPolicyRule API.

DeleteAuditArchiveRetrieval(DeleteAuditArchiveRetrievalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

To unload retrieved archive data, call the operation ListAuditArchiveRetrieval first. This will return the auditArchiveRetrievalId. Then call this operation with auditArchiveRetrievalId.

Declaration

public Task<DeleteAuditArchiveRetrievalResponse> DeleteAuditArchiveRetrieval(DeleteAuditArchiveRetrievalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAuditArchiveRetrievalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteAuditArchiveRetrievalResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAuditArchiveRetrieval API.

DeleteAuditTrail(DeleteAuditTrailRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified audit trail.

Declaration

public Task<DeleteAuditTrailResponse> DeleteAuditTrail(DeleteAuditTrailRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAuditTrailRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteAuditTrailResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAuditTrail API.

DeleteDataSafePrivateEndpoint(DeleteDataSafePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified Data Safe private endpoint.

Declaration

public Task<DeleteDataSafePrivateEndpointResponse> DeleteDataSafePrivateEndpoint(DeleteDataSafePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDataSafePrivateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDataSafePrivateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDataSafePrivateEndpoint API.

DeleteDiscoveryJob(DeleteDiscoveryJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified discovery job.

Declaration

public Task<DeleteDiscoveryJobResponse> DeleteDiscoveryJob(DeleteDiscoveryJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDiscoveryJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDiscoveryJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDiscoveryJob API.

DeleteDiscoveryJobResult(DeleteDiscoveryJobResultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified discovery result.

Declaration

public Task<DeleteDiscoveryJobResultResponse> DeleteDiscoveryJobResult(DeleteDiscoveryJobResultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDiscoveryJobResultRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDiscoveryJobResultResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDiscoveryJobResult API.

DeleteLibraryMaskingFormat(DeleteLibraryMaskingFormatRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified library masking format.

Declaration

public Task<DeleteLibraryMaskingFormatResponse> DeleteLibraryMaskingFormat(DeleteLibraryMaskingFormatRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteLibraryMaskingFormatRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteLibraryMaskingFormatResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteLibraryMaskingFormat API.

DeleteMaskingColumn(DeleteMaskingColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified masking column.

Declaration

public Task<DeleteMaskingColumnResponse> DeleteMaskingColumn(DeleteMaskingColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMaskingColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMaskingColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMaskingColumn API.

DeleteMaskingPolicy(DeleteMaskingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified masking policy.

Declaration

public Task<DeleteMaskingPolicyResponse> DeleteMaskingPolicy(DeleteMaskingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMaskingPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMaskingPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMaskingPolicy API.

DeleteMaskingPolicyHealthReport(DeleteMaskingPolicyHealthReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified masking policy health report.

Declaration

public Task<DeleteMaskingPolicyHealthReportResponse> DeleteMaskingPolicyHealthReport(DeleteMaskingPolicyHealthReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMaskingPolicyHealthReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMaskingPolicyHealthReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMaskingPolicyHealthReport API.

DeleteOnPremConnector(DeleteOnPremConnectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified on-premises connector.

Declaration

public Task<DeleteOnPremConnectorResponse> DeleteOnPremConnector(DeleteOnPremConnectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOnPremConnectorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteOnPremConnectorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOnPremConnector API.

DeletePeerTargetDatabase(DeletePeerTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes the specified peer target database from Data Safe.

Declaration

public Task<DeletePeerTargetDatabaseResponse> DeletePeerTargetDatabase(DeletePeerTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeletePeerTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeletePeerTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeletePeerTargetDatabase API.

DeleteReportDefinition(DeleteReportDefinitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified report definition. Only the user created report definition can be deleted. The seeded report definitions cannot be deleted.

Declaration

public Task<DeleteReportDefinitionResponse> DeleteReportDefinition(DeleteReportDefinitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteReportDefinitionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteReportDefinitionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteReportDefinition API.

DeleteSdmMaskingPolicyDifference(DeleteSdmMaskingPolicyDifferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified SDM Masking policy difference.

Declaration

public Task<DeleteSdmMaskingPolicyDifferenceResponse> DeleteSdmMaskingPolicyDifference(DeleteSdmMaskingPolicyDifferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSdmMaskingPolicyDifferenceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSdmMaskingPolicyDifferenceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSdmMaskingPolicyDifference API.

DeleteSecurityAssessment(DeleteSecurityAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified saved security assessment or schedule. To delete a security assessment schedule, first call the operation ListSecurityAssessments with filters "type = save_schedule". That operation returns the scheduleAssessmentId. Then, call DeleteSecurityAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.

Declaration

public Task<DeleteSecurityAssessmentResponse> DeleteSecurityAssessment(DeleteSecurityAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSecurityAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSecurityAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSecurityAssessment API.

DeleteSensitiveColumn(DeleteSensitiveColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified sensitive column.

Declaration

public Task<DeleteSensitiveColumnResponse> DeleteSensitiveColumn(DeleteSensitiveColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSensitiveColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSensitiveColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSensitiveColumn API.

DeleteSensitiveDataModel(DeleteSensitiveDataModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified sensitive data model.

Declaration

public Task<DeleteSensitiveDataModelResponse> DeleteSensitiveDataModel(DeleteSensitiveDataModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSensitiveDataModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSensitiveDataModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSensitiveDataModel API.

DeleteSensitiveType(DeleteSensitiveTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified sensitive type.

Declaration

public Task<DeleteSensitiveTypeResponse> DeleteSensitiveType(DeleteSensitiveTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSensitiveTypeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSensitiveTypeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSensitiveType API.

DeleteSqlCollection(DeleteSqlCollectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified SQL collection.

Declaration

public Task<DeleteSqlCollectionResponse> DeleteSqlCollection(DeleteSqlCollectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSqlCollectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSqlCollectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSqlCollection API.

DeleteSqlFirewallAllowedSql(DeleteSqlFirewallAllowedSqlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified allowed sql.

Declaration

public Task<DeleteSqlFirewallAllowedSqlResponse> DeleteSqlFirewallAllowedSql(DeleteSqlFirewallAllowedSqlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSqlFirewallAllowedSqlRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSqlFirewallAllowedSqlResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSqlFirewallAllowedSql API.

DeleteSqlFirewallPolicy(DeleteSqlFirewallPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the SQL Firewall policy resource.

Declaration

public Task<DeleteSqlFirewallPolicyResponse> DeleteSqlFirewallPolicy(DeleteSqlFirewallPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSqlFirewallPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSqlFirewallPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSqlFirewallPolicy API.

DeleteTargetAlertPolicyAssociation(DeleteTargetAlertPolicyAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified target-alert policy Association.

Declaration

public Task<DeleteTargetAlertPolicyAssociationResponse> DeleteTargetAlertPolicyAssociation(DeleteTargetAlertPolicyAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteTargetAlertPolicyAssociationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteTargetAlertPolicyAssociationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteTargetAlertPolicyAssociation API.

DeleteTargetDatabase(DeleteTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deregisters the specified database from Data Safe and removes the target database from the Data Safe Console.

Declaration

public Task<DeleteTargetDatabaseResponse> DeleteTargetDatabase(DeleteTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteTargetDatabase API.

DeleteUserAssessment(DeleteUserAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified saved user assessment or schedule. To delete a user assessment schedule, first call the operation ListUserAssessments with filters "type = save_schedule". That call returns the scheduleAssessmentId. Then call DeleteUserAssessment with the scheduleAssessmentId. If the assessment being deleted is the baseline for that compartment, then it will impact all baselines in the compartment.

Declaration

public Task<DeleteUserAssessmentResponse> DeleteUserAssessment(DeleteUserAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteUserAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteUserAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteUserAssessment API.

DiscoverAuditTrails(DiscoverAuditTrailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the list of audit trails created under audit profile.The operation can be used to create new audit trails for target database when they become available for audit collection because of change of database version or change of database unified mode or change of data base edition or being deleted previously etc.

Declaration

public Task<DiscoverAuditTrailsResponse> DiscoverAuditTrails(DiscoverAuditTrailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DiscoverAuditTrailsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DiscoverAuditTrailsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DiscoverAuditTrails API.

DownloadDiscoveryReport(DownloadDiscoveryReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads an already-generated discovery report. Note that the GenerateDiscoveryReportForDownload operation is a prerequisite for the DownloadDiscoveryReport operation. Use GenerateDiscoveryReportForDownload to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file. By default, it downloads report for all the columns in a sensitive data model. Use the discoveryJobId attribute to download report for a specific discovery job.

Declaration

public Task<DownloadDiscoveryReportResponse> DownloadDiscoveryReport(DownloadDiscoveryReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DownloadDiscoveryReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DownloadDiscoveryReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DownloadDiscoveryReport API.

DownloadMaskingLog(DownloadMaskingLogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads the masking log generated by the last masking operation on a target database using the specified masking policy.

Declaration

public Task<DownloadMaskingLogResponse> DownloadMaskingLog(DownloadMaskingLogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DownloadMaskingLogRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DownloadMaskingLogResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DownloadMaskingLog API.

DownloadMaskingPolicy(DownloadMaskingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads an already-generated file corresponding to the specified masking policy. Note that the GenerateMaskingPolicyForDownload operation is a prerequisite for the DownloadMaskingPolicy operation. Use GenerateMaskingPolicyForDownload to generate a masking policy file and then use DownloadMaskingPolicy to download the generated file.

Declaration

public Task<DownloadMaskingPolicyResponse> DownloadMaskingPolicy(DownloadMaskingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DownloadMaskingPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DownloadMaskingPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DownloadMaskingPolicy API.

DownloadMaskingReport(DownloadMaskingReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads an already-generated masking report. Note that the GenerateMaskingReportForDownload operation is a prerequisite for the DownloadMaskingReport operation. Use GenerateMaskingReportForDownload to generate a masking report file and then use DownloadMaskingReport to download the generated file.

Declaration

public Task<DownloadMaskingReportResponse> DownloadMaskingReport(DownloadMaskingReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DownloadMaskingReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DownloadMaskingReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DownloadMaskingReport API.

DownloadPrivilegeScript(DownloadPrivilegeScriptRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.

Declaration

public Task<DownloadPrivilegeScriptResponse> DownloadPrivilegeScript(DownloadPrivilegeScriptRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DownloadPrivilegeScriptRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DownloadPrivilegeScriptResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DownloadPrivilegeScript API.

DownloadSecurityAssessmentReport(DownloadSecurityAssessmentReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads the report of the specified security assessment. To download the security assessment report, it needs to be generated first. Please use GenerateSecurityAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).

Declaration

public Task<DownloadSecurityAssessmentReportResponse> DownloadSecurityAssessmentReport(DownloadSecurityAssessmentReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DownloadSecurityAssessmentReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DownloadSecurityAssessmentReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DownloadSecurityAssessmentReport API.

DownloadSensitiveDataModel(DownloadSensitiveDataModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads an already-generated file corresponding to the specified sensitive data model. Note that the GenerateSensitiveDataModelForDownload operation is a prerequisite for the DownloadSensitiveDataModel operation. Use GenerateSensitiveDataModelForDownload to generate a data model file and then use DownloadSensitiveDataModel to download the generated file.

Declaration

public Task<DownloadSensitiveDataModelResponse> DownloadSensitiveDataModel(DownloadSensitiveDataModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DownloadSensitiveDataModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DownloadSensitiveDataModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DownloadSensitiveDataModel API.

DownloadUserAssessmentReport(DownloadUserAssessmentReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads the report of the specified user assessment. To download the user assessment report, it needs to be generated first. Please use GenerateUserAssessmentReport to generate a downloadable report in the preferred format (PDF, XLS).

Declaration

public Task<DownloadUserAssessmentReportResponse> DownloadUserAssessmentReport(DownloadUserAssessmentReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DownloadUserAssessmentReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DownloadUserAssessmentReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DownloadUserAssessmentReport API.

EnableDataSafeConfiguration(EnableDataSafeConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Enables Data Safe in the tenancy and region.

Declaration

public Task<EnableDataSafeConfigurationResponse> EnableDataSafeConfiguration(EnableDataSafeConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
EnableDataSafeConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<EnableDataSafeConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use EnableDataSafeConfiguration API.

GenerateDiscoveryReportForDownload(GenerateDiscoveryReportForDownloadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates a downloadable discovery report. It's a prerequisite for the DownloadDiscoveryReport operation. Use this endpoint to generate a discovery report file and then use DownloadDiscoveryReport to download the generated file. By default, it generates report for all the columns in a sensitive data model. Use the discoveryJobId attribute to generate report for a specific discovery job.

Declaration

public Task<GenerateDiscoveryReportForDownloadResponse> GenerateDiscoveryReportForDownload(GenerateDiscoveryReportForDownloadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateDiscoveryReportForDownloadRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateDiscoveryReportForDownloadResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateDiscoveryReportForDownload API.

GenerateHealthReport(GenerateHealthReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Performs health check on the masking policy.

Declaration

public Task<GenerateHealthReportResponse> GenerateHealthReport(GenerateHealthReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateHealthReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateHealthReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateHealthReport API.

GenerateMaskingPolicyForDownload(GenerateMaskingPolicyForDownloadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates a downloadable file corresponding to the specified masking policy. It's a prerequisite for the DownloadMaskingPolicy operation. Use this endpoint to generate a masking policy file and then use DownloadMaskingPolicy to download the generated file. Note that file generation and download are serial operations. The download operation can't be invoked while the generate operation is in progress.

Declaration

public Task<GenerateMaskingPolicyForDownloadResponse> GenerateMaskingPolicyForDownload(GenerateMaskingPolicyForDownloadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateMaskingPolicyForDownloadRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateMaskingPolicyForDownloadResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateMaskingPolicyForDownload API.

GenerateMaskingReportForDownload(GenerateMaskingReportForDownloadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates a downloadable masking report. It's a prerequisite for the DownloadMaskingReport operation. Use this endpoint to generate a masking report file and then use DownloadMaskingReport to download the generated file.

Declaration

public Task<GenerateMaskingReportForDownloadResponse> GenerateMaskingReportForDownload(GenerateMaskingReportForDownloadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateMaskingReportForDownloadRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateMaskingReportForDownloadResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateMaskingReportForDownload API.

GenerateOnPremConnectorConfiguration(GenerateOnPremConnectorConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates and downloads the configuration of the specified on-premises connector.

Declaration

public Task<GenerateOnPremConnectorConfigurationResponse> GenerateOnPremConnectorConfiguration(GenerateOnPremConnectorConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateOnPremConnectorConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateOnPremConnectorConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateOnPremConnectorConfiguration API.

GenerateReport(GenerateReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates a .xls or .pdf report based on parameters and report definition.

Declaration

public Task<GenerateReportResponse> GenerateReport(GenerateReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateReport API.

GenerateSecurityAssessmentReport(GenerateSecurityAssessmentReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates the report of the specified security assessment. You can get the report in PDF or XLS format. After generating the report, use DownloadSecurityAssessmentReport to download it in the preferred format.

Declaration

public Task<GenerateSecurityAssessmentReportResponse> GenerateSecurityAssessmentReport(GenerateSecurityAssessmentReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateSecurityAssessmentReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateSecurityAssessmentReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateSecurityAssessmentReport API.

GenerateSensitiveDataModelForDownload(GenerateSensitiveDataModelForDownloadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates a downloadable file corresponding to the specified sensitive data model. It's a prerequisite for the DownloadSensitiveDataModel operation. Use this endpoint to generate a data model file and then use DownloadSensitiveDataModel to download the generated file. Note that file generation and download are serial operations. The download operation can't be invoked while the generate operation is in progress.

Declaration

public Task<GenerateSensitiveDataModelForDownloadResponse> GenerateSensitiveDataModelForDownload(GenerateSensitiveDataModelForDownloadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateSensitiveDataModelForDownloadRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateSensitiveDataModelForDownloadResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateSensitiveDataModelForDownload API.

GenerateSqlFirewallPolicy(GenerateSqlFirewallPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates or appends to the SQL Firewall policy using the specified SQL collection.

Declaration

public Task<GenerateSqlFirewallPolicyResponse> GenerateSqlFirewallPolicy(GenerateSqlFirewallPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateSqlFirewallPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateSqlFirewallPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateSqlFirewallPolicy API.

GenerateUserAssessmentReport(GenerateUserAssessmentReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates the report of the specified user assessment. The report is available in PDF or XLS format. After generating the report, use DownloadUserAssessmentReport to download it in the preferred format.

Declaration

public Task<GenerateUserAssessmentReportResponse> GenerateUserAssessmentReport(GenerateUserAssessmentReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateUserAssessmentReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateUserAssessmentReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateUserAssessmentReport API.

GetAlert(GetAlertRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified alerts.

Declaration

public Task<GetAlertResponse> GetAlert(GetAlertRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAlertRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAlertResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAlert API.

GetAlertPolicy(GetAlertPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of alert policy by its ID.

Declaration

public Task<GetAlertPolicyResponse> GetAlertPolicy(GetAlertPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAlertPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAlertPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAlertPolicy API.

GetAlertPolicyRule(GetAlertPolicyRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a policy rule by its key.

Declaration

public Task<GetAlertPolicyRuleResponse> GetAlertPolicyRule(GetAlertPolicyRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAlertPolicyRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAlertPolicyRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAlertPolicyRule API.

GetAuditArchiveRetrieval(GetAuditArchiveRetrievalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified archive retreival.

Declaration

public Task<GetAuditArchiveRetrievalResponse> GetAuditArchiveRetrieval(GetAuditArchiveRetrievalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAuditArchiveRetrievalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAuditArchiveRetrievalResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAuditArchiveRetrieval API.

GetAuditPolicy(GetAuditPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a audit policy by identifier.

Declaration

public Task<GetAuditPolicyResponse> GetAuditPolicy(GetAuditPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAuditPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAuditPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAuditPolicy API.

GetAuditProfile(GetAuditProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of audit profile resource and associated audit trails of the audit profile.

Declaration

public Task<GetAuditProfileResponse> GetAuditProfile(GetAuditProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAuditProfileRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAuditProfileResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAuditProfile API.

GetAuditTrail(GetAuditTrailRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of audit trail.

Declaration

public Task<GetAuditTrailResponse> GetAuditTrail(GetAuditTrailRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAuditTrailRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAuditTrailResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAuditTrail API.

GetCompatibleFormatsForDataTypes(GetCompatibleFormatsForDataTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of basic masking formats compatible with the supported data types. The data types are grouped into the following categories - Character - Includes CHAR, NCHAR, VARCHAR2, and NVARCHAR2 Numeric - Includes NUMBER, FLOAT, RAW, BINARY_FLOAT, and BINARY_DOUBLE Date - Includes DATE and TIMESTAMP LOB - Includes BLOB, CLOB, and NCLOB All - Includes all the supported data types

Declaration

public Task<GetCompatibleFormatsForDataTypesResponse> GetCompatibleFormatsForDataTypes(GetCompatibleFormatsForDataTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCompatibleFormatsForDataTypesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetCompatibleFormatsForDataTypesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCompatibleFormatsForDataTypes API.

GetCompatibleFormatsForSensitiveTypes(GetCompatibleFormatsForSensitiveTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of library masking formats compatible with the existing sensitive types. For each sensitive type, it returns the assigned default masking format as well as the other library masking formats that have the sensitiveTypeIds attribute containing the OCID of the sensitive type.

Declaration

public Task<GetCompatibleFormatsForSensitiveTypesResponse> GetCompatibleFormatsForSensitiveTypes(GetCompatibleFormatsForSensitiveTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCompatibleFormatsForSensitiveTypesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetCompatibleFormatsForSensitiveTypesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCompatibleFormatsForSensitiveTypes API.

GetDataSafeConfiguration(GetDataSafeConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the Data Safe configuration.

Declaration

public Task<GetDataSafeConfigurationResponse> GetDataSafeConfiguration(GetDataSafeConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDataSafeConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDataSafeConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDataSafeConfiguration API.

GetDataSafePrivateEndpoint(GetDataSafePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified Data Safe private endpoint.

Declaration

public Task<GetDataSafePrivateEndpointResponse> GetDataSafePrivateEndpoint(GetDataSafePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDataSafePrivateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDataSafePrivateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDataSafePrivateEndpoint API.

GetDatabaseSecurityConfig(GetDatabaseSecurityConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a database security configuration by identifier.

Declaration

public Task<GetDatabaseSecurityConfigResponse> GetDatabaseSecurityConfig(GetDatabaseSecurityConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDatabaseSecurityConfigRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDatabaseSecurityConfigResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDatabaseSecurityConfig API.

GetDatabaseTableAccessEntry(GetDatabaseTableAccessEntryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a database table access entry object by identifier.

Declaration

public Task<GetDatabaseTableAccessEntryResponse> GetDatabaseTableAccessEntry(GetDatabaseTableAccessEntryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDatabaseTableAccessEntryRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDatabaseTableAccessEntryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDatabaseTableAccessEntry API.

GetDatabaseViewAccessEntry(GetDatabaseViewAccessEntryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a database view access object by identifier.

Declaration

public Task<GetDatabaseViewAccessEntryResponse> GetDatabaseViewAccessEntry(GetDatabaseViewAccessEntryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDatabaseViewAccessEntryRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDatabaseViewAccessEntryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDatabaseViewAccessEntry API.

GetDifferenceColumn(GetDifferenceColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified SDM Masking policy difference column.

Declaration

public Task<GetDifferenceColumnResponse> GetDifferenceColumn(GetDifferenceColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDifferenceColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDifferenceColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDifferenceColumn API.

GetDiscoveryJob(GetDiscoveryJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified discovery job.

Declaration

public Task<GetDiscoveryJobResponse> GetDiscoveryJob(GetDiscoveryJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDiscoveryJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDiscoveryJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDiscoveryJob API.

GetDiscoveryJobResult(GetDiscoveryJobResultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified discovery result.

Declaration

public Task<GetDiscoveryJobResultResponse> GetDiscoveryJobResult(GetDiscoveryJobResultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDiscoveryJobResultRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDiscoveryJobResultResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDiscoveryJobResult API.

GetLibraryMaskingFormat(GetLibraryMaskingFormatRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified library masking format.

Declaration

public Task<GetLibraryMaskingFormatResponse> GetLibraryMaskingFormat(GetLibraryMaskingFormatRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetLibraryMaskingFormatRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetLibraryMaskingFormatResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetLibraryMaskingFormat API.

GetMaskingColumn(GetMaskingColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified masking column.

Declaration

public Task<GetMaskingColumnResponse> GetMaskingColumn(GetMaskingColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMaskingColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMaskingColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMaskingColumn API.

GetMaskingPolicy(GetMaskingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified masking policy.

Declaration

public Task<GetMaskingPolicyResponse> GetMaskingPolicy(GetMaskingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMaskingPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMaskingPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMaskingPolicy API.

GetMaskingPolicyHealthReport(GetMaskingPolicyHealthReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified masking policy health report.

Declaration

public Task<GetMaskingPolicyHealthReportResponse> GetMaskingPolicyHealthReport(GetMaskingPolicyHealthReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMaskingPolicyHealthReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMaskingPolicyHealthReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMaskingPolicyHealthReport API.

GetMaskingReport(GetMaskingReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified masking report.

Declaration

public Task<GetMaskingReportResponse> GetMaskingReport(GetMaskingReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMaskingReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMaskingReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMaskingReport API.

GetOnPremConnector(GetOnPremConnectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified on-premises connector.

Declaration

public Task<GetOnPremConnectorResponse> GetOnPremConnector(GetOnPremConnectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOnPremConnectorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetOnPremConnectorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOnPremConnector API.

GetPeerTargetDatabase(GetPeerTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the details of the specified Data Safe peer target database.

Declaration

public Task<GetPeerTargetDatabaseResponse> GetPeerTargetDatabase(GetPeerTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPeerTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetPeerTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPeerTargetDatabase API.

GetProfile(GetProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the details of given profile available on the target. <br/> The GetProfile operation returns only the profiles in the specified 'userAssessmentId'. This does not include any subcompartments of the current compartment.

Declaration

public Task<GetProfileResponse> GetProfile(GetProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetProfileRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetProfileResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetProfile API.

GetReport(GetReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a report by identifier

Declaration

public Task<GetReportResponse> GetReport(GetReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetReport API.

GetReportContent(GetReportContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads the specified report in the form of .xls or .pdf.

Declaration

public Task<GetReportContentResponse> GetReportContent(GetReportContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetReportContentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetReportContentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetReportContent API.

GetReportDefinition(GetReportDefinitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of report definition specified by the identifier

Declaration

public Task<GetReportDefinitionResponse> GetReportDefinition(GetReportDefinitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetReportDefinitionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetReportDefinitionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetReportDefinition API.

GetSdmMaskingPolicyDifference(GetSdmMaskingPolicyDifferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified SDM Masking policy difference.

Declaration

public Task<GetSdmMaskingPolicyDifferenceResponse> GetSdmMaskingPolicyDifference(GetSdmMaskingPolicyDifferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSdmMaskingPolicyDifferenceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSdmMaskingPolicyDifferenceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSdmMaskingPolicyDifference API.

GetSecurityAssessment(GetSecurityAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified security assessment.

Declaration

public Task<GetSecurityAssessmentResponse> GetSecurityAssessment(GetSecurityAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecurityAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSecurityAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSecurityAssessment API.

GetSecurityAssessmentComparison(GetSecurityAssessmentComparisonRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the comparison report for the security assessments submitted for comparison.

Declaration

public Task<GetSecurityAssessmentComparisonResponse> GetSecurityAssessmentComparison(GetSecurityAssessmentComparisonRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecurityAssessmentComparisonRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSecurityAssessmentComparisonResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSecurityAssessmentComparison API.

GetSecurityPolicy(GetSecurityPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a security policy by the specified OCID of the security policy resource.

Declaration

public Task<GetSecurityPolicyResponse> GetSecurityPolicy(GetSecurityPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecurityPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSecurityPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSecurityPolicy API.

GetSecurityPolicyDeployment(GetSecurityPolicyDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a security policy deployment by identifier.

Declaration

public Task<GetSecurityPolicyDeploymentResponse> GetSecurityPolicyDeployment(GetSecurityPolicyDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecurityPolicyDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSecurityPolicyDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSecurityPolicyDeployment API.

GetSecurityPolicyEntryState(GetSecurityPolicyEntryStateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a security policy entity states by identifier.

Declaration

public Task<GetSecurityPolicyEntryStateResponse> GetSecurityPolicyEntryState(GetSecurityPolicyEntryStateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecurityPolicyEntryStateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSecurityPolicyEntryStateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSecurityPolicyEntryState API.

GetSecurityPolicyReport(GetSecurityPolicyReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a security policy report by the specified OCID of the security policy report resource.

Declaration

public Task<GetSecurityPolicyReportResponse> GetSecurityPolicyReport(GetSecurityPolicyReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecurityPolicyReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSecurityPolicyReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSecurityPolicyReport API.

GetSensitiveColumn(GetSensitiveColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified sensitive column.

Declaration

public Task<GetSensitiveColumnResponse> GetSensitiveColumn(GetSensitiveColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSensitiveColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSensitiveColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSensitiveColumn API.

GetSensitiveDataModel(GetSensitiveDataModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified sensitive data model.

Declaration

public Task<GetSensitiveDataModelResponse> GetSensitiveDataModel(GetSensitiveDataModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSensitiveDataModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSensitiveDataModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSensitiveDataModel API.

GetSensitiveType(GetSensitiveTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified sensitive type.

Declaration

public Task<GetSensitiveTypeResponse> GetSensitiveType(GetSensitiveTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSensitiveTypeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSensitiveTypeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSensitiveType API.

GetSqlCollection(GetSqlCollectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a SQL collection by identifier.

Declaration

public Task<GetSqlCollectionResponse> GetSqlCollection(GetSqlCollectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSqlCollectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSqlCollectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSqlCollection API.

GetSqlFirewallAllowedSql(GetSqlFirewallAllowedSqlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a SQL firewall allowed SQL by identifier.

Declaration

public Task<GetSqlFirewallAllowedSqlResponse> GetSqlFirewallAllowedSql(GetSqlFirewallAllowedSqlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSqlFirewallAllowedSqlRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSqlFirewallAllowedSqlResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSqlFirewallAllowedSql API.

GetSqlFirewallPolicy(GetSqlFirewallPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a SQL Firewall policy by identifier.

Declaration

public Task<GetSqlFirewallPolicyResponse> GetSqlFirewallPolicy(GetSqlFirewallPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSqlFirewallPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSqlFirewallPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSqlFirewallPolicy API.

GetTargetAlertPolicyAssociation(GetTargetAlertPolicyAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of target-alert policy association by its ID.

Declaration

public Task<GetTargetAlertPolicyAssociationResponse> GetTargetAlertPolicyAssociation(GetTargetAlertPolicyAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetTargetAlertPolicyAssociationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetTargetAlertPolicyAssociationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetTargetAlertPolicyAssociation API.

GetTargetDatabase(GetTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the details of the specified Data Safe target database.

Declaration

public Task<GetTargetDatabaseResponse> GetTargetDatabase(GetTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetTargetDatabase API.

GetUserAssessment(GetUserAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a user assessment by identifier.

Declaration

public Task<GetUserAssessmentResponse> GetUserAssessment(GetUserAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetUserAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetUserAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetUserAssessment API.

GetUserAssessmentComparison(GetUserAssessmentComparisonRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the comparison report for the user assessments submitted for comparison.

Declaration

public Task<GetUserAssessmentComparisonResponse> GetUserAssessmentComparison(GetUserAssessmentComparisonRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetUserAssessmentComparisonRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetUserAssessmentComparisonResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetUserAssessmentComparison API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the specified work request.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListAlertAnalytics(ListAlertAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the aggregation details of the alerts.

Declaration

public Task<ListAlertAnalyticsResponse> ListAlertAnalytics(ListAlertAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAlertAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAlertAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAlertAnalytics API.

ListAlertPolicies(ListAlertPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all alert policies.

Declaration

public Task<ListAlertPoliciesResponse> ListAlertPolicies(ListAlertPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAlertPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAlertPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAlertPolicies API.

ListAlertPolicyRules(ListAlertPolicyRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the rules of the specified alert policy. The alert policy is said to be satisfied when all rules in the policy evaulate to true. If there are three rules: rule1,rule2 and rule3, the policy is satisfied if rule1 AND rule2 AND rule3 is True.

Declaration

public Task<ListAlertPolicyRulesResponse> ListAlertPolicyRules(ListAlertPolicyRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAlertPolicyRulesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAlertPolicyRulesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAlertPolicyRules API.

ListAlerts(ListAlertsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all alerts.

Declaration

public Task<ListAlertsResponse> ListAlerts(ListAlertsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAlertsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAlertsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAlerts API.

ListAuditArchiveRetrievals(ListAuditArchiveRetrievalsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the list of audit archive retrieval.

Declaration

public Task<ListAuditArchiveRetrievalsResponse> ListAuditArchiveRetrievals(ListAuditArchiveRetrievalsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditArchiveRetrievalsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditArchiveRetrievalsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditArchiveRetrievals API.

ListAuditEventAnalytics(ListAuditEventAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

By default the ListAuditEventAnalytics operation will return all of the summary columns. To filter for a specific summary column, specify it in the summaryField query parameter. <br/> Example: /ListAuditEventAnalytics?summaryField=targetName&summaryField=userName&summaryField=clientHostname &summaryField=dmls&summaryField=privilegeChanges&summaryField=ddls&summaryField=loginFailure&summaryField=loginSuccess &summaryField=allRecord&q=(auditEventTime ge "2021-06-13T23:49:14") <br/> /ListAuditEventAnalytics?timeStarted=2022-08-18T11:02:26.000Z&timeEnded=2022-08-24T11:02:26.000Z This will give number of events grouped by periods. Period can be 1 day, 1 week, etc. <br/> /ListAuditEventAnalytics?summaryField=targetName&groupBy=targetName This will give the number of events group by targetName. Only targetName summary column would be returned.

Declaration

public Task<ListAuditEventAnalyticsResponse> ListAuditEventAnalytics(ListAuditEventAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditEventAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditEventAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditEventAnalytics API.

ListAuditEvents(ListAuditEventsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

The ListAuditEvents operation returns specified compartmentId audit Events only. The list does not include any audit Events associated with the subcompartments of the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListAuditEvents on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListAuditEventsResponse> ListAuditEvents(ListAuditEventsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditEventsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditEventsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditEvents API.

ListAuditPolicies(ListAuditPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all audited targets with their corresponding provisioned audit policies, and their provisioning conditions. <br/> The ListAuditPolicies operation returns only the audit policies in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListAuditPolicies on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListAuditPoliciesResponse> ListAuditPolicies(ListAuditPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditPolicies API.

ListAuditPolicyAnalytics(ListAuditPolicyAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of aggregated audit policy details on the target databases. A audit policy aggregation helps understand the overall state of policies provisioned on targets. It is especially useful to create dashboards or to support analytics. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform SummarizedAuditPolicyInfo on the specified compartmentId and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE. <br/> Example: ListAuditPolicyAnalytics?groupBy=auditPolicyCategory

Declaration

public Task<ListAuditPolicyAnalyticsResponse> ListAuditPolicyAnalytics(ListAuditPolicyAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditPolicyAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditPolicyAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditPolicyAnalytics API.

ListAuditProfileAnalytics(ListAuditProfileAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of audit profile aggregated details . A audit profile aggregation helps understand the overall state of audit profile profiles. As an example, it helps understand how many audit profiles have paid usage. It is especially useful to create dashboards or to support analytics. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform AuditProfileAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListAuditProfileAnalyticsResponse> ListAuditProfileAnalytics(ListAuditProfileAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditProfileAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditProfileAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditProfileAnalytics API.

ListAuditProfiles(ListAuditProfilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all audit profiles. <br/> The ListAuditProfiles operation returns only the audit profiles in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListAuditProfiles on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListAuditProfilesResponse> ListAuditProfiles(ListAuditProfilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditProfilesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditProfilesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditProfiles API.

ListAuditTrailAnalytics(ListAuditTrailAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of audit trail aggregated details . A audit trail aggregation helps understand the overall state of trails. As an example, it helps understand how many trails are running or stopped. It is especially useful to create dashboards or to support analytics. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform AuditTrailAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListAuditTrailAnalyticsResponse> ListAuditTrailAnalytics(ListAuditTrailAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditTrailAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditTrailAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditTrailAnalytics API.

ListAuditTrails(ListAuditTrailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all audit trails. The ListAuditTrails operation returns only the audit trails in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListAuditTrails on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListAuditTrailsResponse> ListAuditTrails(ListAuditTrailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuditTrailsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuditTrailsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuditTrails API.

ListAvailableAuditVolumes(ListAvailableAuditVolumesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of audit trails, and associated audit event volume for each trail up to defined start date.

Declaration

public Task<ListAvailableAuditVolumesResponse> ListAvailableAuditVolumes(ListAvailableAuditVolumesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAvailableAuditVolumesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAvailableAuditVolumesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAvailableAuditVolumes API.

ListCollectedAuditVolumes(ListCollectedAuditVolumesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all collected audit volume data points.

Declaration

public Task<ListCollectedAuditVolumesResponse> ListCollectedAuditVolumes(ListCollectedAuditVolumesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListCollectedAuditVolumesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListCollectedAuditVolumesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListCollectedAuditVolumes API.

ListColumns(ListColumnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of column metadata objects.

Declaration

public Task<ListColumnsResponse> ListColumns(ListColumnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListColumnsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListColumnsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListColumns API.

ListDataSafePrivateEndpoints(ListDataSafePrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of Data Safe private endpoints.

Declaration

public Task<ListDataSafePrivateEndpointsResponse> ListDataSafePrivateEndpoints(ListDataSafePrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDataSafePrivateEndpointsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDataSafePrivateEndpointsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDataSafePrivateEndpoints API.

ListDatabaseSecurityConfigs(ListDatabaseSecurityConfigsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all database security configurations in Data Safe. <br/> The ListDatabaseSecurityConfigs operation returns only the database security configurations in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListDatabaseSecurityConfigs on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListDatabaseSecurityConfigsResponse> ListDatabaseSecurityConfigs(ListDatabaseSecurityConfigsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDatabaseSecurityConfigsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDatabaseSecurityConfigsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDatabaseSecurityConfigs API.

ListDatabaseTableAccessEntries(ListDatabaseTableAccessEntriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all database table access entries in Data Safe. <br/> The ListDatabaseTableAccessEntries operation returns only the database table access reports for the specified security policy report.

Declaration

public Task<ListDatabaseTableAccessEntriesResponse> ListDatabaseTableAccessEntries(ListDatabaseTableAccessEntriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDatabaseTableAccessEntriesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDatabaseTableAccessEntriesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDatabaseTableAccessEntries API.

ListDatabaseViewAccessEntries(ListDatabaseViewAccessEntriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all database view access entries in Data Safe. <br/> The ListDatabaseViewAccessEntries operation returns only the database view access objects for the specified security policy report.

Declaration

public Task<ListDatabaseViewAccessEntriesResponse> ListDatabaseViewAccessEntries(ListDatabaseViewAccessEntriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDatabaseViewAccessEntriesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDatabaseViewAccessEntriesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDatabaseViewAccessEntries API.

ListDifferenceColumns(ListDifferenceColumnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of columns of a SDM masking policy difference resource based on the specified query parameters.

Declaration

public Task<ListDifferenceColumnsResponse> ListDifferenceColumns(ListDifferenceColumnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDifferenceColumnsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDifferenceColumnsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDifferenceColumns API.

ListDiscoveryAnalytics(ListDiscoveryAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets consolidated discovery analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel "ACCESSIBLE" by default.

Declaration

public Task<ListDiscoveryAnalyticsResponse> ListDiscoveryAnalytics(ListDiscoveryAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDiscoveryAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDiscoveryAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDiscoveryAnalytics API.

ListDiscoveryJobResults(ListDiscoveryJobResultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of discovery results based on the specified query parameters.

Declaration

public Task<ListDiscoveryJobResultsResponse> ListDiscoveryJobResults(ListDiscoveryJobResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDiscoveryJobResultsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDiscoveryJobResultsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDiscoveryJobResults API.

ListDiscoveryJobs(ListDiscoveryJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of incremental discovery jobs based on the specified query parameters.

Declaration

public Task<ListDiscoveryJobsResponse> ListDiscoveryJobs(ListDiscoveryJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDiscoveryJobsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDiscoveryJobsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDiscoveryJobs API.

ListFindingAnalytics(ListFindingAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of findings aggregated details in the specified compartment. This provides information about the overall state of security assessment findings. You can use groupBy to get the count of findings under a certain risk level and with a certain findingKey, and as well as get the list of the targets that match the condition. This data is especially useful content for the statistic chart or to support analytics. <br/> When you perform the ListFindingAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

Declaration

public Task<ListFindingAnalyticsResponse> ListFindingAnalytics(ListFindingAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListFindingAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListFindingAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListFindingAnalytics API.

ListFindings(ListFindingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all the findings from all the targets in the specified compartment.

Declaration

public Task<ListFindingsResponse> ListFindings(ListFindingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListFindingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListFindingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListFindings API.

ListFindingsChangeAuditLogs(ListFindingsChangeAuditLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all changes made by user to risk level of findings of the specified assessment.

Declaration

public Task<ListFindingsChangeAuditLogsResponse> ListFindingsChangeAuditLogs(ListFindingsChangeAuditLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListFindingsChangeAuditLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListFindingsChangeAuditLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListFindingsChangeAuditLogs API.

ListGrants(ListGrantsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of grants for a particular user in the specified user assessment. A user grant contains details such as the privilege name, type, category, and depth level. The depth level indicates how deep in the hierarchy of roles granted to roles a privilege grant is. The userKey in this operation is a system-generated identifier. Perform the operation ListUsers to get the userKey for a particular user.

Declaration

public Task<ListGrantsResponse> ListGrants(ListGrantsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGrantsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListGrantsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListGrants API.

ListLibraryMaskingFormats(ListLibraryMaskingFormatsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of library masking formats based on the specified query parameters.

Declaration

public Task<ListLibraryMaskingFormatsResponse> ListLibraryMaskingFormats(ListLibraryMaskingFormatsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListLibraryMaskingFormatsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListLibraryMaskingFormatsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListLibraryMaskingFormats API.

ListMaskedColumns(ListMaskedColumnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of masked columns present in the specified masking report and based on the specified query parameters.

Declaration

public Task<ListMaskedColumnsResponse> ListMaskedColumns(ListMaskedColumnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskedColumnsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskedColumnsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskedColumns API.

ListMaskingAnalytics(ListMaskingAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets consolidated masking analytics data based on the specified query parameters. If CompartmentIdInSubtreeQueryParam is specified as true, the behaviour is equivalent to accessLevel "ACCESSIBLE" by default.

Declaration

public Task<ListMaskingAnalyticsResponse> ListMaskingAnalytics(ListMaskingAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskingAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskingAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskingAnalytics API.

ListMaskingColumns(ListMaskingColumnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of masking columns present in the specified masking policy and based on the specified query parameters.

Declaration

public Task<ListMaskingColumnsResponse> ListMaskingColumns(ListMaskingColumnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskingColumnsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskingColumnsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskingColumns API.

ListMaskingObjects(ListMaskingObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of masking objects present in the specified masking policy and based on the specified query parameters.

Declaration

public Task<ListMaskingObjectsResponse> ListMaskingObjects(ListMaskingObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskingObjectsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskingObjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskingObjects API.

ListMaskingPolicies(ListMaskingPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of masking policies based on the specified query parameters.

Declaration

public Task<ListMaskingPoliciesResponse> ListMaskingPolicies(ListMaskingPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskingPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskingPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskingPolicies API.

ListMaskingPolicyHealthReportLogs(ListMaskingPolicyHealthReportLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of errors and warnings from a masking policy health check.

Declaration

public Task<ListMaskingPolicyHealthReportLogsResponse> ListMaskingPolicyHealthReportLogs(ListMaskingPolicyHealthReportLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskingPolicyHealthReportLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskingPolicyHealthReportLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskingPolicyHealthReportLogs API.

ListMaskingPolicyHealthReports(ListMaskingPolicyHealthReportsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of masking policy health reports based on the specified query parameters.

Declaration

public Task<ListMaskingPolicyHealthReportsResponse> ListMaskingPolicyHealthReports(ListMaskingPolicyHealthReportsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskingPolicyHealthReportsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskingPolicyHealthReportsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskingPolicyHealthReports API.

ListMaskingReports(ListMaskingReportsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of masking reports based on the specified query parameters.

Declaration

public Task<ListMaskingReportsResponse> ListMaskingReports(ListMaskingReportsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskingReportsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskingReportsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskingReports API.

ListMaskingSchemas(ListMaskingSchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of masking schemas present in the specified masking policy and based on the specified query parameters.

Declaration

public Task<ListMaskingSchemasResponse> ListMaskingSchemas(ListMaskingSchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMaskingSchemasRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMaskingSchemasResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMaskingSchemas API.

ListOnPremConnectors(ListOnPremConnectorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of on-premises connectors.

Declaration

public Task<ListOnPremConnectorsResponse> ListOnPremConnectors(ListOnPremConnectorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOnPremConnectorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOnPremConnectorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOnPremConnectors API.

ListPeerTargetDatabases(ListPeerTargetDatabasesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all the peer target databases under the primary target database identified by the OCID passed as path parameter.

Declaration

public Task<ListPeerTargetDatabasesResponse> ListPeerTargetDatabases(ListPeerTargetDatabasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPeerTargetDatabasesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPeerTargetDatabasesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPeerTargetDatabases API.

ListProfileAnalytics(ListProfileAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of aggregated user profile details in the specified compartment. This provides information about the overall profiles available. For example, the user profile details include how many users have the profile assigned and do how many use password verification function. This data is especially useful content for dashboards or to support analytics. <br/> When you perform the ListProfileAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned. <br/> The parameter compartmentIdInSubtree applies when you perform ListProfileAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. <br/> To use ListProfileAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListProfileAnalyticsResponse> ListProfileAnalytics(ListProfileAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListProfileAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListProfileAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListProfileAnalytics API.

ListProfileSummaries(ListProfileSummariesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of user profiles containing the profile details along with the target id and user counts. <br/> The ListProfiles operation returns only the profiles belonging to a certain target. If compartment type user assessment id is provided, then profile information for all the targets belonging to the pertaining compartment is returned. The list does not include any subcompartments of the compartment under consideration. <br/> The parameter 'accessLevel' specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when 'compartmentIdInSubtree' is set to 'true'. <br/> The parameter 'compartmentIdInSubtree' applies when you perform ListUserProfiles on the 'compartmentId' belonging to the assessmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter 'compartmentIdInSubtree' to true and 'accessLevel' to ACCESSIBLE.

Declaration

public Task<ListProfileSummariesResponse> ListProfileSummaries(ListProfileSummariesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListProfileSummariesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListProfileSummariesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListProfileSummaries API.

ListReportDefinitions(ListReportDefinitionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of report definitions. The ListReportDefinitions operation returns only the report definitions in the specified compartmentId. It also returns the seeded report definitions which are available to all the compartments.

Declaration

public Task<ListReportDefinitionsResponse> ListReportDefinitions(ListReportDefinitionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListReportDefinitionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListReportDefinitionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListReportDefinitions API.

ListReports(ListReportsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all the reports in the compartment. It contains information such as report generation time.

Declaration

public Task<ListReportsResponse> ListReports(ListReportsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListReportsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListReportsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListReports API.

ListRoleGrantPaths(ListRoleGrantPathsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all role grant paths for a particular user. <br/> The ListRoleGrantPaths operation returns only the role grant paths for the specified security policy report.

Declaration

public Task<ListRoleGrantPathsResponse> ListRoleGrantPaths(ListRoleGrantPathsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListRoleGrantPathsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListRoleGrantPathsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListRoleGrantPaths API.

ListRoles(ListRolesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of role metadata objects.

Declaration

public Task<ListRolesResponse> ListRoles(ListRolesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListRolesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListRolesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListRoles API.

ListSchemas(ListSchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns list of schema.

Declaration

public Task<ListSchemasResponse> ListSchemas(ListSchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSchemasRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSchemasResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSchemas API.

ListSdmMaskingPolicyDifferences(ListSdmMaskingPolicyDifferencesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of SDM and masking policy difference resources based on the specified query parameters.

Declaration

public Task<ListSdmMaskingPolicyDifferencesResponse> ListSdmMaskingPolicyDifferences(ListSdmMaskingPolicyDifferencesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSdmMaskingPolicyDifferencesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSdmMaskingPolicyDifferencesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSdmMaskingPolicyDifferences API.

ListSecurityAssessments(ListSecurityAssessmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of security assessments. <br/> The ListSecurityAssessments operation returns only the assessments in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSecurityAssessments on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSecurityAssessmentsResponse> ListSecurityAssessments(ListSecurityAssessmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityAssessmentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityAssessmentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityAssessments API.

ListSecurityFeatureAnalytics(ListSecurityFeatureAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of Database security feature usage aggregated details in the specified compartment. This provides information about the overall security controls, by returning the counting number of the target databases using the security features. <br/> When you perform the ListSecurityFeatureAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned.

Declaration

public Task<ListSecurityFeatureAnalyticsResponse> ListSecurityFeatureAnalytics(ListSecurityFeatureAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityFeatureAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityFeatureAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityFeatureAnalytics API.

ListSecurityFeatures(ListSecurityFeaturesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the usage of Database security features for a given compartment or a target level, based on the filters provided.

Declaration

public Task<ListSecurityFeaturesResponse> ListSecurityFeatures(ListSecurityFeaturesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityFeaturesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityFeaturesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityFeatures API.

ListSecurityPolicies(ListSecurityPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all security policies in Data Safe. <br/> The ListSecurityPolicies operation returns only the security policies in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSecurityPolicies on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSecurityPoliciesResponse> ListSecurityPolicies(ListSecurityPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityPolicies API.

ListSecurityPolicyDeployments(ListSecurityPolicyDeploymentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all security policy deployments in Data Safe. <br/> The ListSecurityPolicyDeployments operation returns only the security policy deployments in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSecurityPolicyDeployments on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSecurityPolicyDeploymentsResponse> ListSecurityPolicyDeployments(ListSecurityPolicyDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityPolicyDeploymentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityPolicyDeploymentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityPolicyDeployments API.

ListSecurityPolicyEntryStates(ListSecurityPolicyEntryStatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all security policy entry states in Data Safe. <br/> The ListSecurityPolicyEntryStates operation returns only the security policy entry states for the specified security policy entry.

Declaration

public Task<ListSecurityPolicyEntryStatesResponse> ListSecurityPolicyEntryStates(ListSecurityPolicyEntryStatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityPolicyEntryStatesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityPolicyEntryStatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityPolicyEntryStates API.

ListSecurityPolicyReports(ListSecurityPolicyReportsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all security policy reports in Data Safe. <br/> The ListSecurityPolicyReports operation returns only the security policy reports in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSecurityPolicyReports on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSecurityPolicyReportsResponse> ListSecurityPolicyReports(ListSecurityPolicyReportsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityPolicyReportsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityPolicyReportsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityPolicyReports API.

ListSensitiveColumns(ListSensitiveColumnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of sensitive columns present in the specified sensitive data model based on the specified query parameters.

Declaration

public Task<ListSensitiveColumnsResponse> ListSensitiveColumns(ListSensitiveColumnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSensitiveColumnsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSensitiveColumnsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSensitiveColumns API.

ListSensitiveDataModelSensitiveTypes(ListSensitiveDataModelSensitiveTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of sensitive type Ids present in the specified sensitive data model.

Declaration

public Task<ListSensitiveDataModelSensitiveTypesResponse> ListSensitiveDataModelSensitiveTypes(ListSensitiveDataModelSensitiveTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSensitiveDataModelSensitiveTypesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSensitiveDataModelSensitiveTypesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSensitiveDataModelSensitiveTypes API.

ListSensitiveDataModels(ListSensitiveDataModelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of sensitive data models based on the specified query parameters.

Declaration

public Task<ListSensitiveDataModelsResponse> ListSensitiveDataModels(ListSensitiveDataModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSensitiveDataModelsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSensitiveDataModelsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSensitiveDataModels API.

ListSensitiveObjects(ListSensitiveObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of sensitive objects present in the specified sensitive data model based on the specified query parameters.

Declaration

public Task<ListSensitiveObjectsResponse> ListSensitiveObjects(ListSensitiveObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSensitiveObjectsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSensitiveObjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSensitiveObjects API.

ListSensitiveSchemas(ListSensitiveSchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of sensitive schemas present in the specified sensitive data model based on the specified query parameters.

Declaration

public Task<ListSensitiveSchemasResponse> ListSensitiveSchemas(ListSensitiveSchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSensitiveSchemasRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSensitiveSchemasResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSensitiveSchemas API.

ListSensitiveTypes(ListSensitiveTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of sensitive types based on the specified query parameters.

Declaration

public Task<ListSensitiveTypesResponse> ListSensitiveTypes(ListSensitiveTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSensitiveTypesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSensitiveTypesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSensitiveTypes API.

ListSqlCollectionAnalytics(ListSqlCollectionAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all SQL collection analytics in Data Safe. <br/> The ListSqlCollectionAnalytics operation returns only the analytics for the SQL collections in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSqlCollections on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSqlCollectionAnalyticsResponse> ListSqlCollectionAnalytics(ListSqlCollectionAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlCollectionAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlCollectionAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlCollectionAnalytics API.

ListSqlCollectionLogInsights(ListSqlCollectionLogInsightsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of the SQL collection log analytics.

Declaration

public Task<ListSqlCollectionLogInsightsResponse> ListSqlCollectionLogInsights(ListSqlCollectionLogInsightsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlCollectionLogInsightsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlCollectionLogInsightsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlCollectionLogInsights API.

ListSqlCollections(ListSqlCollectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all SQL collections in Data Safe. <br/> The ListSqlCollections operation returns only the SQL collections in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSqlCollections on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSqlCollectionsResponse> ListSqlCollections(ListSqlCollectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlCollectionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlCollectionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlCollections API.

ListSqlFirewallAllowedSqlAnalytics(ListSqlFirewallAllowedSqlAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the aggregation details of all SQL Firewall allowed SQL statements. <br/> The ListSqlFirewallAllowedSqlAnalytics operation returns the aggregates of the SQL Firewall allowed SQL statements in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSqlFirewallAllowedSqlAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSqlFirewallAllowedSqlAnalyticsResponse> ListSqlFirewallAllowedSqlAnalytics(ListSqlFirewallAllowedSqlAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlFirewallAllowedSqlAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlFirewallAllowedSqlAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlFirewallAllowedSqlAnalytics API.

ListSqlFirewallAllowedSqls(ListSqlFirewallAllowedSqlsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all SQL Firewall allowed SQL statements. <br/> The ListSqlFirewallAllowedSqls operation returns only the SQL Firewall allowed SQL statements in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSqlFirewallPolicies on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSqlFirewallAllowedSqlsResponse> ListSqlFirewallAllowedSqls(ListSqlFirewallAllowedSqlsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlFirewallAllowedSqlsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlFirewallAllowedSqlsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlFirewallAllowedSqls API.

ListSqlFirewallPolicies(ListSqlFirewallPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all SQL Firewall policies. <br/> The ListSqlFirewallPolicies operation returns only the SQL Firewall policies in the specified compartmentId. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListSqlFirewallPolicies on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSqlFirewallPoliciesResponse> ListSqlFirewallPolicies(ListSqlFirewallPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlFirewallPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlFirewallPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlFirewallPolicies API.

ListSqlFirewallPolicyAnalytics(ListSqlFirewallPolicyAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of aggregated SQL Firewall policy details. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform SummarizedSqlFirewallPolicyInfo on the specified compartmentId and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListSqlFirewallPolicyAnalyticsResponse> ListSqlFirewallPolicyAnalytics(ListSqlFirewallPolicyAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlFirewallPolicyAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlFirewallPolicyAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlFirewallPolicyAnalytics API.

ListSqlFirewallViolationAnalytics(ListSqlFirewallViolationAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the aggregation details of the SQL Firewall violations.

Declaration

public Task<ListSqlFirewallViolationAnalyticsResponse> ListSqlFirewallViolationAnalytics(ListSqlFirewallViolationAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlFirewallViolationAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlFirewallViolationAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlFirewallViolationAnalytics API.

ListSqlFirewallViolations(ListSqlFirewallViolationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all the SQL Firewall violations captured by the firewall.

Declaration

public Task<ListSqlFirewallViolationsResponse> ListSqlFirewallViolations(ListSqlFirewallViolationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSqlFirewallViolationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSqlFirewallViolationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSqlFirewallViolations API.

ListTables(ListTablesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of table metadata objects.

Declaration

public Task<ListTablesResponse> ListTables(ListTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTablesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListTablesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTables API.

ListTargetAlertPolicyAssociations(ListTargetAlertPolicyAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all target-alert policy associations.

Declaration

public Task<ListTargetAlertPolicyAssociationsResponse> ListTargetAlertPolicyAssociations(ListTargetAlertPolicyAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTargetAlertPolicyAssociationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListTargetAlertPolicyAssociationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTargetAlertPolicyAssociations API.

ListTargetDatabases(ListTargetDatabasesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the list of registered target databases in Data Safe.

Declaration

public Task<ListTargetDatabasesResponse> ListTargetDatabases(ListTargetDatabasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTargetDatabasesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListTargetDatabasesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTargetDatabases API.

ListUserAccessAnalytics(ListUserAccessAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of aggregated user access analytics in the specified target in a compartment.

Declaration

public Task<ListUserAccessAnalyticsResponse> ListUserAccessAnalytics(ListUserAccessAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUserAccessAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListUserAccessAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUserAccessAnalytics API.

ListUserAnalytics(ListUserAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of aggregated user details from the specified user assessment. This provides information about the overall state. of database user security. For example, the user details include how many users have the DBA role and how many users are in the critical category. This data is especially useful content for dashboards or to support analytics. <br/> When you perform the ListUserAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the parameter accessLevel is set to ACCESSIBLE, then the operation returns compartments in which the requestor has INSPECT permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by compartmentId, then "Not Authorized" is returned. <br/> The parameter compartmentIdInSubtree applies when you perform ListUserAnalytics on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. <br/> To use ListUserAnalytics to get a full list of all compartments and subcompartments in the tenancy from the root compartment, set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListUserAnalyticsResponse> ListUserAnalytics(ListUserAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUserAnalyticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListUserAnalyticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUserAnalytics API.

ListUserAssessments(ListUserAssessmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of user assessments. <br/> The ListUserAssessments operation returns only the assessments in the specified compartmentId. The list does not include any subcompartments of the compartmentId passed. <br/> The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true. <br/> The parameter compartmentIdInSubtree applies when you perform ListUserAssessments on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Declaration

public Task<ListUserAssessmentsResponse> ListUserAssessments(ListUserAssessmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUserAssessmentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListUserAssessmentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUserAssessments API.

ListUsers(ListUsersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of users of the specified user assessment. The result contains the database user details for each user, such as user type, account status, last login time, user creation time, authentication type, user profile, and the date and time of the latest password change. It also contains the user category derived from these user details as well as privileges granted to each user.

Declaration

public Task<ListUsersResponse> ListUsers(ListUsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUsersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListUsersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUsers API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of errors for the specified work request.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of log entries for the specified work request.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of work requests.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

MaskData(MaskDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Masks data using the specified masking policy.

Declaration

public Task<MaskDataResponse> MaskData(MaskDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
MaskDataRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<MaskDataResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use MaskData API.

ModifyGlobalSettings(ModifyGlobalSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies Global Settings in Data Safe in the tenancy and region.

Declaration

public Task<ModifyGlobalSettingsResponse> ModifyGlobalSettings(ModifyGlobalSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ModifyGlobalSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ModifyGlobalSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ModifyGlobalSettings API.

PatchAlerts(PatchAlertsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the status of one or more alert specified by the alert IDs.

Declaration

public Task<PatchAlertsResponse> PatchAlerts(PatchAlertsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchAlertsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchAlertsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchAlerts API.

PatchDiscoveryJobResults(PatchDiscoveryJobResultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Patches one or more discovery results. You can use this operation to set the plannedAction attribute before using ApplyDiscoveryJobResults to process the results based on this attribute.

Declaration

public Task<PatchDiscoveryJobResultsResponse> PatchDiscoveryJobResults(PatchDiscoveryJobResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchDiscoveryJobResultsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchDiscoveryJobResultsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchDiscoveryJobResults API.

PatchMaskingColumns(PatchMaskingColumnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Patches one or more columns in the specified masking policy. Use it to create, or update masking columns. To create masking columns, use CreateMaskingColumnDetails as the patch value. And to update masking columns, use UpdateMaskingColumnDetails as the patch value.

Declaration

public Task<PatchMaskingColumnsResponse> PatchMaskingColumns(PatchMaskingColumnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMaskingColumnsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMaskingColumnsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMaskingColumns API.

PatchSdmMaskingPolicyDifferenceColumns(PatchSdmMaskingPolicyDifferenceColumnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Patches one or more SDM masking policy difference columns. You can use this operation to set the plannedAction attribute before using ApplySdmMaskingPolicyDifference to process the difference based on this attribute.

Declaration

public Task<PatchSdmMaskingPolicyDifferenceColumnsResponse> PatchSdmMaskingPolicyDifferenceColumns(PatchSdmMaskingPolicyDifferenceColumnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSdmMaskingPolicyDifferenceColumnsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSdmMaskingPolicyDifferenceColumnsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSdmMaskingPolicyDifferenceColumns API.

PatchSensitiveColumns(PatchSensitiveColumnsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Patches one or more columns in the specified sensitive data model. Use it to create, update, or delete sensitive columns. To create sensitive columns, use CreateSensitiveColumnDetails as the patch value. And to update sensitive columns, use UpdateSensitiveColumnDetails as the patch value.

Declaration

public Task<PatchSensitiveColumnsResponse> PatchSensitiveColumns(PatchSensitiveColumnsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSensitiveColumnsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSensitiveColumnsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSensitiveColumns API.

PatchSqlFirewallAllowedSql(PatchSqlFirewallAllowedSqlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete multiple allowed sqls. You can use this operation to delete one or more allowed sqls. Create and update of multiple allowed sqls is not supported.

Declaration

public Task<PatchSqlFirewallAllowedSqlResponse> PatchSqlFirewallAllowedSql(PatchSqlFirewallAllowedSqlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSqlFirewallAllowedSqlRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSqlFirewallAllowedSqlResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSqlFirewallAllowedSql API.

PatchTargetAlertPolicyAssociation(PatchTargetAlertPolicyAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates new target-alert policy associations that will be applied on the target database.

Declaration

public Task<PatchTargetAlertPolicyAssociationResponse> PatchTargetAlertPolicyAssociation(PatchTargetAlertPolicyAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchTargetAlertPolicyAssociationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchTargetAlertPolicyAssociationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchTargetAlertPolicyAssociation API.

ProvisionAuditPolicy(ProvisionAuditPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Provision audit policy.

Declaration

public Task<ProvisionAuditPolicyResponse> ProvisionAuditPolicy(ProvisionAuditPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ProvisionAuditPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ProvisionAuditPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ProvisionAuditPolicy API.

PurgeSqlCollectionLogs(PurgeSqlCollectionLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Purge the SQL collection logs for the specified SqlCollection.

Declaration

public Task<PurgeSqlCollectionLogsResponse> PurgeSqlCollectionLogs(PurgeSqlCollectionLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PurgeSqlCollectionLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PurgeSqlCollectionLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PurgeSqlCollectionLogs API.

RefreshDatabaseSecurityConfiguration(RefreshDatabaseSecurityConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refreshes the specified database security configuration.

Declaration

public Task<RefreshDatabaseSecurityConfigurationResponse> RefreshDatabaseSecurityConfiguration(RefreshDatabaseSecurityConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RefreshDatabaseSecurityConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RefreshDatabaseSecurityConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RefreshDatabaseSecurityConfiguration API.

RefreshSecurityAssessment(RefreshSecurityAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Runs a security assessment, refreshes the latest assessment, and saves it for future reference. The assessment runs with a securityAssessmentId of type LATEST. Before you start, first call the ListSecurityAssessments operation with filter "type = latest" to get the security assessment id for the target's latest assessment.

Declaration

public Task<RefreshSecurityAssessmentResponse> RefreshSecurityAssessment(RefreshSecurityAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RefreshSecurityAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RefreshSecurityAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RefreshSecurityAssessment API.

RefreshSqlCollectionLogInsights(RefreshSqlCollectionLogInsightsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refresh the specified SQL collection Log Insights.

Declaration

public Task<RefreshSqlCollectionLogInsightsResponse> RefreshSqlCollectionLogInsights(RefreshSqlCollectionLogInsightsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RefreshSqlCollectionLogInsightsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RefreshSqlCollectionLogInsightsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RefreshSqlCollectionLogInsights API.

RefreshTargetDatabase(RefreshTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refreshes the Data Safe target database to update it's state.

Declaration

public Task<RefreshTargetDatabaseResponse> RefreshTargetDatabase(RefreshTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RefreshTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RefreshTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RefreshTargetDatabase API.

RefreshUserAssessment(RefreshUserAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refreshes the latest assessment and saves it for future reference. This operation runs with a userAssessmentId of type LATEST. Before you start, first call the ListUserAssessments operation with filter "type = latest" to get the user assessment ID for the target's latest assessment.

Declaration

public Task<RefreshUserAssessmentResponse> RefreshUserAssessment(RefreshUserAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RefreshUserAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RefreshUserAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RefreshUserAssessment API.

RemoveScheduleReport(RemoveScheduleReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the schedule of a .xls or .pdf report.

Declaration

public Task<RemoveScheduleReportResponse> RemoveScheduleReport(RemoveScheduleReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RemoveScheduleReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RemoveScheduleReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemoveScheduleReport API.

ResumeAuditTrail(ResumeAuditTrailRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Resumes the specified audit trail once it got stopped.

Declaration

public Task<ResumeAuditTrailResponse> ResumeAuditTrail(ResumeAuditTrailRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ResumeAuditTrailRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ResumeAuditTrailResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ResumeAuditTrail API.

ResumeWorkRequest(ResumeWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Resume the given work request. Issuing a resume does not guarantee of immediate resume of the work request.

Declaration

public Task<ResumeWorkRequestResponse> ResumeWorkRequest(ResumeWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ResumeWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ResumeWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ResumeWorkRequest API.

RetrieveAuditPolicies(RetrieveAuditPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the audit policy details from the source target database.

Declaration

public Task<RetrieveAuditPoliciesResponse> RetrieveAuditPolicies(RetrieveAuditPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RetrieveAuditPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RetrieveAuditPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RetrieveAuditPolicies API.

ScheduleReport(ScheduleReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Schedules a .xls or .pdf report based on parameters and report definition.

Declaration

public Task<ScheduleReportResponse> ScheduleReport(ScheduleReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ScheduleReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ScheduleReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ScheduleReport API.

SetSecurityAssessmentBaseline(SetSecurityAssessmentBaselineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Sets the saved security assessment as the baseline in the compartment where the the specified assessment resides. The security assessment needs to be of type 'SAVED'.

Declaration

public Task<SetSecurityAssessmentBaselineResponse> SetSecurityAssessmentBaseline(SetSecurityAssessmentBaselineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SetSecurityAssessmentBaselineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SetSecurityAssessmentBaselineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SetSecurityAssessmentBaseline API.

SetUserAssessmentBaseline(SetUserAssessmentBaselineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Sets the saved user assessment as the baseline in the compartment where the specified assessment resides. The user assessment needs to be of type 'SAVED'.

Declaration

public Task<SetUserAssessmentBaselineResponse> SetUserAssessmentBaseline(SetUserAssessmentBaselineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SetUserAssessmentBaselineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SetUserAssessmentBaselineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SetUserAssessmentBaseline API.

StartAuditTrail(StartAuditTrailRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts collection of audit records on the specified audit trail.

Declaration

public Task<StartAuditTrailResponse> StartAuditTrail(StartAuditTrailRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartAuditTrailRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StartAuditTrailResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StartAuditTrail API.

StartSqlCollection(StartSqlCollectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Start the specified SQL collection.

Declaration

public Task<StartSqlCollectionResponse> StartSqlCollection(StartSqlCollectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartSqlCollectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StartSqlCollectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StartSqlCollection API.

StopAuditTrail(StopAuditTrailRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops the specified audit trail.

Declaration

public Task<StopAuditTrailResponse> StopAuditTrail(StopAuditTrailRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopAuditTrailRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StopAuditTrailResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StopAuditTrail API.

StopSqlCollection(StopSqlCollectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops the specified SQL collection.

Declaration

public Task<StopSqlCollectionResponse> StopSqlCollection(StopSqlCollectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopSqlCollectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StopSqlCollectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StopSqlCollection API.

SuspendWorkRequest(SuspendWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Suspend the given work request. Issuing a suspend does not guarantee of a immediate suspend of the work request.

Declaration

public Task<SuspendWorkRequestResponse> SuspendWorkRequest(SuspendWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SuspendWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SuspendWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SuspendWorkRequest API.

UnsetSecurityAssessmentBaseline(UnsetSecurityAssessmentBaselineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes the baseline setting for the saved security assessment associated with the targetId passed via body. If no body or empty body is passed then the baseline settings of all the saved security assessments pertaining to the baseline assessment OCID provided in the path will be removed. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Declaration

public Task<UnsetSecurityAssessmentBaselineResponse> UnsetSecurityAssessmentBaseline(UnsetSecurityAssessmentBaselineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UnsetSecurityAssessmentBaselineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UnsetSecurityAssessmentBaselineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UnsetSecurityAssessmentBaseline API.

UnsetUserAssessmentBaseline(UnsetUserAssessmentBaselineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes the baseline setting for the saved user assessment associated with the targetId passed via body. If no body or empty body is passed then the baseline settings of all the saved user assessments pertaining to the baseline assessment OCID provided in the path will be removed. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.

Declaration

public Task<UnsetUserAssessmentBaselineResponse> UnsetUserAssessmentBaseline(UnsetUserAssessmentBaselineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UnsetUserAssessmentBaselineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UnsetUserAssessmentBaselineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UnsetUserAssessmentBaseline API.

UpdateAlert(UpdateAlertRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the status of the specified alert.

Declaration

public Task<UpdateAlertResponse> UpdateAlert(UpdateAlertRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAlertRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateAlertResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAlert API.

UpdateAlertPolicy(UpdateAlertPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified alert policy .

Declaration

public Task<UpdateAlertPolicyResponse> UpdateAlertPolicy(UpdateAlertPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAlertPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateAlertPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAlertPolicy API.

UpdateAlertPolicyRule(UpdateAlertPolicyRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified alert policy rule.

Declaration

public Task<UpdateAlertPolicyRuleResponse> UpdateAlertPolicyRule(UpdateAlertPolicyRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAlertPolicyRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateAlertPolicyRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAlertPolicyRule API.

UpdateAuditArchiveRetrieval(UpdateAuditArchiveRetrievalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the audit archive retrieval.

Declaration

public Task<UpdateAuditArchiveRetrievalResponse> UpdateAuditArchiveRetrieval(UpdateAuditArchiveRetrievalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAuditArchiveRetrievalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateAuditArchiveRetrievalResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAuditArchiveRetrieval API.

UpdateAuditPolicy(UpdateAuditPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the audit policy.

Declaration

public Task<UpdateAuditPolicyResponse> UpdateAuditPolicy(UpdateAuditPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAuditPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateAuditPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAuditPolicy API.

UpdateAuditProfile(UpdateAuditProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified audit profile.

Declaration

public Task<UpdateAuditProfileResponse> UpdateAuditProfile(UpdateAuditProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAuditProfileRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateAuditProfileResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAuditProfile API.

UpdateAuditTrail(UpdateAuditTrailRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified audit trail.

Declaration

public Task<UpdateAuditTrailResponse> UpdateAuditTrail(UpdateAuditTrailRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAuditTrailRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateAuditTrailResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAuditTrail API.

UpdateDataSafePrivateEndpoint(UpdateDataSafePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified Data Safe private endpoint.

Declaration

public Task<UpdateDataSafePrivateEndpointResponse> UpdateDataSafePrivateEndpoint(UpdateDataSafePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDataSafePrivateEndpointRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDataSafePrivateEndpointResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDataSafePrivateEndpoint API.

UpdateDatabaseSecurityConfig(UpdateDatabaseSecurityConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the database security configuration.

Declaration

public Task<UpdateDatabaseSecurityConfigResponse> UpdateDatabaseSecurityConfig(UpdateDatabaseSecurityConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDatabaseSecurityConfigRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDatabaseSecurityConfigResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDatabaseSecurityConfig API.

UpdateFinding(UpdateFindingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified finding.

Declaration

public Task<UpdateFindingResponse> UpdateFinding(UpdateFindingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateFindingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateFindingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateFinding API.

UpdateLibraryMaskingFormat(UpdateLibraryMaskingFormatRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified library masking format. Note that updating the formatEntries attribute replaces all the existing masking format entries with the specified format entries.

Declaration

public Task<UpdateLibraryMaskingFormatResponse> UpdateLibraryMaskingFormat(UpdateLibraryMaskingFormatRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateLibraryMaskingFormatRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateLibraryMaskingFormatResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateLibraryMaskingFormat API.

UpdateMaskingColumn(UpdateMaskingColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified masking column. Note that updating the maskingFormats attribute replaces the currently assigned masking formats with the specified masking formats.

Declaration

public Task<UpdateMaskingColumnResponse> UpdateMaskingColumn(UpdateMaskingColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateMaskingColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateMaskingColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateMaskingColumn API.

UpdateMaskingPolicy(UpdateMaskingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified masking policy.

Declaration

public Task<UpdateMaskingPolicyResponse> UpdateMaskingPolicy(UpdateMaskingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateMaskingPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateMaskingPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateMaskingPolicy API.

UpdateOnPremConnector(UpdateOnPremConnectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified on-premises connector.

Declaration

public Task<UpdateOnPremConnectorResponse> UpdateOnPremConnector(UpdateOnPremConnectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOnPremConnectorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateOnPremConnectorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateOnPremConnector API.

UpdateOnPremConnectorWallet(UpdateOnPremConnectorWalletRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the wallet for the specified on-premises connector to a new version.

Declaration

public Task<UpdateOnPremConnectorWalletResponse> UpdateOnPremConnectorWallet(UpdateOnPremConnectorWalletRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOnPremConnectorWalletRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateOnPremConnectorWalletResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateOnPremConnectorWallet API.

UpdatePeerTargetDatabase(UpdatePeerTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified Data Safe peer target database.

Declaration

public Task<UpdatePeerTargetDatabaseResponse> UpdatePeerTargetDatabase(UpdatePeerTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdatePeerTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdatePeerTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdatePeerTargetDatabase API.

UpdateReport(UpdateReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified report. Only tags can be updated.

Declaration

public Task<UpdateReportResponse> UpdateReport(UpdateReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateReport API.

UpdateReportDefinition(UpdateReportDefinitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified report definition. Only user created report definition can be updated. Seeded report definitions need to be saved as new report definition first.

Declaration

public Task<UpdateReportDefinitionResponse> UpdateReportDefinition(UpdateReportDefinitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateReportDefinitionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateReportDefinitionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateReportDefinition API.

UpdateSdmMaskingPolicyDifference(UpdateSdmMaskingPolicyDifferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified sdm masking policy difference.

Declaration

public Task<UpdateSdmMaskingPolicyDifferenceResponse> UpdateSdmMaskingPolicyDifference(UpdateSdmMaskingPolicyDifferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSdmMaskingPolicyDifferenceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSdmMaskingPolicyDifferenceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSdmMaskingPolicyDifference API.

UpdateSecurityAssessment(UpdateSecurityAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified security assessment. This operation allows to update the security assessment displayName, description, or schedule.

Declaration

public Task<UpdateSecurityAssessmentResponse> UpdateSecurityAssessment(UpdateSecurityAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSecurityAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSecurityAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSecurityAssessment API.

UpdateSecurityPolicy(UpdateSecurityPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the security policy.

Declaration

public Task<UpdateSecurityPolicyResponse> UpdateSecurityPolicy(UpdateSecurityPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSecurityPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSecurityPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSecurityPolicy API.

UpdateSecurityPolicyDeployment(UpdateSecurityPolicyDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the security policy deployment.

Declaration

public Task<UpdateSecurityPolicyDeploymentResponse> UpdateSecurityPolicyDeployment(UpdateSecurityPolicyDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSecurityPolicyDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSecurityPolicyDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSecurityPolicyDeployment API.

UpdateSensitiveColumn(UpdateSensitiveColumnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified sensitive column.

Declaration

public Task<UpdateSensitiveColumnResponse> UpdateSensitiveColumn(UpdateSensitiveColumnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSensitiveColumnRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSensitiveColumnResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSensitiveColumn API.

UpdateSensitiveDataModel(UpdateSensitiveDataModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified sensitive data model. Note that updating any attribute of a sensitive data model does not perform data discovery.

Declaration

public Task<UpdateSensitiveDataModelResponse> UpdateSensitiveDataModel(UpdateSensitiveDataModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSensitiveDataModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSensitiveDataModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSensitiveDataModel API.

UpdateSensitiveType(UpdateSensitiveTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified sensitive type.

Declaration

public Task<UpdateSensitiveTypeResponse> UpdateSensitiveType(UpdateSensitiveTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSensitiveTypeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSensitiveTypeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSensitiveType API.

UpdateSqlCollection(UpdateSqlCollectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the SQL collection.

Declaration

public Task<UpdateSqlCollectionResponse> UpdateSqlCollection(UpdateSqlCollectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSqlCollectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSqlCollectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSqlCollection API.

UpdateSqlFirewallPolicy(UpdateSqlFirewallPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the SQL Firewall policy.

Declaration

public Task<UpdateSqlFirewallPolicyResponse> UpdateSqlFirewallPolicy(UpdateSqlFirewallPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSqlFirewallPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSqlFirewallPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSqlFirewallPolicy API.

UpdateTargetAlertPolicyAssociation(UpdateTargetAlertPolicyAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified target-alert policy association.

Declaration

public Task<UpdateTargetAlertPolicyAssociationResponse> UpdateTargetAlertPolicyAssociation(UpdateTargetAlertPolicyAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateTargetAlertPolicyAssociationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateTargetAlertPolicyAssociationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateTargetAlertPolicyAssociation API.

UpdateTargetDatabase(UpdateTargetDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified Data Safe target database.

Declaration

public Task<UpdateTargetDatabaseResponse> UpdateTargetDatabase(UpdateTargetDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateTargetDatabaseRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateTargetDatabaseResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateTargetDatabase API.

UpdateUserAssessment(UpdateUserAssessmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates one or more attributes of the specified user assessment. This operation allows to update the user assessment displayName, description, or schedule.

Declaration

public Task<UpdateUserAssessmentResponse> UpdateUserAssessment(UpdateUserAssessmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateUserAssessmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateUserAssessmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateUserAssessment API.

UploadMaskingPolicy(UploadMaskingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Uploads a masking policy file (also called template) to update the specified masking policy. To create a new masking policy using a file, first use the CreateMaskingPolicy operation to create an empty masking policy and then use this endpoint to upload the masking policy file. Note that the upload operation replaces the content of the specified masking policy, including all the existing columns and masking formats, with the content of the file.

Declaration

public Task<UploadMaskingPolicyResponse> UploadMaskingPolicy(UploadMaskingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UploadMaskingPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UploadMaskingPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UploadMaskingPolicy API.

UploadSensitiveDataModel(UploadSensitiveDataModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Uploads a sensitive data model file (also called template) to update the specified sensitive data model. To create a new sensitive data model using a file, first use the CreateSensitiveDataModel operation to create an empty data model and then use this endpoint to upload the data model file. Note that the upload operation replaces the content of the specified sensitive data model, including all the existing columns and their relationships, with the content of the file.

Declaration

public Task<UploadSensitiveDataModelResponse> UploadSensitiveDataModel(UploadSensitiveDataModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UploadSensitiveDataModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UploadSensitiveDataModelResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UploadSensitiveDataModel API.

Implements

IDisposable