Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.Apm.getApmDomains
Explore with Pulumi AI
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,
});
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)
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
	})
}
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,
    });
});
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());
    }
}
variables:
  testApmDomains:
    fn::invoke:
      function: oci:Apm:getApmDomains
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${apmDomainDisplayName}
        state: ${apmDomainState}
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>def get_apm_domains(compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    filters: Optional[Sequence[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[GetApmDomainsFilterArgs]]]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApmDomainsResult]func GetApmDomains(ctx *Context, args *GetApmDomainsArgs, opts ...InvokeOption) (*GetApmDomainsResult, error)
func GetApmDomainsOutput(ctx *Context, args *GetApmDomainsOutputArgs, opts ...InvokeOption) GetApmDomainsResultOutput> 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)
}public static CompletableFuture<GetApmDomainsResult> getApmDomains(GetApmDomainsArgs args, InvokeOptions options)
public static Output<GetApmDomainsResult> getApmDomains(GetApmDomainsArgs args, InvokeOptions options)
fn::invoke:
  function: oci:Apm/getApmDomains:getApmDomains
  arguments:
    # arguments dictionaryThe following arguments are supported:
- CompartmentId 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
List<GetApm Domains Filter> 
- State string
- A filter to return only resources that match the given life-cycle state.
- CompartmentId 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
[]GetApm Domains Filter 
- State string
- A filter to return only resources that match the given life-cycle state.
- compartmentId 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
List<GetDomains Filter> 
- state String
- A filter to return only resources that match the given life-cycle state.
- compartmentId 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
GetApm Domains Filter[] 
- state string
- A filter to return only resources that match the given life-cycle state.
- compartment_id 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
Sequence[GetApm Domains Filter] 
- state str
- A filter to return only resources that match the given life-cycle state.
- compartmentId 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 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<GetApm Domains Apm Domain> 
- 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<GetApm Domains Filter> 
- State string
- The current lifecycle state of the APM domain.
- ApmDomains []GetApm Domains Apm Domain 
- 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
[]GetApm Domains Filter 
- State string
- The current lifecycle state of the APM domain.
- apmDomains List<GetDomains Domain> 
- 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<GetDomains Filter> 
- state String
- The current lifecycle state of the APM domain.
- apmDomains GetApm Domains Apm Domain[] 
- 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
GetApm Domains Filter[] 
- state string
- The current lifecycle state of the APM domain.
- apm_domains Sequence[GetApm Domains Apm Domain] 
- 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[GetApm Domains Filter] 
- 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 string
- The ID of the compartment in which to list resources.
- DataUpload stringEndpoint 
- The endpoint where the APM agents upload their observations and metrics.
- 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
- Description of the APM domain.
- DisplayName string
- A filter to return only resources that match the entire display name given.
- 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 is immutable on creation.
- IsFree boolTier 
- Indicates if this is an Always Free resource.
- State string
- A filter to return only resources that match the given life-cycle state.
- TimeCreated string
- The time the APM domain was created, expressed in RFC 3339 timestamp format.
- TimeUpdated string
- The time the APM domain was updated, expressed in RFC 3339 timestamp format.
- CompartmentId string
- The ID of the compartment in which to list resources.
- DataUpload stringEndpoint 
- The endpoint where the APM agents upload their observations and metrics.
- 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
- Description of the APM domain.
- DisplayName string
- A filter to return only resources that match the entire display name given.
- 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 is immutable on creation.
- IsFree boolTier 
- Indicates if this is an Always Free resource.
- State string
- A filter to return only resources that match the given life-cycle state.
- TimeCreated string
- The time the APM domain was created, expressed in RFC 3339 timestamp format.
- TimeUpdated string
- The time the APM domain was updated, expressed in RFC 3339 timestamp format.
- compartmentId String
- The ID of the compartment in which to list resources.
- dataUpload StringEndpoint 
- The endpoint where the APM agents upload their observations and metrics.
- 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
- Description of the APM domain.
- displayName String
- A filter to return only resources that match the entire display name given.
- 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 is immutable on creation.
- isFree BooleanTier 
- Indicates if this is an Always Free resource.
- state String
- A filter to return only resources that match the given life-cycle state.
- timeCreated String
- The time the APM domain was created, expressed in RFC 3339 timestamp format.
- timeUpdated String
- The time the APM domain was updated, expressed in RFC 3339 timestamp format.
- compartmentId string
- The ID of the compartment in which to list resources.
- dataUpload stringEndpoint 
- The endpoint where the APM agents upload their observations and metrics.
- {[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
- Description of the APM domain.
- displayName string
- A filter to return only resources that match the entire display name given.
- {[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 is immutable on creation.
- isFree booleanTier 
- Indicates if this is an Always Free resource.
- state string
- A filter to return only resources that match the given life-cycle state.
- timeCreated string
- The time the APM domain was created, expressed in RFC 3339 timestamp format.
- timeUpdated string
- The time the APM domain was updated, expressed in RFC 3339 timestamp format.
- compartment_id str
- The ID of the compartment in which to list resources.
- data_upload_ strendpoint 
- The endpoint where the APM agents upload their observations and metrics.
- 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
- Description of the APM domain.
- display_name str
- A filter to return only resources that match the entire display name given.
- 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 is immutable on creation.
- is_free_ booltier 
- Indicates if this is an Always Free resource.
- state str
- A filter to return only resources that match the given life-cycle state.
- time_created str
- The time the APM domain was created, expressed in RFC 3339 timestamp format.
- time_updated str
- The time the APM domain was updated, expressed in RFC 3339 timestamp format.
- compartmentId String
- The ID of the compartment in which to list resources.
- dataUpload StringEndpoint 
- The endpoint where the APM agents upload their observations and metrics.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- Description of the APM domain.
- displayName String
- A filter to return only resources that match the entire display name given.
- 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 is immutable on creation.
- isFree BooleanTier 
- Indicates if this is an Always Free resource.
- state String
- A filter to return only resources that match the given life-cycle state.
- timeCreated String
- The time the APM domain was created, expressed in RFC 3339 timestamp format.
- timeUpdated String
- The time the APM domain was updated, expressed in RFC 3339 timestamp format.
GetApmDomainsFilter   
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.