Oracle Cloud Infrastructure

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

getAlerts

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

Gets a list of all alerts.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testAlerts = Output.Create(Oci.DataSafe.GetAlerts.InvokeAsync(new Oci.DataSafe.GetAlertsArgs
        {
            CompartmentId = @var.Compartment_id,
            AccessLevel = @var.Alert_access_level,
            CompartmentIdInSubtree = @var.Alert_compartment_id_in_subtree,
            Fields = @var.Alert_field,
            Id = @var.Alert_id,
            ScimQuery = @var.Alert_scim_query,
        }));
    }

}
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.GetAlerts(ctx, &datasafe.GetAlertsArgs{
			CompartmentId:          _var.Compartment_id,
			AccessLevel:            pulumi.StringRef(_var.Alert_access_level),
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Alert_compartment_id_in_subtree),
			Fields:                 _var.Alert_field,
			Id:                     pulumi.StringRef(_var.Alert_id),
			ScimQuery:              pulumi.StringRef(_var.Alert_scim_query),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_alerts = oci.DataSafe.get_alerts(compartment_id=var["compartment_id"],
    access_level=var["alert_access_level"],
    compartment_id_in_subtree=var["alert_compartment_id_in_subtree"],
    fields=var["alert_field"],
    id=var["alert_id"],
    scim_query=var["alert_scim_query"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAlerts = oci.DataSafe.getAlerts({
    compartmentId: _var.compartment_id,
    accessLevel: _var.alert_access_level,
    compartmentIdInSubtree: _var.alert_compartment_id_in_subtree,
    fields: _var.alert_field,
    id: _var.alert_id,
    scimQuery: _var.alert_scim_query,
});

Coming soon!

Using getAlerts

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 getAlerts(args: GetAlertsArgs, opts?: InvokeOptions): Promise<GetAlertsResult>
function getAlertsOutput(args: GetAlertsOutputArgs, opts?: InvokeOptions): Output<GetAlertsResult>
def get_alerts(access_level: Optional[str] = None,
               compartment_id: Optional[str] = None,
               compartment_id_in_subtree: Optional[bool] = None,
               fields: Optional[Sequence[str]] = None,
               filters: Optional[Sequence[_datasafe.GetAlertsFilter]] = None,
               id: Optional[str] = None,
               scim_query: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetAlertsResult
def get_alerts_output(access_level: Optional[pulumi.Input[str]] = None,
               compartment_id: Optional[pulumi.Input[str]] = None,
               compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
               fields: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datasafe.GetAlertsFilterArgs]]]] = None,
               id: Optional[pulumi.Input[str]] = None,
               scim_query: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetAlertsResult]
func GetAlerts(ctx *Context, args *GetAlertsArgs, opts ...InvokeOption) (*GetAlertsResult, error)
func GetAlertsOutput(ctx *Context, args *GetAlertsOutputArgs, opts ...InvokeOption) GetAlertsResultOutput

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

public static class GetAlerts 
{
    public static Task<GetAlertsResult> InvokeAsync(GetAlertsArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertsResult> Invoke(GetAlertsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAlertsResult> getAlerts(GetAlertsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataSafe/getAlerts:getAlerts
  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.

Fields List<string>

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

Filters List<GetAlertsFilter>
Id string

A filter to return alert by it's OCID.

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.)

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.

Fields []string

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

Filters []GetAlertsFilter
Id string

A filter to return alert by it's OCID.

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.)

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.

fields List<String>

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

filters List<GetAlertsFilter>
id String

A filter to return alert by it's OCID.

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.)

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.

fields string[]

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

filters GetAlertsFilter[]
id string

A filter to return alert by it's OCID.

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.)

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.

fields Sequence[str]

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

filters GetAlertsFilter]
id str

A filter to return alert by it's OCID.

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.)

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.

fields List<String>

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

filters List<Property Map>
id String

A filter to return alert by it's OCID.

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.)

getAlerts Result

The following output properties are available:

AlertCollections List<GetAlertsAlertCollection>

The list of alert_collection.

CompartmentId string

The OCID of the compartment that contains the alert.

AccessLevel string
CompartmentIdInSubtree bool
Fields List<string>
Filters List<GetAlertsFilter>
Id string

The OCID of the alert.

ScimQuery string
AlertCollections []GetAlertsAlertCollection

The list of alert_collection.

CompartmentId string

The OCID of the compartment that contains the alert.

AccessLevel string
CompartmentIdInSubtree bool
Fields []string
Filters []GetAlertsFilter
Id string

The OCID of the alert.

ScimQuery string
alertCollections List<GetAlertsAlertCollection>

The list of alert_collection.

compartmentId String

The OCID of the compartment that contains the alert.

accessLevel String
compartmentIdInSubtree Boolean
fields List<String>
filters List<GetAlertsFilter>
id String

The OCID of the alert.

scimQuery String
alertCollections GetAlertsAlertCollection[]

The list of alert_collection.

compartmentId string

The OCID of the compartment that contains the alert.

accessLevel string
compartmentIdInSubtree boolean
fields string[]
filters GetAlertsFilter[]
id string

The OCID of the alert.

scimQuery string
alert_collections GetAlertsAlertCollection]

The list of alert_collection.

compartment_id str

The OCID of the compartment that contains the alert.

access_level str
compartment_id_in_subtree bool
fields Sequence[str]
filters GetAlertsFilter]
id str

The OCID of the alert.

scim_query str
alertCollections List<Property Map>

The list of alert_collection.

compartmentId String

The OCID of the compartment that contains the alert.

accessLevel String
compartmentIdInSubtree Boolean
fields List<String>
filters List<Property Map>
id String

The OCID of the alert.

scimQuery String

Supporting Types

GetAlertsAlertCollection

GetAlertsAlertCollectionItem

AlertId string
AlertType string

Type of the alert. Indicates the Data Safe feature triggering the alert.

Comment string

A comment for the alert. Entered by the user.

CompartmentId string

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

DefinedTags Dictionary<string, object>

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 alert.

DisplayName string

The display name of the alert.

FeatureDetails Dictionary<string, object>

Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}

FreeformTags Dictionary<string, object>

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

A filter to return alert by it's OCID.

Operation string

The operation (event) that triggered alert.

OperationStatus string

The result of the operation (event) that triggered alert.

OperationTime string

Creation date and time of the operation that triggered alert, in the format defined by RFC3339.

PolicyId string

The OCID of the policy that triggered alert.

ResourceName string

The resource endpoint that triggered the alert.

Severity string

Severity level of the alert.

State string

The current state of the alert.

Status string

The status of the alert.

SystemTags Dictionary<string, object>

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"}

TargetIds List<string>

Array of OCIDs of the target database which are associated with the alert.

TargetNames List<string>

Array of names of the target database.

TimeCreated string

Creation date and time of the alert, in the format defined by RFC3339.

TimeUpdated string

Last date and time the alert was updated, in the format defined by RFC3339.

AlertId string
AlertType string

Type of the alert. Indicates the Data Safe feature triggering the alert.

Comment string

A comment for the alert. Entered by the user.

CompartmentId string

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

DefinedTags map[string]interface{}

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 alert.

DisplayName string

The display name of the alert.

FeatureDetails map[string]interface{}

Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}

FreeformTags map[string]interface{}

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

A filter to return alert by it's OCID.

Operation string

The operation (event) that triggered alert.

OperationStatus string

The result of the operation (event) that triggered alert.

OperationTime string

Creation date and time of the operation that triggered alert, in the format defined by RFC3339.

PolicyId string

The OCID of the policy that triggered alert.

ResourceName string

The resource endpoint that triggered the alert.

Severity string

Severity level of the alert.

State string

The current state of the alert.

Status string

The status of the alert.

SystemTags map[string]interface{}

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"}

TargetIds []string

Array of OCIDs of the target database which are associated with the alert.

TargetNames []string

Array of names of the target database.

TimeCreated string

Creation date and time of the alert, in the format defined by RFC3339.

TimeUpdated string

Last date and time the alert was updated, in the format defined by RFC3339.

alertId String
alertType String

Type of the alert. Indicates the Data Safe feature triggering the alert.

comment String

A comment for the alert. Entered by the user.

compartmentId String

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

definedTags Map<String,Object>

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 alert.

displayName String

The display name of the alert.

featureDetails Map<String,Object>

Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}

freeformTags Map<String,Object>

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

A filter to return alert by it's OCID.

operation String

The operation (event) that triggered alert.

operationStatus String

The result of the operation (event) that triggered alert.

operationTime String

Creation date and time of the operation that triggered alert, in the format defined by RFC3339.

policyId String

The OCID of the policy that triggered alert.

resourceName String

The resource endpoint that triggered the alert.

severity String

Severity level of the alert.

state String

The current state of the alert.

status String

The status of the alert.

systemTags Map<String,Object>

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"}

targetIds List<String>

Array of OCIDs of the target database which are associated with the alert.

targetNames List<String>

Array of names of the target database.

timeCreated String

Creation date and time of the alert, in the format defined by RFC3339.

timeUpdated String

Last date and time the alert was updated, in the format defined by RFC3339.

alertId string
alertType string

Type of the alert. Indicates the Data Safe feature triggering the alert.

comment string

A comment for the alert. Entered by the user.

compartmentId string

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

definedTags {[key: string]: any}

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 alert.

displayName string

The display name of the alert.

featureDetails {[key: string]: any}

Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}

freeformTags {[key: string]: any}

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

A filter to return alert by it's OCID.

operation string

The operation (event) that triggered alert.

operationStatus string

The result of the operation (event) that triggered alert.

operationTime string

Creation date and time of the operation that triggered alert, in the format defined by RFC3339.

policyId string

The OCID of the policy that triggered alert.

resourceName string

The resource endpoint that triggered the alert.

severity string

Severity level of the alert.

state string

The current state of the alert.

status string

The status of the alert.

systemTags {[key: string]: any}

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"}

targetIds string[]

Array of OCIDs of the target database which are associated with the alert.

targetNames string[]

Array of names of the target database.

timeCreated string

Creation date and time of the alert, in the format defined by RFC3339.

timeUpdated string

Last date and time the alert was updated, in the format defined by RFC3339.

alert_id str
alert_type str

Type of the alert. Indicates the Data Safe feature triggering the alert.

comment str

A comment for the alert. Entered by the user.

compartment_id str

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

defined_tags Mapping[str, Any]

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 alert.

display_name str

The display name of the alert.

feature_details Mapping[str, Any]

Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}

freeform_tags Mapping[str, Any]

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

A filter to return alert by it's OCID.

operation str

The operation (event) that triggered alert.

operation_status str

The result of the operation (event) that triggered alert.

operation_time str

Creation date and time of the operation that triggered alert, in the format defined by RFC3339.

policy_id str

The OCID of the policy that triggered alert.

resource_name str

The resource endpoint that triggered the alert.

severity str

Severity level of the alert.

state str

The current state of the alert.

status str

The status of the alert.

system_tags Mapping[str, Any]

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_ids Sequence[str]

Array of OCIDs of the target database which are associated with the alert.

target_names Sequence[str]

Array of names of the target database.

time_created str

Creation date and time of the alert, in the format defined by RFC3339.

time_updated str

Last date and time the alert was updated, in the format defined by RFC3339.

alertId String
alertType String

Type of the alert. Indicates the Data Safe feature triggering the alert.

comment String

A comment for the alert. Entered by the user.

compartmentId String

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

definedTags Map<Any>

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 alert.

displayName String

The display name of the alert.

featureDetails Map<Any>

Map that contains maps of values. Example: {"Operations": {"CostCenter": "42"}}

freeformTags Map<Any>

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

A filter to return alert by it's OCID.

operation String

The operation (event) that triggered alert.

operationStatus String

The result of the operation (event) that triggered alert.

operationTime String

Creation date and time of the operation that triggered alert, in the format defined by RFC3339.

policyId String

The OCID of the policy that triggered alert.

resourceName String

The resource endpoint that triggered the alert.

severity String

Severity level of the alert.

state String

The current state of the alert.

status String

The status of the alert.

systemTags Map<Any>

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"}

targetIds List<String>

Array of OCIDs of the target database which are associated with the alert.

targetNames List<String>

Array of names of the target database.

timeCreated String

Creation date and time of the alert, in the format defined by RFC3339.

timeUpdated String

Last date and time the alert was updated, in the format defined by RFC3339.

GetAlertsFilter

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

Package Details

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

This Pulumi package is based on the oci Terraform Provider.