Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getMaskingReports

This data source provides the list of Masking Reports in Oracle Cloud Infrastructure Data Safe service.

Gets a list of masking reports based on the specified query parameters.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testMaskingReports = Output.Create(Oci.DataSafe.GetMaskingReports.InvokeAsync(new Oci.DataSafe.GetMaskingReportsArgs
        {
            CompartmentId = @var.Compartment_id,
            AccessLevel = @var.Masking_report_access_level,
            CompartmentIdInSubtree = @var.Masking_report_compartment_id_in_subtree,
            MaskingPolicyId = oci_data_safe_masking_policy.Test_masking_policy.Id,
            TargetId = oci_cloud_guard_target.Test_target.Id,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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:          _var.Compartment_id,
			AccessLevel:            pulumi.StringRef(_var.Masking_report_access_level),
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Masking_report_compartment_id_in_subtree),
			MaskingPolicyId:        pulumi.StringRef(oci_data_safe_masking_policy.Test_masking_policy.Id),
			TargetId:               pulumi.StringRef(oci_cloud_guard_target.Test_target.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_masking_reports = oci.DataSafe.get_masking_reports(compartment_id=var["compartment_id"],
    access_level=var["masking_report_access_level"],
    compartment_id_in_subtree=var["masking_report_compartment_id_in_subtree"],
    masking_policy_id=oci_data_safe_masking_policy["test_masking_policy"]["id"],
    target_id=oci_cloud_guard_target["test_target"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMaskingReports = oci.DataSafe.getMaskingReports({
    compartmentId: _var.compartment_id,
    accessLevel: _var.masking_report_access_level,
    compartmentIdInSubtree: _var.masking_report_compartment_id_in_subtree,
    maskingPolicyId: oci_data_safe_masking_policy.test_masking_policy.id,
    targetId: oci_cloud_guard_target.test_target.id,
});

Coming soon!

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[_datasafe.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[_datasafe.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)
// Output-based functions aren't available in Java yet
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 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 GetMaskingReportsMaskingReportCollection]

The list of masking_report_collection.

access_level str
compartment_id_in_subtree bool
filters 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

GetMaskingReportsMaskingReportCollectionItem

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

Id string

The OCID of the masking report.

MaskingPolicyId string

A filter to return only the resources that match the specified masking policy OCID.

MaskingWorkRequestId string

The OCID of the masking work request that resulted in this masking report.

TargetId string

A filter to return only items related to a specific target OCID.

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.

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

Id string

The OCID of the masking report.

MaskingPolicyId string

A filter to return only the resources that match the specified masking policy OCID.

MaskingWorkRequestId string

The OCID of the masking work request that resulted in this masking report.

TargetId string

A filter to return only items related to a specific target OCID.

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.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

id String

The OCID of the masking report.

maskingPolicyId String

A filter to return only the resources that match the specified masking policy OCID.

maskingWorkRequestId String

The OCID of the masking work request that resulted in this masking report.

targetId String

A filter to return only items related to a specific target OCID.

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.

compartmentId string

A filter to return only resources that match the specified compartment OCID.

id string

The OCID of the masking report.

maskingPolicyId string

A filter to return only the resources that match the specified masking policy OCID.

maskingWorkRequestId string

The OCID of the masking work request that resulted in this masking report.

targetId string

A filter to return only items related to a specific target OCID.

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.

compartment_id str

A filter to return only resources that match the specified compartment OCID.

id str

The OCID of the masking report.

masking_policy_id str

A filter to return only the resources that match the specified masking policy OCID.

masking_work_request_id str

The OCID of the masking work request that resulted in this masking report.

target_id str

A filter to return only items related to a specific target OCID.

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.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

id String

The OCID of the masking report.

maskingPolicyId String

A filter to return only the resources that match the specified masking policy OCID.

maskingWorkRequestId String

The OCID of the masking work request that resulted in this masking report.

targetId String

A filter to return only items related to a specific target OCID.

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.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.