Oracle Cloud Infrastructure v2.17.0, Nov 15 24

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

oci.ApmConfig.getConfigs

Explore with Pulumi AI

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

Example Usage

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

const testConfigs = oci.ApmConfig.getConfigs({
    apmDomainId: testApmDomain.id,
    configType: configConfigType,
    definedTagEquals: configDefinedTagEquals,
    definedTagExists: configDefinedTagExists,
    displayName: configDisplayName,
    freeformTagEquals: configFreeformTagEquals,
    freeformTagExists: configFreeformTagExists,
    optionsGroup: configOptionsGroup,
});

import pulumi
import pulumi_oci as oci

test_configs = oci.ApmConfig.get_configs(apm_domain_id=test_apm_domain["id"],
    config_type=config_config_type,
    defined_tag_equals=config_defined_tag_equals,
    defined_tag_exists=config_defined_tag_exists,
    display_name=config_display_name,
    freeform_tag_equals=config_freeform_tag_equals,
    freeform_tag_exists=config_freeform_tag_exists,
    options_group=config_options_group)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ApmConfig.GetConfigs(ctx, &apmconfig.GetConfigsArgs{
			ApmDomainId:       testApmDomain.Id,
			ConfigType:        pulumi.StringRef(configConfigType),
			DefinedTagEquals:  configDefinedTagEquals,
			DefinedTagExists:  configDefinedTagExists,
			DisplayName:       pulumi.StringRef(configDisplayName),
			FreeformTagEquals: configFreeformTagEquals,
			FreeformTagExists: configFreeformTagExists,
			OptionsGroup:      pulumi.StringRef(configOptionsGroup),
		}, 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 testConfigs = Oci.ApmConfig.GetConfigs.Invoke(new()
    {
        ApmDomainId = testApmDomain.Id,
        ConfigType = configConfigType,
        DefinedTagEquals = configDefinedTagEquals,
        DefinedTagExists = configDefinedTagExists,
        DisplayName = configDisplayName,
        FreeformTagEquals = configFreeformTagEquals,
        FreeformTagExists = configFreeformTagExists,
        OptionsGroup = configOptionsGroup,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApmConfig.ApmConfigFunctions;
import com.pulumi.oci.ApmConfig.inputs.GetConfigsArgs;
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 testConfigs = ApmConfigFunctions.getConfigs(GetConfigsArgs.builder()
            .apmDomainId(testApmDomain.id())
            .configType(configConfigType)
            .definedTagEquals(configDefinedTagEquals)
            .definedTagExists(configDefinedTagExists)
            .displayName(configDisplayName)
            .freeformTagEquals(configFreeformTagEquals)
            .freeformTagExists(configFreeformTagExists)
            .optionsGroup(configOptionsGroup)
            .build());

    }
}

variables:
  testConfigs:
    fn::invoke:
      Function: oci:ApmConfig:getConfigs
      Arguments:
        apmDomainId: ${testApmDomain.id}
        configType: ${configConfigType}
        definedTagEquals: ${configDefinedTagEquals}
        definedTagExists: ${configDefinedTagExists}
        displayName: ${configDisplayName}
        freeformTagEquals: ${configFreeformTagEquals}
        freeformTagExists: ${configFreeformTagExists}
        optionsGroup: ${configOptionsGroup}

Using getConfigs

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 getConfigs(args: GetConfigsArgs, opts?: InvokeOptions): Promise<GetConfigsResult>
function getConfigsOutput(args: GetConfigsOutputArgs, opts?: InvokeOptions): Output<GetConfigsResult>

def get_configs(apm_domain_id: Optional[str] = None,
                config_type: Optional[str] = None,
                defined_tag_equals: Optional[Sequence[str]] = None,
                defined_tag_exists: Optional[Sequence[str]] = None,
                display_name: Optional[str] = None,
                filters: Optional[Sequence[_apmconfig.GetConfigsFilter]] = None,
                freeform_tag_equals: Optional[Sequence[str]] = None,
                freeform_tag_exists: Optional[Sequence[str]] = None,
                options_group: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetConfigsResult
def get_configs_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                config_type: Optional[pulumi.Input[str]] = None,
                defined_tag_equals: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                defined_tag_exists: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                display_name: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_apmconfig.GetConfigsFilterArgs]]]] = None,
                freeform_tag_equals: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                freeform_tag_exists: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                options_group: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetConfigsResult]

func GetConfigs(ctx *Context, args *GetConfigsArgs, opts ...InvokeOption) (*GetConfigsResult, error)
func GetConfigsOutput(ctx *Context, args *GetConfigsOutputArgs, opts ...InvokeOption) GetConfigsResultOutput

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

public static class GetConfigs 
{
    public static Task<GetConfigsResult> InvokeAsync(GetConfigsArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigsResult> Invoke(GetConfigsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConfigsResult> getConfigs(GetConfigsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:ApmConfig/getConfigs:getConfigs
  arguments:
    # arguments dictionary

The following arguments are supported:

ApmDomainId string: The APM Domain ID the request is intended for.
ConfigType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
DefinedTagEquals List<string>: A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
DefinedTagExists List<string>: A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
DisplayName string: A filter to return resources that match the given display name.
Filters List<GetConfigsFilter>
FreeformTagEquals List<string>: A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
FreeformTagExists List<string>: A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
OptionsGroup string: A filter to return OPTIONS resources that match the given group.

ApmDomainId string: The APM Domain ID the request is intended for.
ConfigType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
DefinedTagEquals []string: A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
DefinedTagExists []string: A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
DisplayName string: A filter to return resources that match the given display name.
Filters []GetConfigsFilter
FreeformTagEquals []string: A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
FreeformTagExists []string: A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
OptionsGroup string: A filter to return OPTIONS resources that match the given group.

apmDomainId String: The APM Domain ID the request is intended for.
configType String: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
definedTagEquals List<String>: A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
definedTagExists List<String>: A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
displayName String: A filter to return resources that match the given display name.
filters List<GetConfigsFilter>
freeformTagEquals List<String>: A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
freeformTagExists List<String>: A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
optionsGroup String: A filter to return OPTIONS resources that match the given group.

apmDomainId string: The APM Domain ID the request is intended for.
configType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
definedTagEquals string[]: A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
definedTagExists string[]: A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
displayName string: A filter to return resources that match the given display name.
filters GetConfigsFilter[]
freeformTagEquals string[]: A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
freeformTagExists string[]: A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
optionsGroup string: A filter to return OPTIONS resources that match the given group.

apm_domain_id str: The APM Domain ID the request is intended for.
config_type str: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
defined_tag_equals Sequence[str]: A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
defined_tag_exists Sequence[str]: A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
display_name str: A filter to return resources that match the given display name.
filters Sequence[apmconfig.GetConfigsFilter]
freeform_tag_equals Sequence[str]: A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
freeform_tag_exists Sequence[str]: A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
options_group str: A filter to return OPTIONS resources that match the given group.

apmDomainId String: The APM Domain ID the request is intended for.
configType String: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
definedTagEquals List<String>: A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
definedTagExists List<String>: A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
displayName String: A filter to return resources that match the given display name.
filters List<Property Map>
freeformTagEquals List<String>: A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
freeformTagExists List<String>: A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
optionsGroup String: A filter to return OPTIONS resources that match the given group.

getConfigs Result

The following output properties are available:

ApmDomainId string
ConfigCollections List<GetConfigsConfigCollection>: The list of config_collection.
Id string: The provider-assigned unique ID for this managed resource.
ConfigType string: The type of configuration item.
DefinedTagEquals List<string>
DefinedTagExists List<string>
DisplayName string: The name by which a configuration entity is displayed to the end user.
Filters List<GetConfigsFilter>
FreeformTagEquals List<string>
FreeformTagExists List<string>
OptionsGroup string: A string that specifies the group that an OPTIONS item belongs to.

ApmDomainId string
ConfigCollections []GetConfigsConfigCollection: The list of config_collection.
Id string: The provider-assigned unique ID for this managed resource.
ConfigType string: The type of configuration item.
DefinedTagEquals []string
DefinedTagExists []string
DisplayName string: The name by which a configuration entity is displayed to the end user.
Filters []GetConfigsFilter
FreeformTagEquals []string
FreeformTagExists []string
OptionsGroup string: A string that specifies the group that an OPTIONS item belongs to.

apmDomainId String
configCollections List<GetConfigsConfigCollection>: The list of config_collection.
id String: The provider-assigned unique ID for this managed resource.
configType String: The type of configuration item.
definedTagEquals List<String>
definedTagExists List<String>
displayName String: The name by which a configuration entity is displayed to the end user.
filters List<GetConfigsFilter>
freeformTagEquals List<String>
freeformTagExists List<String>
optionsGroup String: A string that specifies the group that an OPTIONS item belongs to.

apmDomainId string
configCollections GetConfigsConfigCollection[]: The list of config_collection.
id string: The provider-assigned unique ID for this managed resource.
configType string: The type of configuration item.
definedTagEquals string[]
definedTagExists string[]
displayName string: The name by which a configuration entity is displayed to the end user.
filters GetConfigsFilter[]
freeformTagEquals string[]
freeformTagExists string[]
optionsGroup string: A string that specifies the group that an OPTIONS item belongs to.

apm_domain_id str
config_collections Sequence[apmconfig.GetConfigsConfigCollection]: The list of config_collection.
id str: The provider-assigned unique ID for this managed resource.
config_type str: The type of configuration item.
defined_tag_equals Sequence[str]
defined_tag_exists Sequence[str]
display_name str: The name by which a configuration entity is displayed to the end user.
filters Sequence[apmconfig.GetConfigsFilter]
freeform_tag_equals Sequence[str]
freeform_tag_exists Sequence[str]
options_group str: A string that specifies the group that an OPTIONS item belongs to.

apmDomainId String
configCollections List<Property Map>: The list of config_collection.
id String: The provider-assigned unique ID for this managed resource.
configType String: The type of configuration item.
definedTagEquals List<String>
definedTagExists List<String>
displayName String: The name by which a configuration entity is displayed to the end user.
filters List<Property Map>
freeformTagEquals List<String>
freeformTagExists List<String>
optionsGroup String: A string that specifies the group that an OPTIONS item belongs to.

Supporting Types

GetConfigsConfigCollection

Items List<GetConfigsConfigCollectionItem>

Items []GetConfigsConfigCollectionItem

items List<GetConfigsConfigCollectionItem>

items GetConfigsConfigCollectionItem[]

items Sequence[apmconfig.GetConfigsConfigCollectionItem]

items List<Property Map>

GetConfigsConfigCollectionItem

ApmDomainId string: The APM Domain ID the request is intended for.
ConfigType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
CreatedBy string: The OCID of a user.
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: A description of the metric.
Dimensions List<GetConfigsConfigCollectionItemDimension>: A list of dimensions for the metric. This variable should not be used.
DisplayName string: A filter to return resources that match the given display name.
Etag string: For optimistic concurrency control. See if-match.
FilterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
FilterText string: The string that defines the Span Filter expression.
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"}
Group string: A string that specifies the group that an OPTIONS item belongs to.
Id string: The OCID of the configuration item. An OCID is generated when the item is created.
InUseBies List<GetConfigsConfigCollectionItemInUseBy>: The list of configuration items that reference the span filter.
Metrics List<GetConfigsConfigCollectionItemMetric>: The list of metrics in this group.
Namespace string: The namespace to which the metrics are published. It must be one of several predefined namespaces.
OpcDryRun string
Options string: The options are stored here as JSON.
Rules List<GetConfigsConfigCollectionItemRule>
TimeCreated string: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeUpdated string: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
UpdatedBy string: The OCID of a user.

ApmDomainId string: The APM Domain ID the request is intended for.
ConfigType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
CreatedBy string: The OCID of a user.
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: A description of the metric.
Dimensions []GetConfigsConfigCollectionItemDimension: A list of dimensions for the metric. This variable should not be used.
DisplayName string: A filter to return resources that match the given display name.
Etag string: For optimistic concurrency control. See if-match.
FilterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
FilterText string: The string that defines the Span Filter expression.
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"}
Group string: A string that specifies the group that an OPTIONS item belongs to.
Id string: The OCID of the configuration item. An OCID is generated when the item is created.
InUseBies []GetConfigsConfigCollectionItemInUseBy: The list of configuration items that reference the span filter.
Metrics []GetConfigsConfigCollectionItemMetric: The list of metrics in this group.
Namespace string: The namespace to which the metrics are published. It must be one of several predefined namespaces.
OpcDryRun string
Options string: The options are stored here as JSON.
Rules []GetConfigsConfigCollectionItemRule
TimeCreated string: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeUpdated string: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
UpdatedBy string: The OCID of a user.

apmDomainId String: The APM Domain ID the request is intended for.
configType String: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
createdBy String: The OCID of a user.
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: A description of the metric.
dimensions List<GetConfigsConfigCollectionItemDimension>: A list of dimensions for the metric. This variable should not be used.
displayName String: A filter to return resources that match the given display name.
etag String: For optimistic concurrency control. See if-match.
filterId String: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
filterText String: The string that defines the Span Filter expression.
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"}
group String: A string that specifies the group that an OPTIONS item belongs to.
id String: The OCID of the configuration item. An OCID is generated when the item is created.
inUseBies List<GetConfigsConfigCollectionItemInUseBy>: The list of configuration items that reference the span filter.
metrics List<GetConfigsConfigCollectionItemMetric>: The list of metrics in this group.
namespace String: The namespace to which the metrics are published. It must be one of several predefined namespaces.
opcDryRun String
options String: The options are stored here as JSON.
rules List<GetConfigsConfigCollectionItemRule>
timeCreated String: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated String: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
updatedBy String: The OCID of a user.

apmDomainId string: The APM Domain ID the request is intended for.
configType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
createdBy string: The OCID of a user.
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: A description of the metric.
dimensions GetConfigsConfigCollectionItemDimension[]: A list of dimensions for the metric. This variable should not be used.
displayName string: A filter to return resources that match the given display name.
etag string: For optimistic concurrency control. See if-match.
filterId string: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
filterText string: The string that defines the Span Filter expression.
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"}
group string: A string that specifies the group that an OPTIONS item belongs to.
id string: The OCID of the configuration item. An OCID is generated when the item is created.
inUseBies GetConfigsConfigCollectionItemInUseBy[]: The list of configuration items that reference the span filter.
metrics GetConfigsConfigCollectionItemMetric[]: The list of metrics in this group.
namespace string: The namespace to which the metrics are published. It must be one of several predefined namespaces.
opcDryRun string
options string: The options are stored here as JSON.
rules GetConfigsConfigCollectionItemRule[]
timeCreated string: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated string: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
updatedBy string: The OCID of a user.

apm_domain_id str: The APM Domain ID the request is intended for.
config_type str: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
created_by str: The OCID of a user.
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: A description of the metric.
dimensions Sequence[apmconfig.GetConfigsConfigCollectionItemDimension]: A list of dimensions for the metric. This variable should not be used.
display_name str: A filter to return resources that match the given display name.
etag str: For optimistic concurrency control. See if-match.
filter_id str: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
filter_text str: The string that defines the Span Filter expression.
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"}
group str: A string that specifies the group that an OPTIONS item belongs to.
id str: The OCID of the configuration item. An OCID is generated when the item is created.
in_use_bies Sequence[apmconfig.GetConfigsConfigCollectionItemInUseBy]: The list of configuration items that reference the span filter.
metrics Sequence[apmconfig.GetConfigsConfigCollectionItemMetric]: The list of metrics in this group.
namespace str: The namespace to which the metrics are published. It must be one of several predefined namespaces.
opc_dry_run str
options str: The options are stored here as JSON.
rules Sequence[apmconfig.GetConfigsConfigCollectionItemRule]
time_created str: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
time_updated str: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
updated_by str: The OCID of a user.

apmDomainId String: The APM Domain ID the request is intended for.
configType String: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
createdBy String: The OCID of a user.
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: A description of the metric.
dimensions List<Property Map>: A list of dimensions for the metric. This variable should not be used.
displayName String: A filter to return resources that match the given display name.
etag String: For optimistic concurrency control. See if-match.
filterId String: The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
filterText String: The string that defines the Span Filter expression.
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"}
group String: A string that specifies the group that an OPTIONS item belongs to.
id String: The OCID of the configuration item. An OCID is generated when the item is created.
inUseBies List<Property Map>: The list of configuration items that reference the span filter.
metrics List<Property Map>: The list of metrics in this group.
namespace String: The namespace to which the metrics are published. It must be one of several predefined namespaces.
opcDryRun String
options String: The options are stored here as JSON.
rules List<Property Map>
timeCreated String: The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated String: The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
updatedBy String: The OCID of a user.

GetConfigsConfigCollectionItemDimension

Name string: The name of the metric. This must be a known metric name.
ValueSource string: This must not be set.

Name string: The name of the metric. This must be a known metric name.
ValueSource string: This must not be set.

name String: The name of the metric. This must be a known metric name.
valueSource String: This must not be set.

name string: The name of the metric. This must be a known metric name.
valueSource string: This must not be set.

name str: The name of the metric. This must be a known metric name.
value_source str: This must not be set.

name String: The name of the metric. This must be a known metric name.
valueSource String: This must not be set.

GetConfigsConfigCollectionItemInUseBy

ConfigType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
DisplayName string: A filter to return resources that match the given display name.
Id string: The OCID of the configuration item. An OCID is generated when the item is created.
OptionsGroup string: A filter to return OPTIONS resources that match the given group.

ConfigType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
DisplayName string: A filter to return resources that match the given display name.
Id string: The OCID of the configuration item. An OCID is generated when the item is created.
OptionsGroup string: A filter to return OPTIONS resources that match the given group.

configType String: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
displayName String: A filter to return resources that match the given display name.
id String: The OCID of the configuration item. An OCID is generated when the item is created.
optionsGroup String: A filter to return OPTIONS resources that match the given group.

configType string: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
displayName string: A filter to return resources that match the given display name.
id string: The OCID of the configuration item. An OCID is generated when the item is created.
optionsGroup string: A filter to return OPTIONS resources that match the given group.

config_type str: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
display_name str: A filter to return resources that match the given display name.
id str: The OCID of the configuration item. An OCID is generated when the item is created.
options_group str: A filter to return OPTIONS resources that match the given group.

configType String: A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
displayName String: A filter to return resources that match the given display name.
id String: The OCID of the configuration item. An OCID is generated when the item is created.
optionsGroup String: A filter to return OPTIONS resources that match the given group.

GetConfigsConfigCollectionItemMetric

Description string: A description of the metric.
Name string: The name of the metric. This must be a known metric name.
Unit string: The unit of the metric.
ValueSource string: This must not be set.

Description string: A description of the metric.
Name string: The name of the metric. This must be a known metric name.
Unit string: The unit of the metric.
ValueSource string: This must not be set.

description String: A description of the metric.
name String: The name of the metric. This must be a known metric name.
unit String: The unit of the metric.
valueSource String: This must not be set.

description string: A description of the metric.
name string: The name of the metric. This must be a known metric name.
unit string: The unit of the metric.
valueSource string: This must not be set.

description str: A description of the metric.
name str: The name of the metric. This must be a known metric name.
unit str: The unit of the metric.
value_source str: This must not be set.

description String: A description of the metric.
name String: The name of the metric. This must be a known metric name.
unit String: The unit of the metric.
valueSource String: This must not be set.

GetConfigsConfigCollectionItemRule

DisplayName string: A filter to return resources that match the given display name.
FilterText string: The string that defines the Span Filter expression.
IsApplyToErrorSpans bool: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
IsEnabled bool: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is "true".
Priority int: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
SatisfiedResponseTime int: The maximum response time in milliseconds that is considered "satisfactory" for the end user.
ToleratingResponseTime int: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

DisplayName string: A filter to return resources that match the given display name.
FilterText string: The string that defines the Span Filter expression.
IsApplyToErrorSpans bool: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
IsEnabled bool: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is "true".
Priority int: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
SatisfiedResponseTime int: The maximum response time in milliseconds that is considered "satisfactory" for the end user.
ToleratingResponseTime int: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

displayName String: A filter to return resources that match the given display name.
filterText String: The string that defines the Span Filter expression.
isApplyToErrorSpans Boolean: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
isEnabled Boolean: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is "true".
priority Integer: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
satisfiedResponseTime Integer: The maximum response time in milliseconds that is considered "satisfactory" for the end user.
toleratingResponseTime Integer: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

displayName string: A filter to return resources that match the given display name.
filterText string: The string that defines the Span Filter expression.
isApplyToErrorSpans boolean: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
isEnabled boolean: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is "true".
priority number: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
satisfiedResponseTime number: The maximum response time in milliseconds that is considered "satisfactory" for the end user.
toleratingResponseTime number: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

display_name str: A filter to return resources that match the given display name.
filter_text str: The string that defines the Span Filter expression.
is_apply_to_error_spans bool: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
is_enabled bool: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is "true".
priority int: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
satisfied_response_time int: The maximum response time in milliseconds that is considered "satisfactory" for the end user.
tolerating_response_time int: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

displayName String: A filter to return resources that match the given display name.
filterText String: The string that defines the Span Filter expression.
isApplyToErrorSpans Boolean: Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".
isEnabled Boolean: Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is "true".
priority Number: The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
satisfiedResponseTime Number: The maximum response time in milliseconds that is considered "satisfactory" for the end user.
toleratingResponseTime Number: The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

GetConfigsFilter

Name string: The name of the metric. This must be a known metric name.
Values List<string>
Regex bool

Name string: The name of the metric. This must be a known metric name.
Values []string
Regex bool

name String: The name of the metric. This must be a known metric name.
values List<String>
regex Boolean

name string: The name of the metric. This must be a known metric name.
values string[]
regex boolean

name str: The name of the metric. This must be a known metric name.
values Sequence[str]
regex bool

name String: The name of the metric. This must be a known metric name.
values List<String>
regex Boolean

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.ApmConfig.getConfigs

On this page

On this page

Example Usage

Using getConfigs

getConfigs Result

Supporting Types

GetConfigsConfigCollection

GetConfigsConfigCollectionItem

GetConfigsConfigCollectionItemDimension

GetConfigsConfigCollectionItemInUseBy

GetConfigsConfigCollectionItemMetric

GetConfigsConfigCollectionItemRule

GetConfigsFilter

Package Details

On this page

On this page