Oracle Cloud Infrastructure v2.17.0, Nov 15 24

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

oci.CloudGuard.getManagedLists

Explore with Pulumi AI

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

The parameter accessLevel specifies whether to return ManagedLists in only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListManagedLists on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Example Usage

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

const testManagedLists = oci.CloudGuard.getManagedLists({
    compartmentId: compartmentId,
    accessLevel: managedListAccessLevel,
    compartmentIdInSubtree: managedListCompartmentIdInSubtree,
    displayName: managedListDisplayName,
    listType: managedListListType,
    resourceMetadataOnly: managedListResourceMetadataOnly,
    state: managedListState,
});

import pulumi
import pulumi_oci as oci

test_managed_lists = oci.CloudGuard.get_managed_lists(compartment_id=compartment_id,
    access_level=managed_list_access_level,
    compartment_id_in_subtree=managed_list_compartment_id_in_subtree,
    display_name=managed_list_display_name,
    list_type=managed_list_list_type,
    resource_metadata_only=managed_list_resource_metadata_only,
    state=managed_list_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/CloudGuard"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := CloudGuard.GetManagedLists(ctx, &cloudguard.GetManagedListsArgs{
			CompartmentId:          compartmentId,
			AccessLevel:            pulumi.StringRef(managedListAccessLevel),
			CompartmentIdInSubtree: pulumi.BoolRef(managedListCompartmentIdInSubtree),
			DisplayName:            pulumi.StringRef(managedListDisplayName),
			ListType:               pulumi.StringRef(managedListListType),
			ResourceMetadataOnly:   pulumi.BoolRef(managedListResourceMetadataOnly),
			State:                  pulumi.StringRef(managedListState),
		}, 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 testManagedLists = Oci.CloudGuard.GetManagedLists.Invoke(new()
    {
        CompartmentId = compartmentId,
        AccessLevel = managedListAccessLevel,
        CompartmentIdInSubtree = managedListCompartmentIdInSubtree,
        DisplayName = managedListDisplayName,
        ListType = managedListListType,
        ResourceMetadataOnly = managedListResourceMetadataOnly,
        State = managedListState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.CloudGuard.CloudGuardFunctions;
import com.pulumi.oci.CloudGuard.inputs.GetManagedListsArgs;
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 testManagedLists = CloudGuardFunctions.getManagedLists(GetManagedListsArgs.builder()
            .compartmentId(compartmentId)
            .accessLevel(managedListAccessLevel)
            .compartmentIdInSubtree(managedListCompartmentIdInSubtree)
            .displayName(managedListDisplayName)
            .listType(managedListListType)
            .resourceMetadataOnly(managedListResourceMetadataOnly)
            .state(managedListState)
            .build());

    }
}

variables:
  testManagedLists:
    fn::invoke:
      Function: oci:CloudGuard:getManagedLists
      Arguments:
        compartmentId: ${compartmentId}
        accessLevel: ${managedListAccessLevel}
        compartmentIdInSubtree: ${managedListCompartmentIdInSubtree}
        displayName: ${managedListDisplayName}
        listType: ${managedListListType}
        resourceMetadataOnly: ${managedListResourceMetadataOnly}
        state: ${managedListState}

Using getManagedLists

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 getManagedLists(args: GetManagedListsArgs, opts?: InvokeOptions): Promise<GetManagedListsResult>
function getManagedListsOutput(args: GetManagedListsOutputArgs, opts?: InvokeOptions): Output<GetManagedListsResult>

def get_managed_lists(access_level: Optional[str] = None,
                      compartment_id: Optional[str] = None,
                      compartment_id_in_subtree: Optional[bool] = None,
                      display_name: Optional[str] = None,
                      filters: Optional[Sequence[_cloudguard.GetManagedListsFilter]] = None,
                      list_type: Optional[str] = None,
                      resource_metadata_only: Optional[bool] = None,
                      state: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetManagedListsResult
def get_managed_lists_output(access_level: Optional[pulumi.Input[str]] = None,
                      compartment_id: Optional[pulumi.Input[str]] = None,
                      compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                      display_name: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_cloudguard.GetManagedListsFilterArgs]]]] = None,
                      list_type: Optional[pulumi.Input[str]] = None,
                      resource_metadata_only: Optional[pulumi.Input[bool]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetManagedListsResult]

func GetManagedLists(ctx *Context, args *GetManagedListsArgs, opts ...InvokeOption) (*GetManagedListsResult, error)
func GetManagedListsOutput(ctx *Context, args *GetManagedListsOutputArgs, opts ...InvokeOption) GetManagedListsResultOutput

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

public static class GetManagedLists 
{
    public static Task<GetManagedListsResult> InvokeAsync(GetManagedListsArgs args, InvokeOptions? opts = null)
    public static Output<GetManagedListsResult> Invoke(GetManagedListsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagedListsResult> getManagedLists(GetManagedListsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:CloudGuard/getManagedLists:getManagedLists
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment in which to list resources.
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 depending on the setting of accessLevel.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters List<GetManagedListsFilter>
ListType string: The type of managed list.
ResourceMetadataOnly bool: Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
State string: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

CompartmentId string: The OCID of the compartment in which to list resources.
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 depending on the setting of accessLevel.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters []GetManagedListsFilter
ListType string: The type of managed list.
ResourceMetadataOnly bool: Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
State string: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

compartmentId String: The OCID of the compartment in which to list resources.
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 depending on the setting of accessLevel.
displayName String: A filter to return only resources that match the entire display name given.
filters List<GetManagedListsFilter>
listType String: The type of managed list.
resourceMetadataOnly Boolean: Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
state String: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

compartmentId string: The OCID of the compartment in which to list resources.
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 depending on the setting of accessLevel.
displayName string: A filter to return only resources that match the entire display name given.
filters GetManagedListsFilter[]
listType string: The type of managed list.
resourceMetadataOnly boolean: Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
state string: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

compartment_id str: The OCID of the compartment in which to list resources.
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 depending on the setting of accessLevel.
display_name str: A filter to return only resources that match the entire display name given.
filters Sequence[cloudguard.GetManagedListsFilter]
list_type str: The type of managed list.
resource_metadata_only bool: Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
state str: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

compartmentId String: The OCID of the compartment in which to list resources.
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 depending on the setting of accessLevel.
displayName String: A filter to return only resources that match the entire display name given.
filters List<Property Map>
listType String: The type of managed list.
resourceMetadataOnly Boolean: Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
state String: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

getManagedLists Result

The following output properties are available:

CompartmentId string: Compartment OCID where the resource is created
Id string: The provider-assigned unique ID for this managed resource.
ManagedListCollections List<GetManagedListsManagedListCollection>: The list of managed_list_collection.
AccessLevel string
CompartmentIdInSubtree bool
DisplayName string: Managed list display name
Filters List<GetManagedListsFilter>
ListType string: Type of information contained in the managed list
ResourceMetadataOnly bool
State string: The current lifecycle state of the resource

CompartmentId string: Compartment OCID where the resource is created
Id string: The provider-assigned unique ID for this managed resource.
ManagedListCollections []GetManagedListsManagedListCollection: The list of managed_list_collection.
AccessLevel string
CompartmentIdInSubtree bool
DisplayName string: Managed list display name
Filters []GetManagedListsFilter
ListType string: Type of information contained in the managed list
ResourceMetadataOnly bool
State string: The current lifecycle state of the resource

compartmentId String: Compartment OCID where the resource is created
id String: The provider-assigned unique ID for this managed resource.
managedListCollections List<GetManagedListsManagedListCollection>: The list of managed_list_collection.
accessLevel String
compartmentIdInSubtree Boolean
displayName String: Managed list display name
filters List<GetManagedListsFilter>
listType String: Type of information contained in the managed list
resourceMetadataOnly Boolean
state String: The current lifecycle state of the resource

compartmentId string: Compartment OCID where the resource is created
id string: The provider-assigned unique ID for this managed resource.
managedListCollections GetManagedListsManagedListCollection[]: The list of managed_list_collection.
accessLevel string
compartmentIdInSubtree boolean
displayName string: Managed list display name
filters GetManagedListsFilter[]
listType string: Type of information contained in the managed list
resourceMetadataOnly boolean
state string: The current lifecycle state of the resource

compartment_id str: Compartment OCID where the resource is created
id str: The provider-assigned unique ID for this managed resource.
managed_list_collections Sequence[cloudguard.GetManagedListsManagedListCollection]: The list of managed_list_collection.
access_level str
compartment_id_in_subtree bool
display_name str: Managed list display name
filters Sequence[cloudguard.GetManagedListsFilter]
list_type str: Type of information contained in the managed list
resource_metadata_only bool
state str: The current lifecycle state of the resource

compartmentId String: Compartment OCID where the resource is created
id String: The provider-assigned unique ID for this managed resource.
managedListCollections List<Property Map>: The list of managed_list_collection.
accessLevel String
compartmentIdInSubtree Boolean
displayName String: Managed list display name
filters List<Property Map>
listType String: Type of information contained in the managed list
resourceMetadataOnly Boolean
state String: The current lifecycle state of the resource

Supporting Types

GetManagedListsFilter

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

GetManagedListsManagedListCollection

Items List<GetManagedListsManagedListCollectionItem>

Items []GetManagedListsManagedListCollectionItem

items List<GetManagedListsManagedListCollectionItem>

items GetManagedListsManagedListCollectionItem[]

items Sequence[cloudguard.GetManagedListsManagedListCollectionItem]

items List<Property Map>

GetManagedListsManagedListCollectionItem

CompartmentId string: The OCID of the compartment in which to list resources.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: Managed list description
DisplayName string: A filter to return only resources that match the entire display name given.
FeedProvider string: Provider of the managed list feed
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that can't be changed after creation
IsEditable bool: Is this list editable?
LifecyleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]
ListItems List<string>: List of items in the managed list
ListType string: The type of managed list.
SourceManagedListId string: OCID of the source managed list
State string: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the managed list was created. Format defined by RFC3339.
TimeUpdated string: The date and time the managed list was last updated. Format defined by RFC3339.

CompartmentId string: The OCID of the compartment in which to list resources.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: Managed list description
DisplayName string: A filter to return only resources that match the entire display name given.
FeedProvider string: Provider of the managed list feed
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier that can't be changed after creation
IsEditable bool: Is this list editable?
LifecyleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]
ListItems []string: List of items in the managed list
ListType string: The type of managed list.
SourceManagedListId string: OCID of the source managed list
State string: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the managed list was created. Format defined by RFC3339.
TimeUpdated string: The date and time the managed list was last updated. Format defined by RFC3339.

compartmentId String: The OCID of the compartment in which to list resources.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: Managed list description
displayName String: A filter to return only resources that match the entire display name given.
feedProvider String: Provider of the managed list feed
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that can't be changed after creation
isEditable Boolean: Is this list editable?
lifecyleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]
listItems List<String>: List of items in the managed list
listType String: The type of managed list.
sourceManagedListId String: OCID of the source managed list
state String: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the managed list was created. Format defined by RFC3339.
timeUpdated String: The date and time the managed list was last updated. Format defined by RFC3339.

compartmentId string: The OCID of the compartment in which to list resources.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: Managed list description
displayName string: A filter to return only resources that match the entire display name given.
feedProvider string: Provider of the managed list feed
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier that can't be changed after creation
isEditable boolean: Is this list editable?
lifecyleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]
listItems string[]: List of items in the managed list
listType string: The type of managed list.
sourceManagedListId string: OCID of the source managed list
state string: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The date and time the managed list was created. Format defined by RFC3339.
timeUpdated string: The date and time the managed list was last updated. Format defined by RFC3339.

compartment_id str: The OCID of the compartment in which to list resources.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str: Managed list description
display_name str: A filter to return only resources that match the entire display name given.
feed_provider str: Provider of the managed list feed
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Unique identifier that can't be changed after creation
is_editable bool: Is this list editable?
lifecyle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]
list_items Sequence[str]: List of items in the managed list
list_type str: The type of managed list.
source_managed_list_id str: OCID of the source managed list
state str: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
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. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The date and time the managed list was created. Format defined by RFC3339.
time_updated str: The date and time the managed list was last updated. Format defined by RFC3339.

compartmentId String: The OCID of the compartment in which to list resources.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: Managed list description
displayName String: A filter to return only resources that match the entire display name given.
feedProvider String: Provider of the managed list feed
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier that can't be changed after creation
isEditable Boolean: Is this list editable?
lifecyleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]
listItems List<String>: List of items in the managed list
listType String: The type of managed list.
sourceManagedListId String: OCID of the source managed list
state String: The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the managed list was created. Format defined by RFC3339.
timeUpdated String: The date and time the managed list was last updated. Format defined by RFC3339.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

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

pulumi/pulumi-oci

oci.CloudGuard.getManagedLists

On this page

On this page

Example Usage

Using getManagedLists

getManagedLists Result

Supporting Types

GetManagedListsFilter

GetManagedListsManagedListCollection

GetManagedListsManagedListCollectionItem

Package Details

On this page

On this page