1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Apm
  5. getApmDomains
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

oci.Apm.getApmDomains

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

This data source provides the list of Apm Domains in Oracle Cloud Infrastructure Apm service.

Lists all APM domains for the specified tenant compartment.

Example Usage

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

const testApmDomains = oci.Apm.getApmDomains({
    compartmentId: compartmentId,
    displayName: apmDomainDisplayName,
    state: apmDomainState,
});
Copy
import pulumi
import pulumi_oci as oci

test_apm_domains = oci.Apm.get_apm_domains(compartment_id=compartment_id,
    display_name=apm_domain_display_name,
    state=apm_domain_state)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apm.GetApmDomains(ctx, &apm.GetApmDomainsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(apmDomainDisplayName),
			State:         pulumi.StringRef(apmDomainState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testApmDomains = Oci.Apm.GetApmDomains.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = apmDomainDisplayName,
        State = apmDomainState,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Apm.ApmFunctions;
import com.pulumi.oci.Apm.inputs.GetApmDomainsArgs;
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 testApmDomains = ApmFunctions.getApmDomains(GetApmDomainsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(apmDomainDisplayName)
            .state(apmDomainState)
            .build());

    }
}
Copy
variables:
  testApmDomains:
    fn::invoke:
      function: oci:Apm:getApmDomains
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${apmDomainDisplayName}
        state: ${apmDomainState}
Copy

Using getApmDomains

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 getApmDomains(args: GetApmDomainsArgs, opts?: InvokeOptions): Promise<GetApmDomainsResult>
function getApmDomainsOutput(args: GetApmDomainsOutputArgs, opts?: InvokeOptions): Output<GetApmDomainsResult>
Copy
def get_apm_domains(compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    filters: Optional[Sequence[_apm.GetApmDomainsFilter]] = None,
                    state: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApmDomainsResult
def get_apm_domains_output(compartment_id: Optional[pulumi.Input[str]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_apm.GetApmDomainsFilterArgs]]]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApmDomainsResult]
Copy
func GetApmDomains(ctx *Context, args *GetApmDomainsArgs, opts ...InvokeOption) (*GetApmDomainsResult, error)
func GetApmDomainsOutput(ctx *Context, args *GetApmDomainsOutputArgs, opts ...InvokeOption) GetApmDomainsResultOutput
Copy

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

public static class GetApmDomains 
{
    public static Task<GetApmDomainsResult> InvokeAsync(GetApmDomainsArgs args, InvokeOptions? opts = null)
    public static Output<GetApmDomainsResult> Invoke(GetApmDomainsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApmDomainsResult> getApmDomains(GetApmDomainsArgs args, InvokeOptions options)
public static Output<GetApmDomainsResult> getApmDomains(GetApmDomainsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Apm/getApmDomains:getApmDomains
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. List<GetApmDomainsFilter>
State string
A filter to return only resources that match the given life-cycle state.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. []GetApmDomainsFilter
State string
A filter to return only resources that match the given life-cycle state.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<GetDomainsFilter>
state String
A filter to return only resources that match the given life-cycle state.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
displayName string
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. GetApmDomainsFilter[]
state string
A filter to return only resources that match the given life-cycle state.
compartment_id This property is required. str
The ID of the compartment in which to list resources.
display_name str
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. Sequence[apm.GetApmDomainsFilter]
state str
A filter to return only resources that match the given life-cycle state.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<Property Map>
state String
A filter to return only resources that match the given life-cycle state.

getApmDomains Result

The following output properties are available:

ApmDomains List<GetApmDomainsApmDomain>
The list of apm_domains.
CompartmentId string
The OCID of the compartment corresponding to the APM domain.
Id string
The provider-assigned unique ID for this managed resource.
DisplayName string
Display name of the APM domain, which can be updated.
Filters List<GetApmDomainsFilter>
State string
The current lifecycle state of the APM domain.
ApmDomains []GetApmDomainsApmDomain
The list of apm_domains.
CompartmentId string
The OCID of the compartment corresponding to the APM domain.
Id string
The provider-assigned unique ID for this managed resource.
DisplayName string
Display name of the APM domain, which can be updated.
Filters []GetApmDomainsFilter
State string
The current lifecycle state of the APM domain.
apmDomains List<GetDomainsDomain>
The list of apm_domains.
compartmentId String
The OCID of the compartment corresponding to the APM domain.
id String
The provider-assigned unique ID for this managed resource.
displayName String
Display name of the APM domain, which can be updated.
filters List<GetDomainsFilter>
state String
The current lifecycle state of the APM domain.
apmDomains GetApmDomainsApmDomain[]
The list of apm_domains.
compartmentId string
The OCID of the compartment corresponding to the APM domain.
id string
The provider-assigned unique ID for this managed resource.
displayName string
Display name of the APM domain, which can be updated.
filters GetApmDomainsFilter[]
state string
The current lifecycle state of the APM domain.
apm_domains Sequence[apm.GetApmDomainsApmDomain]
The list of apm_domains.
compartment_id str
The OCID of the compartment corresponding to the APM domain.
id str
The provider-assigned unique ID for this managed resource.
display_name str
Display name of the APM domain, which can be updated.
filters Sequence[apm.GetApmDomainsFilter]
state str
The current lifecycle state of the APM domain.
apmDomains List<Property Map>
The list of apm_domains.
compartmentId String
The OCID of the compartment corresponding to the APM domain.
id String
The provider-assigned unique ID for this managed resource.
displayName String
Display name of the APM domain, which can be updated.
filters List<Property Map>
state String
The current lifecycle state of the APM domain.

Supporting Types

GetApmDomainsApmDomain

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DataUploadEndpoint This property is required. string
The endpoint where the APM agents upload their observations and metrics.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
Description of the APM domain.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FreeformTags This property is required. 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 This property is required. string
Unique identifier that is immutable on creation.
IsFreeTier This property is required. bool
Indicates if this is an Always Free resource.
State This property is required. string
A filter to return only resources that match the given life-cycle state.
TimeCreated This property is required. string
The time the APM domain was created, expressed in RFC 3339 timestamp format.
TimeUpdated This property is required. string
The time the APM domain was updated, expressed in RFC 3339 timestamp format.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DataUploadEndpoint This property is required. string
The endpoint where the APM agents upload their observations and metrics.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
Description of the APM domain.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FreeformTags This property is required. 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 This property is required. string
Unique identifier that is immutable on creation.
IsFreeTier This property is required. bool
Indicates if this is an Always Free resource.
State This property is required. string
A filter to return only resources that match the given life-cycle state.
TimeCreated This property is required. string
The time the APM domain was created, expressed in RFC 3339 timestamp format.
TimeUpdated This property is required. string
The time the APM domain was updated, expressed in RFC 3339 timestamp format.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
dataUploadEndpoint This property is required. String
The endpoint where the APM agents upload their observations and metrics.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
Description of the APM domain.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
freeformTags This property is required. 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 This property is required. String
Unique identifier that is immutable on creation.
isFreeTier This property is required. Boolean
Indicates if this is an Always Free resource.
state This property is required. String
A filter to return only resources that match the given life-cycle state.
timeCreated This property is required. String
The time the APM domain was created, expressed in RFC 3339 timestamp format.
timeUpdated This property is required. String
The time the APM domain was updated, expressed in RFC 3339 timestamp format.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
dataUploadEndpoint This property is required. string
The endpoint where the APM agents upload their observations and metrics.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. string
Description of the APM domain.
displayName This property is required. string
A filter to return only resources that match the entire display name given.
freeformTags This property is required. {[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 This property is required. string
Unique identifier that is immutable on creation.
isFreeTier This property is required. boolean
Indicates if this is an Always Free resource.
state This property is required. string
A filter to return only resources that match the given life-cycle state.
timeCreated This property is required. string
The time the APM domain was created, expressed in RFC 3339 timestamp format.
timeUpdated This property is required. string
The time the APM domain was updated, expressed in RFC 3339 timestamp format.
compartment_id This property is required. str
The ID of the compartment in which to list resources.
data_upload_endpoint This property is required. str
The endpoint where the APM agents upload their observations and metrics.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. str
Description of the APM domain.
display_name This property is required. str
A filter to return only resources that match the entire display name given.
freeform_tags This property is required. 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 This property is required. str
Unique identifier that is immutable on creation.
is_free_tier This property is required. bool
Indicates if this is an Always Free resource.
state This property is required. str
A filter to return only resources that match the given life-cycle state.
time_created This property is required. str
The time the APM domain was created, expressed in RFC 3339 timestamp format.
time_updated This property is required. str
The time the APM domain was updated, expressed in RFC 3339 timestamp format.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
dataUploadEndpoint This property is required. String
The endpoint where the APM agents upload their observations and metrics.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
Description of the APM domain.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
freeformTags This property is required. 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 This property is required. String
Unique identifier that is immutable on creation.
isFreeTier This property is required. Boolean
Indicates if this is an Always Free resource.
state This property is required. String
A filter to return only resources that match the given life-cycle state.
timeCreated This property is required. String
The time the APM domain was created, expressed in RFC 3339 timestamp format.
timeUpdated This property is required. String
The time the APM domain was updated, expressed in RFC 3339 timestamp format.

GetApmDomainsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. 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.28.0 published on Thursday, Mar 27, 2025 by Pulumi