Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getAlertAnalytic

This data source provides details about a specific Alert Analytic resource in Oracle Cloud Infrastructure Data Safe service.

Returns aggregation details of alerts.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testAlertAnalytic = Oci.DataSafe.GetAlertAnalytic.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        AccessLevel = @var.Alert_analytic_access_level,
        CompartmentIdInSubtree = @var.Alert_analytic_compartment_id_in_subtree,
        GroupBies = @var.Alert_analytic_group_by,
        QueryTimeZone = @var.Alert_analytic_query_time_zone,
        ScimQuery = @var.Alert_analytic_scim_query,
        SummaryFields = @var.Alert_analytic_summary_field,
        TimeEnded = @var.Alert_analytic_time_ended,
        TimeStarted = @var.Alert_analytic_time_started,
    });

});
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.GetAlertAnalytic(ctx, &datasafe.GetAlertAnalyticArgs{
			CompartmentId:          _var.Compartment_id,
			AccessLevel:            pulumi.StringRef(_var.Alert_analytic_access_level),
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Alert_analytic_compartment_id_in_subtree),
			GroupBies:              _var.Alert_analytic_group_by,
			QueryTimeZone:          pulumi.StringRef(_var.Alert_analytic_query_time_zone),
			ScimQuery:              pulumi.StringRef(_var.Alert_analytic_scim_query),
			SummaryFields:          _var.Alert_analytic_summary_field,
			TimeEnded:              pulumi.StringRef(_var.Alert_analytic_time_ended),
			TimeStarted:            pulumi.StringRef(_var.Alert_analytic_time_started),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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.GetAlertAnalyticArgs;
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 testAlertAnalytic = DataSafeFunctions.getAlertAnalytic(GetAlertAnalyticArgs.builder()
            .compartmentId(var_.compartment_id())
            .accessLevel(var_.alert_analytic_access_level())
            .compartmentIdInSubtree(var_.alert_analytic_compartment_id_in_subtree())
            .groupBies(var_.alert_analytic_group_by())
            .queryTimeZone(var_.alert_analytic_query_time_zone())
            .scimQuery(var_.alert_analytic_scim_query())
            .summaryFields(var_.alert_analytic_summary_field())
            .timeEnded(var_.alert_analytic_time_ended())
            .timeStarted(var_.alert_analytic_time_started())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_alert_analytic = oci.DataSafe.get_alert_analytic(compartment_id=var["compartment_id"],
    access_level=var["alert_analytic_access_level"],
    compartment_id_in_subtree=var["alert_analytic_compartment_id_in_subtree"],
    group_bies=var["alert_analytic_group_by"],
    query_time_zone=var["alert_analytic_query_time_zone"],
    scim_query=var["alert_analytic_scim_query"],
    summary_fields=var["alert_analytic_summary_field"],
    time_ended=var["alert_analytic_time_ended"],
    time_started=var["alert_analytic_time_started"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAlertAnalytic = oci.DataSafe.getAlertAnalytic({
    compartmentId: _var.compartment_id,
    accessLevel: _var.alert_analytic_access_level,
    compartmentIdInSubtree: _var.alert_analytic_compartment_id_in_subtree,
    groupBies: _var.alert_analytic_group_by,
    queryTimeZone: _var.alert_analytic_query_time_zone,
    scimQuery: _var.alert_analytic_scim_query,
    summaryFields: _var.alert_analytic_summary_field,
    timeEnded: _var.alert_analytic_time_ended,
    timeStarted: _var.alert_analytic_time_started,
});
variables:
  testAlertAnalytic:
    Fn::Invoke:
      Function: oci:DataSafe:getAlertAnalytic
      Arguments:
        compartmentId: ${var.compartment_id}
        accessLevel: ${var.alert_analytic_access_level}
        compartmentIdInSubtree: ${var.alert_analytic_compartment_id_in_subtree}
        groupBies: ${var.alert_analytic_group_by}
        queryTimeZone: ${var.alert_analytic_query_time_zone}
        scimQuery: ${var.alert_analytic_scim_query}
        summaryFields: ${var.alert_analytic_summary_field}
        timeEnded: ${var.alert_analytic_time_ended}
        timeStarted: ${var.alert_analytic_time_started}

Using getAlertAnalytic

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 getAlertAnalytic(args: GetAlertAnalyticArgs, opts?: InvokeOptions): Promise<GetAlertAnalyticResult>
function getAlertAnalyticOutput(args: GetAlertAnalyticOutputArgs, opts?: InvokeOptions): Output<GetAlertAnalyticResult>
def get_alert_analytic(access_level: Optional[str] = None,
                       compartment_id: Optional[str] = None,
                       compartment_id_in_subtree: Optional[bool] = None,
                       group_bies: Optional[Sequence[str]] = None,
                       query_time_zone: Optional[str] = None,
                       scim_query: Optional[str] = None,
                       summary_fields: Optional[Sequence[str]] = None,
                       time_ended: Optional[str] = None,
                       time_started: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAlertAnalyticResult
def get_alert_analytic_output(access_level: Optional[pulumi.Input[str]] = None,
                       compartment_id: Optional[pulumi.Input[str]] = None,
                       compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                       group_bies: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       query_time_zone: Optional[pulumi.Input[str]] = None,
                       scim_query: Optional[pulumi.Input[str]] = None,
                       summary_fields: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       time_ended: Optional[pulumi.Input[str]] = None,
                       time_started: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetAlertAnalyticResult]
func GetAlertAnalytic(ctx *Context, args *GetAlertAnalyticArgs, opts ...InvokeOption) (*GetAlertAnalyticResult, error)
func GetAlertAnalyticOutput(ctx *Context, args *GetAlertAnalyticOutputArgs, opts ...InvokeOption) GetAlertAnalyticResultOutput

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

public static class GetAlertAnalytic 
{
    public static Task<GetAlertAnalyticResult> InvokeAsync(GetAlertAnalyticArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertAnalyticResult> Invoke(GetAlertAnalyticInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAlertAnalyticResult> getAlertAnalytic(GetAlertAnalyticArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:DataSafe/getAlertAnalytic:getAlertAnalytic
  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.

GroupBies List<string>

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

QueryTimeZone string

Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.

ScimQuery string

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

SummaryFields List<string>

Specifies a subset of summarized fields to be returned in the response.

TimeEnded string

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

TimeStarted string

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

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.

GroupBies []string

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

QueryTimeZone string

Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.

ScimQuery string

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

SummaryFields []string

Specifies a subset of summarized fields to be returned in the response.

TimeEnded string

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

TimeStarted string

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

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.

groupBies List<String>

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

queryTimeZone String

Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.

scimQuery String

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

summaryFields List<String>

Specifies a subset of summarized fields to be returned in the response.

timeEnded String

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

timeStarted String

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

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.

groupBies string[]

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

queryTimeZone string

Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.

scimQuery string

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

summaryFields string[]

Specifies a subset of summarized fields to be returned in the response.

timeEnded string

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

timeStarted string

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

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.

group_bies Sequence[str]

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

query_time_zone str

Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.

scim_query str

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

summary_fields Sequence[str]

Specifies a subset of summarized fields to be returned in the response.

time_ended str

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

time_started str

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

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.

groupBies List<String>

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

queryTimeZone String

Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.

scimQuery String

The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

summaryFields List<String>

Specifies a subset of summarized fields to be returned in the response.

timeEnded String

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

timeStarted String

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

getAlertAnalytic Result

The following output properties are available:

CompartmentId string
Id string

The provider-assigned unique ID for this managed resource.

Items List<GetAlertAnalyticItem>

The aggregated data point items.

AccessLevel string
CompartmentIdInSubtree bool
GroupBies List<string>

GroupBy value used in aggregation.

QueryTimeZone string
ScimQuery string
SummaryFields List<string>
TimeEnded string

The time at which the aggregation ended.

TimeStarted string

The time at which the aggregation started.

CompartmentId string
Id string

The provider-assigned unique ID for this managed resource.

Items []GetAlertAnalyticItem

The aggregated data point items.

AccessLevel string
CompartmentIdInSubtree bool
GroupBies []string

GroupBy value used in aggregation.

QueryTimeZone string
ScimQuery string
SummaryFields []string
TimeEnded string

The time at which the aggregation ended.

TimeStarted string

The time at which the aggregation started.

compartmentId String
id String

The provider-assigned unique ID for this managed resource.

items List<GetAlertAnalyticItem>

The aggregated data point items.

accessLevel String
compartmentIdInSubtree Boolean
groupBies List<String>

GroupBy value used in aggregation.

queryTimeZone String
scimQuery String
summaryFields List<String>
timeEnded String

The time at which the aggregation ended.

timeStarted String

The time at which the aggregation started.

compartmentId string
id string

The provider-assigned unique ID for this managed resource.

items GetAlertAnalyticItem[]

The aggregated data point items.

accessLevel string
compartmentIdInSubtree boolean
groupBies string[]

GroupBy value used in aggregation.

queryTimeZone string
scimQuery string
summaryFields string[]
timeEnded string

The time at which the aggregation ended.

timeStarted string

The time at which the aggregation started.

compartment_id str
id str

The provider-assigned unique ID for this managed resource.

items GetAlertAnalyticItem]

The aggregated data point items.

access_level str
compartment_id_in_subtree bool
group_bies Sequence[str]

GroupBy value used in aggregation.

query_time_zone str
scim_query str
summary_fields Sequence[str]
time_ended str

The time at which the aggregation ended.

time_started str

The time at which the aggregation started.

compartmentId String
id String

The provider-assigned unique ID for this managed resource.

items List<Property Map>

The aggregated data point items.

accessLevel String
compartmentIdInSubtree Boolean
groupBies List<String>

GroupBy value used in aggregation.

queryTimeZone String
scimQuery String
summaryFields List<String>
timeEnded String

The time at which the aggregation ended.

timeStarted String

The time at which the aggregation started.

Supporting Types

GetAlertAnalyticItem

Count string

Total count of aggregated values.

Dimensions List<GetAlertAnalyticItemDimension>

Details of aggregation dimension summarizing alerts.

MetricName string

The name of the aggregation.

TimeEnded string

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

TimeStarted string

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

Count string

Total count of aggregated values.

Dimensions []GetAlertAnalyticItemDimension

Details of aggregation dimension summarizing alerts.

MetricName string

The name of the aggregation.

TimeEnded string

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

TimeStarted string

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

count String

Total count of aggregated values.

dimensions List<GetAlertAnalyticItemDimension>

Details of aggregation dimension summarizing alerts.

metricName String

The name of the aggregation.

timeEnded String

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

timeStarted String

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

count string

Total count of aggregated values.

dimensions GetAlertAnalyticItemDimension[]

Details of aggregation dimension summarizing alerts.

metricName string

The name of the aggregation.

timeEnded string

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

timeStarted string

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

count str

Total count of aggregated values.

dimensions GetAlertAnalyticItemDimension]

Details of aggregation dimension summarizing alerts.

metric_name str

The name of the aggregation.

time_ended str

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

time_started str

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

count String

Total count of aggregated values.

dimensions List<Property Map>

Details of aggregation dimension summarizing alerts.

metricName String

The name of the aggregation.

timeEnded String

An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.

timeStarted String

An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

GetAlertAnalyticItemDimension

GroupBy Dictionary<string, object>

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

GroupBy map[string]interface{}

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

groupBy Map<String,Object>

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

groupBy {[key: string]: any}

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

group_by Mapping[str, Any]

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

groupBy Map<Any>

A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.

Package Details

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

This Pulumi package is based on the oci Terraform Provider.