Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.DataSafe.getSecurityPolicyReports

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

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.

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.

Example Usage

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

const testSecurityPolicyReports = oci.DataSafe.getSecurityPolicyReports({
    compartmentId: compartmentId,
    accessLevel: securityPolicyReportAccessLevel,
    compartmentIdInSubtree: securityPolicyReportCompartmentIdInSubtree,
    displayName: securityPolicyReportDisplayName,
    securityPolicyReportId: testSecurityPolicyReport.id,
    state: securityPolicyReportState,
    targetId: testTarget.id,
});

import pulumi
import pulumi_oci as oci

test_security_policy_reports = oci.DataSafe.get_security_policy_reports(compartment_id=compartment_id,
    access_level=security_policy_report_access_level,
    compartment_id_in_subtree=security_policy_report_compartment_id_in_subtree,
    display_name=security_policy_report_display_name,
    security_policy_report_id=test_security_policy_report["id"],
    state=security_policy_report_state,
    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.GetSecurityPolicyReports(ctx, &datasafe.GetSecurityPolicyReportsArgs{
			CompartmentId:          compartmentId,
			AccessLevel:            pulumi.StringRef(securityPolicyReportAccessLevel),
			CompartmentIdInSubtree: pulumi.BoolRef(securityPolicyReportCompartmentIdInSubtree),
			DisplayName:            pulumi.StringRef(securityPolicyReportDisplayName),
			SecurityPolicyReportId: pulumi.StringRef(testSecurityPolicyReport.Id),
			State:                  pulumi.StringRef(securityPolicyReportState),
			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 testSecurityPolicyReports = Oci.DataSafe.GetSecurityPolicyReports.Invoke(new()
    {
        CompartmentId = compartmentId,
        AccessLevel = securityPolicyReportAccessLevel,
        CompartmentIdInSubtree = securityPolicyReportCompartmentIdInSubtree,
        DisplayName = securityPolicyReportDisplayName,
        SecurityPolicyReportId = testSecurityPolicyReport.Id,
        State = securityPolicyReportState,
        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.GetSecurityPolicyReportsArgs;
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 testSecurityPolicyReports = DataSafeFunctions.getSecurityPolicyReports(GetSecurityPolicyReportsArgs.builder()
            .compartmentId(compartmentId)
            .accessLevel(securityPolicyReportAccessLevel)
            .compartmentIdInSubtree(securityPolicyReportCompartmentIdInSubtree)
            .displayName(securityPolicyReportDisplayName)
            .securityPolicyReportId(testSecurityPolicyReport.id())
            .state(securityPolicyReportState)
            .targetId(testTarget.id())
            .build());

    }
}

variables:
  testSecurityPolicyReports:
    fn::invoke:
      Function: oci:DataSafe:getSecurityPolicyReports
      Arguments:
        compartmentId: ${compartmentId}
        accessLevel: ${securityPolicyReportAccessLevel}
        compartmentIdInSubtree: ${securityPolicyReportCompartmentIdInSubtree}
        displayName: ${securityPolicyReportDisplayName}
        securityPolicyReportId: ${testSecurityPolicyReport.id}
        state: ${securityPolicyReportState}
        targetId: ${testTarget.id}

Using getSecurityPolicyReports

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 getSecurityPolicyReports(args: GetSecurityPolicyReportsArgs, opts?: InvokeOptions): Promise<GetSecurityPolicyReportsResult>
function getSecurityPolicyReportsOutput(args: GetSecurityPolicyReportsOutputArgs, opts?: InvokeOptions): Output<GetSecurityPolicyReportsResult>

def get_security_policy_reports(access_level: Optional[str] = None,
                                compartment_id: Optional[str] = None,
                                compartment_id_in_subtree: Optional[bool] = None,
                                display_name: Optional[str] = None,
                                filters: Optional[Sequence[_datasafe.GetSecurityPolicyReportsFilter]] = None,
                                security_policy_report_id: Optional[str] = None,
                                state: Optional[str] = None,
                                target_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetSecurityPolicyReportsResult
def get_security_policy_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,
                                display_name: Optional[pulumi.Input[str]] = None,
                                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datasafe.GetSecurityPolicyReportsFilterArgs]]]] = None,
                                security_policy_report_id: Optional[pulumi.Input[str]] = None,
                                state: Optional[pulumi.Input[str]] = None,
                                target_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetSecurityPolicyReportsResult]

func GetSecurityPolicyReports(ctx *Context, args *GetSecurityPolicyReportsArgs, opts ...InvokeOption) (*GetSecurityPolicyReportsResult, error)
func GetSecurityPolicyReportsOutput(ctx *Context, args *GetSecurityPolicyReportsOutputArgs, opts ...InvokeOption) GetSecurityPolicyReportsResultOutput

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

public static class GetSecurityPolicyReports 
{
    public static Task<GetSecurityPolicyReportsResult> InvokeAsync(GetSecurityPolicyReportsArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityPolicyReportsResult> Invoke(GetSecurityPolicyReportsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSecurityPolicyReportsResult> getSecurityPolicyReports(GetSecurityPolicyReportsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DataSafe/getSecurityPolicyReports:getSecurityPolicyReports
  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.
DisplayName string: A filter to return only resources that match the specified display name.
Filters List<GetSecurityPolicyReportsFilter>
SecurityPolicyReportId string: An optional filter to return only resources that match the specified OCID of the security policy report resource.
State string: The current state of the security policy report.
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.
DisplayName string: A filter to return only resources that match the specified display name.
Filters []GetSecurityPolicyReportsFilter
SecurityPolicyReportId string: An optional filter to return only resources that match the specified OCID of the security policy report resource.
State string: The current state of the security policy report.
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.
displayName String: A filter to return only resources that match the specified display name.
filters List<GetSecurityPolicyReportsFilter>
securityPolicyReportId String: An optional filter to return only resources that match the specified OCID of the security policy report resource.
state String: The current state of the security policy report.
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.
displayName string: A filter to return only resources that match the specified display name.
filters GetSecurityPolicyReportsFilter[]
securityPolicyReportId string: An optional filter to return only resources that match the specified OCID of the security policy report resource.
state string: The current state of the security policy report.
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.
display_name str: A filter to return only resources that match the specified display name.
filters Sequence[datasafe.GetSecurityPolicyReportsFilter]
security_policy_report_id str: An optional filter to return only resources that match the specified OCID of the security policy report resource.
state str: The current state of the security policy report.
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.
displayName String: A filter to return only resources that match the specified display name.
filters List<Property Map>
securityPolicyReportId String: An optional filter to return only resources that match the specified OCID of the security policy report resource.
state String: The current state of the security policy report.
targetId String: A filter to return only items related to a specific target OCID.

getSecurityPolicyReports Result

The following output properties are available:

CompartmentId string: The OCID of the compartment that contains the security policy report.
Id string: The provider-assigned unique ID for this managed resource.
SecurityPolicyReportCollections List<GetSecurityPolicyReportsSecurityPolicyReportCollection>: The list of security_policy_report_collection.
AccessLevel string
CompartmentIdInSubtree bool
DisplayName string: The display name of the security policy report.
Filters List<GetSecurityPolicyReportsFilter>
SecurityPolicyReportId string
State string: The current state of the security policy report.
TargetId string: The OCID of the of the target database.

CompartmentId string: The OCID of the compartment that contains the security policy report.
Id string: The provider-assigned unique ID for this managed resource.
SecurityPolicyReportCollections []GetSecurityPolicyReportsSecurityPolicyReportCollection: The list of security_policy_report_collection.
AccessLevel string
CompartmentIdInSubtree bool
DisplayName string: The display name of the security policy report.
Filters []GetSecurityPolicyReportsFilter
SecurityPolicyReportId string
State string: The current state of the security policy report.
TargetId string: The OCID of the of the target database.

compartmentId String: The OCID of the compartment that contains the security policy report.
id String: The provider-assigned unique ID for this managed resource.
securityPolicyReportCollections List<GetSecurityPolicyReportsSecurityPolicyReportCollection>: The list of security_policy_report_collection.
accessLevel String
compartmentIdInSubtree Boolean
displayName String: The display name of the security policy report.
filters List<GetSecurityPolicyReportsFilter>
securityPolicyReportId String
state String: The current state of the security policy report.
targetId String: The OCID of the of the target database.

compartmentId string: The OCID of the compartment that contains the security policy report.
id string: The provider-assigned unique ID for this managed resource.
securityPolicyReportCollections GetSecurityPolicyReportsSecurityPolicyReportCollection[]: The list of security_policy_report_collection.
accessLevel string
compartmentIdInSubtree boolean
displayName string: The display name of the security policy report.
filters GetSecurityPolicyReportsFilter[]
securityPolicyReportId string
state string: The current state of the security policy report.
targetId string: The OCID of the of the target database.

compartment_id str: The OCID of the compartment that contains the security policy report.
id str: The provider-assigned unique ID for this managed resource.
security_policy_report_collections Sequence[datasafe.GetSecurityPolicyReportsSecurityPolicyReportCollection]: The list of security_policy_report_collection.
access_level str
compartment_id_in_subtree bool
display_name str: The display name of the security policy report.
filters Sequence[datasafe.GetSecurityPolicyReportsFilter]
security_policy_report_id str
state str: The current state of the security policy report.
target_id str: The OCID of the of the target database.

compartmentId String: The OCID of the compartment that contains the security policy report.
id String: The provider-assigned unique ID for this managed resource.
securityPolicyReportCollections List<Property Map>: The list of security_policy_report_collection.
accessLevel String
compartmentIdInSubtree Boolean
displayName String: The display name of the security policy report.
filters List<Property Map>
securityPolicyReportId String
state String: The current state of the security policy report.
targetId String: The OCID of the of the target database.

Supporting Types

GetSecurityPolicyReportsFilter

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

GetSecurityPolicyReportsSecurityPolicyReportCollection

Items List<GetSecurityPolicyReportsSecurityPolicyReportCollectionItem>

Items []GetSecurityPolicyReportsSecurityPolicyReportCollectionItem

items List<GetSecurityPolicyReportsSecurityPolicyReportCollectionItem>

items GetSecurityPolicyReportsSecurityPolicyReportCollectionItem[]

items Sequence[datasafe.GetSecurityPolicyReportsSecurityPolicyReportCollectionItem]

items List<Property Map>

GetSecurityPolicyReportsSecurityPolicyReportCollectionItem

CompartmentId string: A filter to return only resources that match the specified compartment OCID.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
Description string: The description of the security policy report.
DisplayName string: A filter to return only resources that match the specified display name.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
Id string: The OCID of the security policy report.
LifecycleDetails string: Details about the current state of the security policy report.
State string: The current state of the security policy report.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TargetId string: A filter to return only items related to a specific target OCID.
TimeCreated string: The date and time the security policy report was created, in the format defined by RFC3339.
TimeUpdated string: The date and time the security policy report was last updated, in the format defined by RFC3339.

CompartmentId string: A filter to return only resources that match the specified compartment OCID.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
Description string: The description of the security policy report.
DisplayName string: A filter to return only resources that match the specified display name.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
Id string: The OCID of the security policy report.
LifecycleDetails string: Details about the current state of the security policy report.
State string: The current state of the security policy report.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TargetId string: A filter to return only items related to a specific target OCID.
TimeCreated string: The date and time the security policy report was created, in the format defined by RFC3339.
TimeUpdated string: The date and time the security policy report was last updated, in the format defined by RFC3339.

compartmentId String: A filter to return only resources that match the specified compartment OCID.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description String: The description of the security policy report.
displayName String: A filter to return only resources that match the specified display name.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
id String: The OCID of the security policy report.
lifecycleDetails String: Details about the current state of the security policy report.
state String: The current state of the security policy report.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
targetId String: A filter to return only items related to a specific target OCID.
timeCreated String: The date and time the security policy report was created, in the format defined by RFC3339.
timeUpdated String: The date and time the security policy report was last updated, in the format defined by RFC3339.

compartmentId string: A filter to return only resources that match the specified compartment OCID.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description string: The description of the security policy report.
displayName string: A filter to return only resources that match the specified display name.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
id string: The OCID of the security policy report.
lifecycleDetails string: Details about the current state of the security policy report.
state string: The current state of the security policy report.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
targetId string: A filter to return only items related to a specific target OCID.
timeCreated string: The date and time the security policy report was created, in the format defined by RFC3339.
timeUpdated string: The date and time the security policy report was last updated, in the format defined by RFC3339.

compartment_id str: A filter to return only resources that match the specified compartment OCID.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description str: The description of the security policy report.
display_name str: A filter to return only resources that match the specified display name.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
id str: The OCID of the security policy report.
lifecycle_details str: Details about the current state of the security policy report.
state str: The current state of the security policy report.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
target_id str: A filter to return only items related to a specific target OCID.
time_created str: The date and time the security policy report was created, in the format defined by RFC3339.
time_updated str: The date and time the security policy report was last updated, in the format defined by RFC3339.

compartmentId String: A filter to return only resources that match the specified compartment OCID.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description String: The description of the security policy report.
displayName String: A filter to return only resources that match the specified display name.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
id String: The OCID of the security policy report.
lifecycleDetails String: Details about the current state of the security policy report.
state String: The current state of the security policy report.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
targetId String: A filter to return only items related to a specific target OCID.
timeCreated String: The date and time the security policy report was created, in the format defined by RFC3339.
timeUpdated String: The date and time the security policy report was last updated, in the format defined by RFC3339.

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.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.DataSafe.getSecurityPolicyReports

On this page

On this page

Example Usage

Using getSecurityPolicyReports

getSecurityPolicyReports Result

Supporting Types

GetSecurityPolicyReportsFilter

GetSecurityPolicyReportsSecurityPolicyReportCollection

GetSecurityPolicyReportsSecurityPolicyReportCollectionItem

Package Details

On this page

On this page