Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.DataSafe.getMaskingReports

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMaskingReports = oci.DataSafe.getMaskingReports({
    compartmentId: compartmentId,
    accessLevel: maskingReportAccessLevel,
    compartmentIdInSubtree: maskingReportCompartmentIdInSubtree,
    maskingPolicyId: testMaskingPolicy.id,
    targetId: testTarget.id,
});

import pulumi
import pulumi_oci as oci

test_masking_reports = oci.DataSafe.get_masking_reports(compartment_id=compartment_id,
    access_level=masking_report_access_level,
    compartment_id_in_subtree=masking_report_compartment_id_in_subtree,
    masking_policy_id=test_masking_policy["id"],
    target_id=test_target["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/datasafe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasafe.GetMaskingReports(ctx, &datasafe.GetMaskingReportsArgs{
			CompartmentId:          compartmentId,
			AccessLevel:            pulumi.StringRef(maskingReportAccessLevel),
			CompartmentIdInSubtree: pulumi.BoolRef(maskingReportCompartmentIdInSubtree),
			MaskingPolicyId:        pulumi.StringRef(testMaskingPolicy.Id),
			TargetId:               pulumi.StringRef(testTarget.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testMaskingReports = Oci.DataSafe.GetMaskingReports.Invoke(new()
    {
        CompartmentId = compartmentId,
        AccessLevel = maskingReportAccessLevel,
        CompartmentIdInSubtree = maskingReportCompartmentIdInSubtree,
        MaskingPolicyId = testMaskingPolicy.Id,
        TargetId = testTarget.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DataSafeFunctions;
import com.pulumi.oci.DataSafe.inputs.GetMaskingReportsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testMaskingReports = DataSafeFunctions.getMaskingReports(GetMaskingReportsArgs.builder()
            .compartmentId(compartmentId)
            .accessLevel(maskingReportAccessLevel)
            .compartmentIdInSubtree(maskingReportCompartmentIdInSubtree)
            .maskingPolicyId(testMaskingPolicy.id())
            .targetId(testTarget.id())
            .build());

    }
}

variables:
  testMaskingReports:
    fn::invoke:
      function: oci:DataSafe:getMaskingReports
      arguments:
        compartmentId: ${compartmentId}
        accessLevel: ${maskingReportAccessLevel}
        compartmentIdInSubtree: ${maskingReportCompartmentIdInSubtree}
        maskingPolicyId: ${testMaskingPolicy.id}
        targetId: ${testTarget.id}

Using getMaskingReports

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMaskingReports(args: GetMaskingReportsArgs, opts?: InvokeOptions): Promise<GetMaskingReportsResult>
function getMaskingReportsOutput(args: GetMaskingReportsOutputArgs, opts?: InvokeOptions): Output<GetMaskingReportsResult>

def get_masking_reports(access_level: Optional[str] = None,
                        compartment_id: Optional[str] = None,
                        compartment_id_in_subtree: Optional[bool] = None,
                        filters: Optional[Sequence[GetMaskingReportsFilter]] = None,
                        masking_policy_id: Optional[str] = None,
                        target_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetMaskingReportsResult
def get_masking_reports_output(access_level: Optional[pulumi.Input[str]] = None,
                        compartment_id: Optional[pulumi.Input[str]] = None,
                        compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetMaskingReportsFilterArgs]]]] = None,
                        masking_policy_id: Optional[pulumi.Input[str]] = None,
                        target_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetMaskingReportsResult]

func GetMaskingReports(ctx *Context, args *GetMaskingReportsArgs, opts ...InvokeOption) (*GetMaskingReportsResult, error)
func GetMaskingReportsOutput(ctx *Context, args *GetMaskingReportsOutputArgs, opts ...InvokeOption) GetMaskingReportsResultOutput

> Note: This function is named GetMaskingReports in the Go SDK.

public static class GetMaskingReports 
{
    public static Task<GetMaskingReportsResult> InvokeAsync(GetMaskingReportsArgs args, InvokeOptions? opts = null)
    public static Output<GetMaskingReportsResult> Invoke(GetMaskingReportsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMaskingReportsResult> getMaskingReports(GetMaskingReportsArgs args, InvokeOptions options)
public static Output<GetMaskingReportsResult> getMaskingReports(GetMaskingReportsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DataSafe/getMaskingReports:getMaskingReports
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: A filter to return only resources that match the specified compartment OCID.
AccessLevel string: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
CompartmentIdInSubtree bool: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
Filters List<GetMaskingReportsFilter>
MaskingPolicyId string: A filter to return only the resources that match the specified masking policy OCID.
TargetId string: A filter to return only items related to a specific target OCID.

CompartmentId string: A filter to return only resources that match the specified compartment OCID.
AccessLevel string: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
CompartmentIdInSubtree bool: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
Filters []GetMaskingReportsFilter
MaskingPolicyId string: A filter to return only the resources that match the specified masking policy OCID.
TargetId string: A filter to return only items related to a specific target OCID.

compartmentId String: A filter to return only resources that match the specified compartment OCID.
accessLevel String: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
compartmentIdInSubtree Boolean: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
filters List<GetMaskingReportsFilter>
maskingPolicyId String: A filter to return only the resources that match the specified masking policy OCID.
targetId String: A filter to return only items related to a specific target OCID.

compartmentId string: A filter to return only resources that match the specified compartment OCID.
accessLevel string: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
compartmentIdInSubtree boolean: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
filters GetMaskingReportsFilter[]
maskingPolicyId string: A filter to return only the resources that match the specified masking policy OCID.
targetId string: A filter to return only items related to a specific target OCID.

compartment_id str: A filter to return only resources that match the specified compartment OCID.
access_level str: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
compartment_id_in_subtree bool: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
filters Sequence[GetMaskingReportsFilter]
masking_policy_id str: A filter to return only the resources that match the specified masking policy OCID.
target_id str: A filter to return only items related to a specific target OCID.

compartmentId String: A filter to return only resources that match the specified compartment OCID.
accessLevel String: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
compartmentIdInSubtree Boolean: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
filters List<Property Map>
maskingPolicyId String: A filter to return only the resources that match the specified masking policy OCID.
targetId String: A filter to return only items related to a specific target OCID.

getMaskingReports Result

The following output properties are available:

CompartmentId string: The OCID of the compartment that contains the masking report.
Id string: The provider-assigned unique ID for this managed resource.
MaskingReportCollections List<GetMaskingReportsMaskingReportCollection>: The list of masking_report_collection.
AccessLevel string
CompartmentIdInSubtree bool
Filters List<GetMaskingReportsFilter>
MaskingPolicyId string: The OCID of the masking policy used.
TargetId string: The OCID of the target database masked.

CompartmentId string: The OCID of the compartment that contains the masking report.
Id string: The provider-assigned unique ID for this managed resource.
MaskingReportCollections []GetMaskingReportsMaskingReportCollection: The list of masking_report_collection.
AccessLevel string
CompartmentIdInSubtree bool
Filters []GetMaskingReportsFilter
MaskingPolicyId string: The OCID of the masking policy used.
TargetId string: The OCID of the target database masked.

compartmentId String: The OCID of the compartment that contains the masking report.
id String: The provider-assigned unique ID for this managed resource.
maskingReportCollections List<GetMaskingReportsMaskingReportCollection>: The list of masking_report_collection.
accessLevel String
compartmentIdInSubtree Boolean
filters List<GetMaskingReportsFilter>
maskingPolicyId String: The OCID of the masking policy used.
targetId String: The OCID of the target database masked.

compartmentId string: The OCID of the compartment that contains the masking report.
id string: The provider-assigned unique ID for this managed resource.
maskingReportCollections GetMaskingReportsMaskingReportCollection[]: The list of masking_report_collection.
accessLevel string
compartmentIdInSubtree boolean
filters GetMaskingReportsFilter[]
maskingPolicyId string: The OCID of the masking policy used.
targetId string: The OCID of the target database masked.

compartment_id str: The OCID of the compartment that contains the masking report.
id str: The provider-assigned unique ID for this managed resource.
masking_report_collections Sequence[GetMaskingReportsMaskingReportCollection]: The list of masking_report_collection.
access_level str
compartment_id_in_subtree bool
filters Sequence[GetMaskingReportsFilter]
masking_policy_id str: The OCID of the masking policy used.
target_id str: The OCID of the target database masked.

compartmentId String: The OCID of the compartment that contains the masking report.
id String: The provider-assigned unique ID for this managed resource.
maskingReportCollections List<Property Map>: The list of masking_report_collection.
accessLevel String
compartmentIdInSubtree Boolean
filters List<Property Map>
maskingPolicyId String: The OCID of the masking policy used.
targetId String: The OCID of the target database masked.

Supporting Types

GetMaskingReportsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetMaskingReportsMaskingReportCollection

Items List<GetMaskingReportsMaskingReportCollectionItem>

Items []GetMaskingReportsMaskingReportCollectionItem

items List<GetMaskingReportsMaskingReportCollectionItem>

items GetMaskingReportsMaskingReportCollectionItem[]

items Sequence[GetMaskingReportsMaskingReportCollectionItem]

items List<Property Map>

GetMaskingReportsMaskingReportCollectionItem

CompartmentId string: A filter to return only resources that match the specified compartment OCID.
Id string: The OCID of the masking report.
IsDropTempTablesEnabled bool: Indicates if the temporary tables created during the masking operation were dropped after masking.
IsRedoLoggingEnabled bool: Indicates if redo logging was enabled during the masking operation.
IsRefreshStatsEnabled bool: Indicates if statistics gathering was enabled during the masking operation.
MaskingPolicyId string: A filter to return only the resources that match the specified masking policy OCID.
MaskingStatus string: The status of the masking job.
MaskingWorkRequestId string: The OCID of the masking work request that resulted in this masking report.
ParallelDegree string: Indicates if parallel execution was enabled during the masking operation.
Recompile string: Indicates how invalid objects were recompiled post the masking operation.
State string: The current state of the masking report.
TargetId string: A filter to return only items related to a specific target OCID.
TimeCreated string: The date and time the masking report was created, in the format defined by RFC3339.
TimeMaskingFinished string: The date and time data masking finished, in the format defined by RFC3339
TimeMaskingStarted string: The date and time data masking started, in the format defined by RFC3339
TotalMaskedColumns string: The total number of masked columns.
TotalMaskedObjects string: The total number of unique objects (tables and editioning views) that contain the masked columns.
TotalMaskedSchemas string: The total number of unique schemas that contain the masked columns.
TotalMaskedSensitiveTypes string: The total number of unique sensitive types associated with the masked columns.
TotalMaskedValues string: The total number of masked values.
TotalPostMaskingScriptErrors string: The total number of errors in post-masking script.
TotalPreMaskingScriptErrors string: The total number of errors in pre-masking script.

CompartmentId string: A filter to return only resources that match the specified compartment OCID.
Id string: The OCID of the masking report.
IsDropTempTablesEnabled bool: Indicates if the temporary tables created during the masking operation were dropped after masking.
IsRedoLoggingEnabled bool: Indicates if redo logging was enabled during the masking operation.
IsRefreshStatsEnabled bool: Indicates if statistics gathering was enabled during the masking operation.
MaskingPolicyId string: A filter to return only the resources that match the specified masking policy OCID.
MaskingStatus string: The status of the masking job.
MaskingWorkRequestId string: The OCID of the masking work request that resulted in this masking report.
ParallelDegree string: Indicates if parallel execution was enabled during the masking operation.
Recompile string: Indicates how invalid objects were recompiled post the masking operation.
State string: The current state of the masking report.
TargetId string: A filter to return only items related to a specific target OCID.
TimeCreated string: The date and time the masking report was created, in the format defined by RFC3339.
TimeMaskingFinished string: The date and time data masking finished, in the format defined by RFC3339
TimeMaskingStarted string: The date and time data masking started, in the format defined by RFC3339
TotalMaskedColumns string: The total number of masked columns.
TotalMaskedObjects string: The total number of unique objects (tables and editioning views) that contain the masked columns.
TotalMaskedSchemas string: The total number of unique schemas that contain the masked columns.
TotalMaskedSensitiveTypes string: The total number of unique sensitive types associated with the masked columns.
TotalMaskedValues string: The total number of masked values.
TotalPostMaskingScriptErrors string: The total number of errors in post-masking script.
TotalPreMaskingScriptErrors string: The total number of errors in pre-masking script.

compartmentId String: A filter to return only resources that match the specified compartment OCID.
id String: The OCID of the masking report.
isDropTempTablesEnabled Boolean: Indicates if the temporary tables created during the masking operation were dropped after masking.
isRedoLoggingEnabled Boolean: Indicates if redo logging was enabled during the masking operation.
isRefreshStatsEnabled Boolean: Indicates if statistics gathering was enabled during the masking operation.
maskingPolicyId String: A filter to return only the resources that match the specified masking policy OCID.
maskingStatus String: The status of the masking job.
maskingWorkRequestId String: The OCID of the masking work request that resulted in this masking report.
parallelDegree String: Indicates if parallel execution was enabled during the masking operation.
recompile String: Indicates how invalid objects were recompiled post the masking operation.
state String: The current state of the masking report.
targetId String: A filter to return only items related to a specific target OCID.
timeCreated String: The date and time the masking report was created, in the format defined by RFC3339.
timeMaskingFinished String: The date and time data masking finished, in the format defined by RFC3339
timeMaskingStarted String: The date and time data masking started, in the format defined by RFC3339
totalMaskedColumns String: The total number of masked columns.
totalMaskedObjects String: The total number of unique objects (tables and editioning views) that contain the masked columns.
totalMaskedSchemas String: The total number of unique schemas that contain the masked columns.
totalMaskedSensitiveTypes String: The total number of unique sensitive types associated with the masked columns.
totalMaskedValues String: The total number of masked values.
totalPostMaskingScriptErrors String: The total number of errors in post-masking script.
totalPreMaskingScriptErrors String: The total number of errors in pre-masking script.

compartmentId string: A filter to return only resources that match the specified compartment OCID.
id string: The OCID of the masking report.
isDropTempTablesEnabled boolean: Indicates if the temporary tables created during the masking operation were dropped after masking.
isRedoLoggingEnabled boolean: Indicates if redo logging was enabled during the masking operation.
isRefreshStatsEnabled boolean: Indicates if statistics gathering was enabled during the masking operation.
maskingPolicyId string: A filter to return only the resources that match the specified masking policy OCID.
maskingStatus string: The status of the masking job.
maskingWorkRequestId string: The OCID of the masking work request that resulted in this masking report.
parallelDegree string: Indicates if parallel execution was enabled during the masking operation.
recompile string: Indicates how invalid objects were recompiled post the masking operation.
state string: The current state of the masking report.
targetId string: A filter to return only items related to a specific target OCID.
timeCreated string: The date and time the masking report was created, in the format defined by RFC3339.
timeMaskingFinished string: The date and time data masking finished, in the format defined by RFC3339
timeMaskingStarted string: The date and time data masking started, in the format defined by RFC3339
totalMaskedColumns string: The total number of masked columns.
totalMaskedObjects string: The total number of unique objects (tables and editioning views) that contain the masked columns.
totalMaskedSchemas string: The total number of unique schemas that contain the masked columns.
totalMaskedSensitiveTypes string: The total number of unique sensitive types associated with the masked columns.
totalMaskedValues string: The total number of masked values.
totalPostMaskingScriptErrors string: The total number of errors in post-masking script.
totalPreMaskingScriptErrors string: The total number of errors in pre-masking script.

compartment_id str: A filter to return only resources that match the specified compartment OCID.
id str: The OCID of the masking report.
is_drop_temp_tables_enabled bool: Indicates if the temporary tables created during the masking operation were dropped after masking.
is_redo_logging_enabled bool: Indicates if redo logging was enabled during the masking operation.
is_refresh_stats_enabled bool: Indicates if statistics gathering was enabled during the masking operation.
masking_policy_id str: A filter to return only the resources that match the specified masking policy OCID.
masking_status str: The status of the masking job.
masking_work_request_id str: The OCID of the masking work request that resulted in this masking report.
parallel_degree str: Indicates if parallel execution was enabled during the masking operation.
recompile str: Indicates how invalid objects were recompiled post the masking operation.
state str: The current state of the masking report.
target_id str: A filter to return only items related to a specific target OCID.
time_created str: The date and time the masking report was created, in the format defined by RFC3339.
time_masking_finished str: The date and time data masking finished, in the format defined by RFC3339
time_masking_started str: The date and time data masking started, in the format defined by RFC3339
total_masked_columns str: The total number of masked columns.
total_masked_objects str: The total number of unique objects (tables and editioning views) that contain the masked columns.
total_masked_schemas str: The total number of unique schemas that contain the masked columns.
total_masked_sensitive_types str: The total number of unique sensitive types associated with the masked columns.
total_masked_values str: The total number of masked values.
total_post_masking_script_errors str: The total number of errors in post-masking script.
total_pre_masking_script_errors str: The total number of errors in pre-masking script.

compartmentId String: A filter to return only resources that match the specified compartment OCID.
id String: The OCID of the masking report.
isDropTempTablesEnabled Boolean: Indicates if the temporary tables created during the masking operation were dropped after masking.
isRedoLoggingEnabled Boolean: Indicates if redo logging was enabled during the masking operation.
isRefreshStatsEnabled Boolean: Indicates if statistics gathering was enabled during the masking operation.
maskingPolicyId String: A filter to return only the resources that match the specified masking policy OCID.
maskingStatus String: The status of the masking job.
maskingWorkRequestId String: The OCID of the masking work request that resulted in this masking report.
parallelDegree String: Indicates if parallel execution was enabled during the masking operation.
recompile String: Indicates how invalid objects were recompiled post the masking operation.
state String: The current state of the masking report.
targetId String: A filter to return only items related to a specific target OCID.
timeCreated String: The date and time the masking report was created, in the format defined by RFC3339.
timeMaskingFinished String: The date and time data masking finished, in the format defined by RFC3339
timeMaskingStarted String: The date and time data masking started, in the format defined by RFC3339
totalMaskedColumns String: The total number of masked columns.
totalMaskedObjects String: The total number of unique objects (tables and editioning views) that contain the masked columns.
totalMaskedSchemas String: The total number of unique schemas that contain the masked columns.
totalMaskedSensitiveTypes String: The total number of unique sensitive types associated with the masked columns.
totalMaskedValues String: The total number of masked values.
totalPostMaskingScriptErrors String: The total number of errors in post-masking script.
totalPreMaskingScriptErrors String: The total number of errors in pre-masking script.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataSafe.getMaskingReports

On this page

On this page

Example Usage

Using getMaskingReports

getMaskingReports Result

Supporting Types

GetMaskingReportsFilter

GetMaskingReportsMaskingReportCollection

GetMaskingReportsMaskingReportCollectionItem

Package Details

On this page

On this page