Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.DataSafe.getReportDefinitions

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testReportDefinitions = oci.DataSafe.getReportDefinitions({
    compartmentId: compartmentId,
    accessLevel: reportDefinitionAccessLevel,
    category: reportDefinitionCategory,
    compartmentIdInSubtree: reportDefinitionCompartmentIdInSubtree,
    dataSource: reportDefinitionDataSource,
    displayName: reportDefinitionDisplayName,
    isSeeded: reportDefinitionIsSeeded,
    state: reportDefinitionState,
});

import pulumi
import pulumi_oci as oci

test_report_definitions = oci.DataSafe.get_report_definitions(compartment_id=compartment_id,
    access_level=report_definition_access_level,
    category=report_definition_category,
    compartment_id_in_subtree=report_definition_compartment_id_in_subtree,
    data_source=report_definition_data_source,
    display_name=report_definition_display_name,
    is_seeded=report_definition_is_seeded,
    state=report_definition_state)

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.GetReportDefinitions(ctx, &datasafe.GetReportDefinitionsArgs{
			CompartmentId:          compartmentId,
			AccessLevel:            pulumi.StringRef(reportDefinitionAccessLevel),
			Category:               pulumi.StringRef(reportDefinitionCategory),
			CompartmentIdInSubtree: pulumi.BoolRef(reportDefinitionCompartmentIdInSubtree),
			DataSource:             pulumi.StringRef(reportDefinitionDataSource),
			DisplayName:            pulumi.StringRef(reportDefinitionDisplayName),
			IsSeeded:               pulumi.BoolRef(reportDefinitionIsSeeded),
			State:                  pulumi.StringRef(reportDefinitionState),
		}, 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 testReportDefinitions = Oci.DataSafe.GetReportDefinitions.Invoke(new()
    {
        CompartmentId = compartmentId,
        AccessLevel = reportDefinitionAccessLevel,
        Category = reportDefinitionCategory,
        CompartmentIdInSubtree = reportDefinitionCompartmentIdInSubtree,
        DataSource = reportDefinitionDataSource,
        DisplayName = reportDefinitionDisplayName,
        IsSeeded = reportDefinitionIsSeeded,
        State = reportDefinitionState,
    });

});

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.GetReportDefinitionsArgs;
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 testReportDefinitions = DataSafeFunctions.getReportDefinitions(GetReportDefinitionsArgs.builder()
            .compartmentId(compartmentId)
            .accessLevel(reportDefinitionAccessLevel)
            .category(reportDefinitionCategory)
            .compartmentIdInSubtree(reportDefinitionCompartmentIdInSubtree)
            .dataSource(reportDefinitionDataSource)
            .displayName(reportDefinitionDisplayName)
            .isSeeded(reportDefinitionIsSeeded)
            .state(reportDefinitionState)
            .build());

    }
}

variables:
  testReportDefinitions:
    fn::invoke:
      function: oci:DataSafe:getReportDefinitions
      arguments:
        compartmentId: ${compartmentId}
        accessLevel: ${reportDefinitionAccessLevel}
        category: ${reportDefinitionCategory}
        compartmentIdInSubtree: ${reportDefinitionCompartmentIdInSubtree}
        dataSource: ${reportDefinitionDataSource}
        displayName: ${reportDefinitionDisplayName}
        isSeeded: ${reportDefinitionIsSeeded}
        state: ${reportDefinitionState}

Using getReportDefinitions

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.

TypeScript
Python
Go
C#
Java
YAML

function getReportDefinitions(args: GetReportDefinitionsArgs, opts?: InvokeOptions): Promise<GetReportDefinitionsResult>
function getReportDefinitionsOutput(args: GetReportDefinitionsOutputArgs, opts?: InvokeOptions): Output<GetReportDefinitionsResult>

def get_report_definitions(access_level: Optional[str] = None,
                           category: Optional[str] = None,
                           compartment_id: Optional[str] = None,
                           compartment_id_in_subtree: Optional[bool] = None,
                           data_source: Optional[str] = None,
                           display_name: Optional[str] = None,
                           filters: Optional[Sequence[_datasafe.GetReportDefinitionsFilter]] = None,
                           is_seeded: Optional[bool] = None,
                           state: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetReportDefinitionsResult
def get_report_definitions_output(access_level: Optional[pulumi.Input[str]] = None,
                           category: Optional[pulumi.Input[str]] = None,
                           compartment_id: Optional[pulumi.Input[str]] = None,
                           compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                           data_source: Optional[pulumi.Input[str]] = None,
                           display_name: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datasafe.GetReportDefinitionsFilterArgs]]]] = None,
                           is_seeded: Optional[pulumi.Input[bool]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetReportDefinitionsResult]

func GetReportDefinitions(ctx *Context, args *GetReportDefinitionsArgs, opts ...InvokeOption) (*GetReportDefinitionsResult, error)
func GetReportDefinitionsOutput(ctx *Context, args *GetReportDefinitionsOutputArgs, opts ...InvokeOption) GetReportDefinitionsResultOutput

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

public static class GetReportDefinitions 
{
    public static Task<GetReportDefinitionsResult> InvokeAsync(GetReportDefinitionsArgs args, InvokeOptions? opts = null)
    public static Output<GetReportDefinitionsResult> Invoke(GetReportDefinitionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetReportDefinitionsResult> getReportDefinitions(GetReportDefinitionsArgs args, InvokeOptions options)
public static Output<GetReportDefinitionsResult> getReportDefinitions(GetReportDefinitionsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DataSafe/getReportDefinitions:getReportDefinitions
  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.
Category string: An optional filter to return only resources that match the specified category.
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.
DataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
DisplayName string: The name of the report definition to query.
Filters List<GetReportDefinitionsFilter>
IsSeeded bool: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
State string: An optional filter to return only resources that match the specified lifecycle state.

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.
Category string: An optional filter to return only resources that match the specified category.
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.
DataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
DisplayName string: The name of the report definition to query.
Filters []GetReportDefinitionsFilter
IsSeeded bool: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
State string: An optional filter to return only resources that match the specified lifecycle state.

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.
category String: An optional filter to return only resources that match the specified category.
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.
dataSource String: Specifies the name of a resource that provides data for the report. For example alerts, events.
displayName String: The name of the report definition to query.
filters List<GetReportDefinitionsFilter>
isSeeded Boolean: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
state String: An optional filter to return only resources that match the specified lifecycle state.

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.
category string: An optional filter to return only resources that match the specified category.
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.
dataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
displayName string: The name of the report definition to query.
filters GetReportDefinitionsFilter[]
isSeeded boolean: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
state string: An optional filter to return only resources that match the specified lifecycle state.

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.
category str: An optional filter to return only resources that match the specified category.
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.
data_source str: Specifies the name of a resource that provides data for the report. For example alerts, events.
display_name str: The name of the report definition to query.
filters Sequence[datasafe.GetReportDefinitionsFilter]
is_seeded bool: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
state str: An optional filter to return only resources that match the specified lifecycle state.

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.
category String: An optional filter to return only resources that match the specified category.
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.
dataSource String: Specifies the name of a resource that provides data for the report. For example alerts, events.
displayName String: The name of the report definition to query.
filters List<Property Map>
isSeeded Boolean: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
state String: An optional filter to return only resources that match the specified lifecycle state.

getReportDefinitions Result

The following output properties are available:

CompartmentId string: The OCID of the compartment containing the report definition.
Id string: The provider-assigned unique ID for this managed resource.
ReportDefinitionCollections List<GetReportDefinitionsReportDefinitionCollection>: The list of report_definition_collection.
AccessLevel string
Category string: Specifies the name of the category that this report belongs to.
CompartmentIdInSubtree bool
DataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
DisplayName string: Name of the report definition.
Filters List<GetReportDefinitionsFilter>
IsSeeded bool: Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
State string: The current state of the report.

CompartmentId string: The OCID of the compartment containing the report definition.
Id string: The provider-assigned unique ID for this managed resource.
ReportDefinitionCollections []GetReportDefinitionsReportDefinitionCollection: The list of report_definition_collection.
AccessLevel string
Category string: Specifies the name of the category that this report belongs to.
CompartmentIdInSubtree bool
DataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
DisplayName string: Name of the report definition.
Filters []GetReportDefinitionsFilter
IsSeeded bool: Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
State string: The current state of the report.

compartmentId String: The OCID of the compartment containing the report definition.
id String: The provider-assigned unique ID for this managed resource.
reportDefinitionCollections List<GetReportDefinitionsReportDefinitionCollection>: The list of report_definition_collection.
accessLevel String
category String: Specifies the name of the category that this report belongs to.
compartmentIdInSubtree Boolean
dataSource String: Specifies the name of a resource that provides data for the report. For example alerts, events.
displayName String: Name of the report definition.
filters List<GetReportDefinitionsFilter>
isSeeded Boolean: Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
state String: The current state of the report.

compartmentId string: The OCID of the compartment containing the report definition.
id string: The provider-assigned unique ID for this managed resource.
reportDefinitionCollections GetReportDefinitionsReportDefinitionCollection[]: The list of report_definition_collection.
accessLevel string
category string: Specifies the name of the category that this report belongs to.
compartmentIdInSubtree boolean
dataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
displayName string: Name of the report definition.
filters GetReportDefinitionsFilter[]
isSeeded boolean: Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
state string: The current state of the report.

compartment_id str: The OCID of the compartment containing the report definition.
id str: The provider-assigned unique ID for this managed resource.
report_definition_collections Sequence[datasafe.GetReportDefinitionsReportDefinitionCollection]: The list of report_definition_collection.
access_level str
category str: Specifies the name of the category that this report belongs to.
compartment_id_in_subtree bool
data_source str: Specifies the name of a resource that provides data for the report. For example alerts, events.
display_name str: Name of the report definition.
filters Sequence[datasafe.GetReportDefinitionsFilter]
is_seeded bool: Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
state str: The current state of the report.

compartmentId String: The OCID of the compartment containing the report definition.
id String: The provider-assigned unique ID for this managed resource.
reportDefinitionCollections List<Property Map>: The list of report_definition_collection.
accessLevel String
category String: Specifies the name of the category that this report belongs to.
compartmentIdInSubtree Boolean
dataSource String: Specifies the name of a resource that provides data for the report. For example alerts, events.
displayName String: Name of the report definition.
filters List<Property Map>
isSeeded Boolean: Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
state String: The current state of the report.

Supporting Types

GetReportDefinitionsFilter

Name string: Name of the report summary.
Values List<string>
Regex bool

Name string: Name of the report summary.
Values []string
Regex bool

name String: Name of the report summary.
values List<String>
regex Boolean

name string: Name of the report summary.
values string[]
regex boolean

name str: Name of the report summary.
values Sequence[str]
regex bool

name String: Name of the report summary.
values List<String>
regex Boolean

GetReportDefinitionsReportDefinitionCollection

Items List<GetReportDefinitionsReportDefinitionCollectionItem>

Items []GetReportDefinitionsReportDefinitionCollectionItem

items List<GetReportDefinitionsReportDefinitionCollectionItem>

items GetReportDefinitionsReportDefinitionCollectionItem[]

items Sequence[datasafe.GetReportDefinitionsReportDefinitionCollectionItem]

items List<Property Map>

GetReportDefinitionsReportDefinitionCollectionItem

Category string: An optional filter to return only resources that match the specified category.
ColumnFilters List<GetReportDefinitionsReportDefinitionCollectionItemColumnFilter>: An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
ColumnInfos List<GetReportDefinitionsReportDefinitionCollectionItemColumnInfo>: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
ColumnSortings List<GetReportDefinitionsReportDefinitionCollectionItemColumnSorting>: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
CompartmentId string: A filter to return only resources that match the specified compartment OCID.
ComplianceStandards List<string>: The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
DataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
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: A description of the report definition.
DisplayName string: The name of the report definition to query.
DisplayOrder int: Specifies the order in which the summary must be displayed.
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 report definition.
IsSeeded bool: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
LifecycleDetails string: Details about the current state of the report definition in Data Safe.
ParentId string: The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
RecordTimeSpan string: The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)
Schedule string: The schedule to generate the report periodically in the specified format: ;
ScheduledReportCompartmentId string: The OCID of the compartment in which the scheduled resource will be created.
ScheduledReportMimeType string: Specifies the format of the report ( either .xls or .pdf or .json)
ScheduledReportName string: The name of the report to be scheduled.
ScheduledReportRowLimit int: Specifies the limit on the number of rows in the report.
ScimFilter string: Additional scim filters used to get the specific summary.
State string: An optional filter to return only resources that match the specified lifecycle state.
Summaries List<GetReportDefinitionsReportDefinitionCollectionItemSummary>: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
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"}
TimeCreated string: Specifies the date and time the report definition was created.
TimeUpdated string: The date and time the report definition was updated.

Category string: An optional filter to return only resources that match the specified category.
ColumnFilters []GetReportDefinitionsReportDefinitionCollectionItemColumnFilter: An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
ColumnInfos []GetReportDefinitionsReportDefinitionCollectionItemColumnInfo: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
ColumnSortings []GetReportDefinitionsReportDefinitionCollectionItemColumnSorting: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
CompartmentId string: A filter to return only resources that match the specified compartment OCID.
ComplianceStandards []string: The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
DataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
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: A description of the report definition.
DisplayName string: The name of the report definition to query.
DisplayOrder int: Specifies the order in which the summary must be displayed.
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 report definition.
IsSeeded bool: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
LifecycleDetails string: Details about the current state of the report definition in Data Safe.
ParentId string: The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
RecordTimeSpan string: The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)
Schedule string: The schedule to generate the report periodically in the specified format: ;
ScheduledReportCompartmentId string: The OCID of the compartment in which the scheduled resource will be created.
ScheduledReportMimeType string: Specifies the format of the report ( either .xls or .pdf or .json)
ScheduledReportName string: The name of the report to be scheduled.
ScheduledReportRowLimit int: Specifies the limit on the number of rows in the report.
ScimFilter string: Additional scim filters used to get the specific summary.
State string: An optional filter to return only resources that match the specified lifecycle state.
Summaries []GetReportDefinitionsReportDefinitionCollectionItemSummary: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
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"}
TimeCreated string: Specifies the date and time the report definition was created.
TimeUpdated string: The date and time the report definition was updated.

category String: An optional filter to return only resources that match the specified category.
columnFilters List<GetReportDefinitionsReportDefinitionCollectionItemColumnFilter>: An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
columnInfos List<GetReportDefinitionsReportDefinitionCollectionItemColumnInfo>: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
columnSortings List<GetReportDefinitionsReportDefinitionCollectionItemColumnSorting>: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
compartmentId String: A filter to return only resources that match the specified compartment OCID.
complianceStandards List<String>: The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
dataSource String: Specifies the name of a resource that provides data for the report. For example alerts, events.
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: A description of the report definition.
displayName String: The name of the report definition to query.
displayOrder Integer: Specifies the order in which the summary must be displayed.
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 report definition.
isSeeded Boolean: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
lifecycleDetails String: Details about the current state of the report definition in Data Safe.
parentId String: The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
recordTimeSpan String: The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)
schedule String: The schedule to generate the report periodically in the specified format: ;
scheduledReportCompartmentId String: The OCID of the compartment in which the scheduled resource will be created.
scheduledReportMimeType String: Specifies the format of the report ( either .xls or .pdf or .json)
scheduledReportName String: The name of the report to be scheduled.
scheduledReportRowLimit Integer: Specifies the limit on the number of rows in the report.
scimFilter String: Additional scim filters used to get the specific summary.
state String: An optional filter to return only resources that match the specified lifecycle state.
summaries List<GetReportDefinitionsReportDefinitionCollectionItemSummary>: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
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"}
timeCreated String: Specifies the date and time the report definition was created.
timeUpdated String: The date and time the report definition was updated.

category string: An optional filter to return only resources that match the specified category.
columnFilters GetReportDefinitionsReportDefinitionCollectionItemColumnFilter[]: An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
columnInfos GetReportDefinitionsReportDefinitionCollectionItemColumnInfo[]: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
columnSortings GetReportDefinitionsReportDefinitionCollectionItemColumnSorting[]: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
compartmentId string: A filter to return only resources that match the specified compartment OCID.
complianceStandards string[]: The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
dataSource string: Specifies the name of a resource that provides data for the report. For example alerts, events.
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: A description of the report definition.
displayName string: The name of the report definition to query.
displayOrder number: Specifies the order in which the summary must be displayed.
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 report definition.
isSeeded boolean: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
lifecycleDetails string: Details about the current state of the report definition in Data Safe.
parentId string: The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
recordTimeSpan string: The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)
schedule string: The schedule to generate the report periodically in the specified format: ;
scheduledReportCompartmentId string: The OCID of the compartment in which the scheduled resource will be created.
scheduledReportMimeType string: Specifies the format of the report ( either .xls or .pdf or .json)
scheduledReportName string: The name of the report to be scheduled.
scheduledReportRowLimit number: Specifies the limit on the number of rows in the report.
scimFilter string: Additional scim filters used to get the specific summary.
state string: An optional filter to return only resources that match the specified lifecycle state.
summaries GetReportDefinitionsReportDefinitionCollectionItemSummary[]: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
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"}
timeCreated string: Specifies the date and time the report definition was created.
timeUpdated string: The date and time the report definition was updated.

category str: An optional filter to return only resources that match the specified category.
column_filters Sequence[datasafe.GetReportDefinitionsReportDefinitionCollectionItemColumnFilter]: An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
column_infos Sequence[datasafe.GetReportDefinitionsReportDefinitionCollectionItemColumnInfo]: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
column_sortings Sequence[datasafe.GetReportDefinitionsReportDefinitionCollectionItemColumnSorting]: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
compartment_id str: A filter to return only resources that match the specified compartment OCID.
compliance_standards Sequence[str]: The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
data_source str: Specifies the name of a resource that provides data for the report. For example alerts, events.
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: A description of the report definition.
display_name str: The name of the report definition to query.
display_order int: Specifies the order in which the summary must be displayed.
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 report definition.
is_seeded bool: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
lifecycle_details str: Details about the current state of the report definition in Data Safe.
parent_id str: The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
record_time_span str: The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)
schedule str: The schedule to generate the report periodically in the specified format: ;
scheduled_report_compartment_id str: The OCID of the compartment in which the scheduled resource will be created.
scheduled_report_mime_type str: Specifies the format of the report ( either .xls or .pdf or .json)
scheduled_report_name str: The name of the report to be scheduled.
scheduled_report_row_limit int: Specifies the limit on the number of rows in the report.
scim_filter str: Additional scim filters used to get the specific summary.
state str: An optional filter to return only resources that match the specified lifecycle state.
summaries Sequence[datasafe.GetReportDefinitionsReportDefinitionCollectionItemSummary]: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
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"}
time_created str: Specifies the date and time the report definition was created.
time_updated str: The date and time the report definition was updated.

category String: An optional filter to return only resources that match the specified category.
columnFilters List<Property Map>: An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.
columnInfos List<Property Map>: An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).
columnSortings List<Property Map>: An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.
compartmentId String: A filter to return only resources that match the specified compartment OCID.
complianceStandards List<String>: The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
dataSource String: Specifies the name of a resource that provides data for the report. For example alerts, events.
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: A description of the report definition.
displayName String: The name of the report definition to query.
displayOrder Number: Specifies the order in which the summary must be displayed.
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 report definition.
isSeeded Boolean: A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
lifecycleDetails String: Details about the current state of the report definition in Data Safe.
parentId String: The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
recordTimeSpan String: The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)
schedule String: The schedule to generate the report periodically in the specified format: ;
scheduledReportCompartmentId String: The OCID of the compartment in which the scheduled resource will be created.
scheduledReportMimeType String: Specifies the format of the report ( either .xls or .pdf or .json)
scheduledReportName String: The name of the report to be scheduled.
scheduledReportRowLimit Number: Specifies the limit on the number of rows in the report.
scimFilter String: Additional scim filters used to get the specific summary.
state String: An optional filter to return only resources that match the specified lifecycle state.
summaries List<Property Map>: An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).
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"}
timeCreated String: Specifies the date and time the report definition was created.
timeUpdated String: The date and time the report definition was updated.

GetReportDefinitionsReportDefinitionCollectionItemColumnFilter

Expressions List<string>: An array of expressions based on the operator type. A filter may have one or more expressions.
FieldName string: Name of the column that must be sorted.
IsEnabled bool: Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
IsHidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
Operator string: Specifies the type of operator that must be applied for example in, eq etc.

Expressions []string: An array of expressions based on the operator type. A filter may have one or more expressions.
FieldName string: Name of the column that must be sorted.
IsEnabled bool: Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
IsHidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
Operator string: Specifies the type of operator that must be applied for example in, eq etc.

expressions List<String>: An array of expressions based on the operator type. A filter may have one or more expressions.
fieldName String: Name of the column that must be sorted.
isEnabled Boolean: Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
isHidden Boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
operator String: Specifies the type of operator that must be applied for example in, eq etc.

expressions string[]: An array of expressions based on the operator type. A filter may have one or more expressions.
fieldName string: Name of the column that must be sorted.
isEnabled boolean: Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
isHidden boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
operator string: Specifies the type of operator that must be applied for example in, eq etc.

expressions Sequence[str]: An array of expressions based on the operator type. A filter may have one or more expressions.
field_name str: Name of the column that must be sorted.
is_enabled bool: Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
is_hidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
operator str: Specifies the type of operator that must be applied for example in, eq etc.

expressions List<String>: An array of expressions based on the operator type. A filter may have one or more expressions.
fieldName String: Name of the column that must be sorted.
isEnabled Boolean: Indicates whether the filter is enabled. Values can either be 'true' or 'false'.
isHidden Boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
operator String: Specifies the type of operator that must be applied for example in, eq etc.

GetReportDefinitionsReportDefinitionCollectionItemColumnInfo

DataType string: Specifies the data type of the column.
DisplayName string: The name of the report definition to query.
DisplayOrder int: Specifies the order in which the summary must be displayed.
FieldName string: Name of the column that must be sorted.
IsHidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.

DataType string: Specifies the data type of the column.
DisplayName string: The name of the report definition to query.
DisplayOrder int: Specifies the order in which the summary must be displayed.
FieldName string: Name of the column that must be sorted.
IsHidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.

dataType String: Specifies the data type of the column.
displayName String: The name of the report definition to query.
displayOrder Integer: Specifies the order in which the summary must be displayed.
fieldName String: Name of the column that must be sorted.
isHidden Boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.

dataType string: Specifies the data type of the column.
displayName string: The name of the report definition to query.
displayOrder number: Specifies the order in which the summary must be displayed.
fieldName string: Name of the column that must be sorted.
isHidden boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.

data_type str: Specifies the data type of the column.
display_name str: The name of the report definition to query.
display_order int: Specifies the order in which the summary must be displayed.
field_name str: Name of the column that must be sorted.
is_hidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.

dataType String: Specifies the data type of the column.
displayName String: The name of the report definition to query.
displayOrder Number: Specifies the order in which the summary must be displayed.
fieldName String: Name of the column that must be sorted.
isHidden Boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.

GetReportDefinitionsReportDefinitionCollectionItemColumnSorting

FieldName string: Name of the column that must be sorted.
IsAscending bool: Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
SortingOrder int: Indicates the order at which column must be sorted.

FieldName string: Name of the column that must be sorted.
IsAscending bool: Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
SortingOrder int: Indicates the order at which column must be sorted.

fieldName String: Name of the column that must be sorted.
isAscending Boolean: Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
sortingOrder Integer: Indicates the order at which column must be sorted.

fieldName string: Name of the column that must be sorted.
isAscending boolean: Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
sortingOrder number: Indicates the order at which column must be sorted.

field_name str: Name of the column that must be sorted.
is_ascending bool: Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
sorting_order int: Indicates the order at which column must be sorted.

fieldName String: Name of the column that must be sorted.
isAscending Boolean: Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
sortingOrder Number: Indicates the order at which column must be sorted.

GetReportDefinitionsReportDefinitionCollectionItemSummary

CountOf string: Name of the key or count of object.
DisplayOrder int: Specifies the order in which the summary must be displayed.
GroupByFieldName string: A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
IsHidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
Name string: Name of the report summary.
ScimFilter string: Additional scim filters used to get the specific summary.

CountOf string: Name of the key or count of object.
DisplayOrder int: Specifies the order in which the summary must be displayed.
GroupByFieldName string: A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
IsHidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
Name string: Name of the report summary.
ScimFilter string: Additional scim filters used to get the specific summary.

countOf String: Name of the key or count of object.
displayOrder Integer: Specifies the order in which the summary must be displayed.
groupByFieldName String: A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
isHidden Boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
name String: Name of the report summary.
scimFilter String: Additional scim filters used to get the specific summary.

countOf string: Name of the key or count of object.
displayOrder number: Specifies the order in which the summary must be displayed.
groupByFieldName string: A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
isHidden boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
name string: Name of the report summary.
scimFilter string: Additional scim filters used to get the specific summary.

count_of str: Name of the key or count of object.
display_order int: Specifies the order in which the summary must be displayed.
group_by_field_name str: A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
is_hidden bool: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
name str: Name of the report summary.
scim_filter str: Additional scim filters used to get the specific summary.

countOf String: Name of the key or count of object.
displayOrder Number: Specifies the order in which the summary must be displayed.
groupByFieldName String: A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
isHidden Boolean: Indicates if the summary is hidden. Values can either be 'true' or 'false'.
name String: Name of the report summary.
scimFilter String: Additional scim filters used to get the specific summary.

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataSafe.getReportDefinitions

On this page

On this page

Example Usage

Using getReportDefinitions

getReportDefinitions Result

Supporting Types

GetReportDefinitionsFilter

GetReportDefinitionsReportDefinitionCollection

GetReportDefinitionsReportDefinitionCollectionItem

GetReportDefinitionsReportDefinitionCollectionItemColumnFilter

GetReportDefinitionsReportDefinitionCollectionItemColumnInfo

GetReportDefinitionsReportDefinitionCollectionItemColumnSorting

GetReportDefinitionsReportDefinitionCollectionItemSummary

Package Details

On this page

On this page