Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
oci.Optimizer.getProfiles
Start a Neo task
Explain and create an oci.Optimizer.getProfiles resource
This data source provides the list of Profiles in Oracle Cloud Infrastructure Optimizer service.
Lists the existing profiles.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testProfiles = oci.Optimizer.getProfiles({
compartmentId: compartmentId,
name: profileName,
state: profileState,
});
import pulumi
import pulumi_oci as oci
test_profiles = oci.Optimizer.get_profiles(compartment_id=compartment_id,
name=profile_name,
state=profile_state)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/optimizer"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := optimizer.GetProfiles(ctx, &optimizer.GetProfilesArgs{
CompartmentId: compartmentId,
Name: pulumi.StringRef(profileName),
State: pulumi.StringRef(profileState),
}, 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 testProfiles = Oci.Optimizer.GetProfiles.Invoke(new()
{
CompartmentId = compartmentId,
Name = profileName,
State = profileState,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Optimizer.OptimizerFunctions;
import com.pulumi.oci.Optimizer.inputs.GetProfilesArgs;
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 testProfiles = OptimizerFunctions.getProfiles(GetProfilesArgs.builder()
.compartmentId(compartmentId)
.name(profileName)
.state(profileState)
.build());
}
}
variables:
testProfiles:
fn::invoke:
function: oci:Optimizer:getProfiles
arguments:
compartmentId: ${compartmentId}
name: ${profileName}
state: ${profileState}
Using getProfiles
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 getProfiles(args: GetProfilesArgs, opts?: InvokeOptions): Promise<GetProfilesResult>
function getProfilesOutput(args: GetProfilesOutputArgs, opts?: InvokeOptions): Output<GetProfilesResult>def get_profiles(compartment_id: Optional[str] = None,
filters: Optional[Sequence[GetProfilesFilter]] = None,
name: Optional[str] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetProfilesResult
def get_profiles_output(compartment_id: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetProfilesFilterArgs]]]] = None,
name: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetProfilesResult]func GetProfiles(ctx *Context, args *GetProfilesArgs, opts ...InvokeOption) (*GetProfilesResult, error)
func GetProfilesOutput(ctx *Context, args *GetProfilesOutputArgs, opts ...InvokeOption) GetProfilesResultOutput> Note: This function is named GetProfiles in the Go SDK.
public static class GetProfiles
{
public static Task<GetProfilesResult> InvokeAsync(GetProfilesArgs args, InvokeOptions? opts = null)
public static Output<GetProfilesResult> Invoke(GetProfilesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetProfilesResult> getProfiles(GetProfilesArgs args, InvokeOptions options)
public static Output<GetProfilesResult> getProfiles(GetProfilesArgs args, InvokeOptions options)
fn::invoke:
function: oci:Optimizer/getProfiles:getProfiles
arguments:
# arguments dictionaryThe following arguments are supported:
- Compartment
Id string - The OCID of the compartment.
- Filters
List<Get
Profiles Filter> - Name string
- Optional. A filter that returns results that match the name specified.
- State string
- A filter that returns results that match the lifecycle state specified.
- Compartment
Id string - The OCID of the compartment.
- Filters
[]Get
Profiles Filter - Name string
- Optional. A filter that returns results that match the name specified.
- State string
- A filter that returns results that match the lifecycle state specified.
- compartment
Id String - The OCID of the compartment.
- filters
List<Get
Profiles Filter> - name String
- Optional. A filter that returns results that match the name specified.
- state String
- A filter that returns results that match the lifecycle state specified.
- compartment
Id string - The OCID of the compartment.
- filters
Get
Profiles Filter[] - name string
- Optional. A filter that returns results that match the name specified.
- state string
- A filter that returns results that match the lifecycle state specified.
- compartment_
id str - The OCID of the compartment.
- filters
Sequence[Get
Profiles Filter] - name str
- Optional. A filter that returns results that match the name specified.
- state str
- A filter that returns results that match the lifecycle state specified.
- compartment
Id String - The OCID of the compartment.
- filters List<Property Map>
- name String
- Optional. A filter that returns results that match the name specified.
- state String
- A filter that returns results that match the lifecycle state specified.
getProfiles Result
The following output properties are available:
- Compartment
Id string - The OCID of the tenancy. The tenancy is the root compartment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Profile
Collections List<GetProfiles Profile Collection> - The list of profile_collection.
- Filters
List<Get
Profiles Filter> - Name string
- The name assigned to the profile. Avoid entering confidential information.
- State string
- The profile's current state.
- Compartment
Id string - The OCID of the tenancy. The tenancy is the root compartment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Profile
Collections []GetProfiles Profile Collection - The list of profile_collection.
- Filters
[]Get
Profiles Filter - Name string
- The name assigned to the profile. Avoid entering confidential information.
- State string
- The profile's current state.
- compartment
Id String - The OCID of the tenancy. The tenancy is the root compartment.
- id String
- The provider-assigned unique ID for this managed resource.
- profile
Collections List<GetProfiles Profile Collection> - The list of profile_collection.
- filters
List<Get
Profiles Filter> - name String
- The name assigned to the profile. Avoid entering confidential information.
- state String
- The profile's current state.
- compartment
Id string - The OCID of the tenancy. The tenancy is the root compartment.
- id string
- The provider-assigned unique ID for this managed resource.
- profile
Collections GetProfiles Profile Collection[] - The list of profile_collection.
- filters
Get
Profiles Filter[] - name string
- The name assigned to the profile. Avoid entering confidential information.
- state string
- The profile's current state.
- compartment_
id str - The OCID of the tenancy. The tenancy is the root compartment.
- id str
- The provider-assigned unique ID for this managed resource.
- profile_
collections Sequence[GetProfiles Profile Collection] - The list of profile_collection.
- filters
Sequence[Get
Profiles Filter] - name str
- The name assigned to the profile. Avoid entering confidential information.
- state str
- The profile's current state.
- compartment
Id String - The OCID of the tenancy. The tenancy is the root compartment.
- id String
- The provider-assigned unique ID for this managed resource.
- profile
Collections List<Property Map> - The list of profile_collection.
- filters List<Property Map>
- name String
- The name assigned to the profile. Avoid entering confidential information.
- state String
- The profile's current state.
Supporting Types
GetProfilesFilter
GetProfilesProfileCollection
- Items
List<Get
Profiles Profile Collection Item> - The list of tags specified in the current profile override.
- Items
[]Get
Profiles Profile Collection Item - The list of tags specified in the current profile override.
- items
List<Get
Profiles Profile Collection Item> - The list of tags specified in the current profile override.
- items
Get
Profiles Profile Collection Item[] - The list of tags specified in the current profile override.
- items
Sequence[Get
Profiles Profile Collection Item] - The list of tags specified in the current profile override.
- items List<Property Map>
- The list of tags specified in the current profile override.
GetProfilesProfileCollectionItem
- Aggregation
Interval intIn Days - The time period over which to collect data for the recommendations, measured in number of days.
- Compartment
Id string - The OCID of the compartment.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"foo-namespace.bar-key": "value"} - Description string
- Text describing the profile. Avoid entering confidential information.
- Dictionary<string, string>
- Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - Id string
- The unique OCID of the profile.
- Levels
Configurations List<GetProfiles Profile Collection Item Levels Configuration> - A list of configuration levels for each recommendation.
- Name string
- Optional. A filter that returns results that match the name specified.
- State string
- A filter that returns results that match the lifecycle state specified.
- Dictionary<string, string>
- Target
Compartments List<GetProfiles Profile Collection Item Target Compartment> - Optional. The compartments specified in the profile override for a recommendation.
-
List<Get
Profiles Profile Collection Item Target Tag> - Optional. The tags specified in the profile override for a recommendation.
- Time
Created string - The date and time the profile was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the profile was last updated, in the format defined by RFC3339.
- Aggregation
Interval intIn Days - The time period over which to collect data for the recommendations, measured in number of days.
- Compartment
Id string - The OCID of the compartment.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"foo-namespace.bar-key": "value"} - Description string
- Text describing the profile. Avoid entering confidential information.
- map[string]string
- Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - Id string
- The unique OCID of the profile.
- Levels
Configurations []GetProfiles Profile Collection Item Levels Configuration - A list of configuration levels for each recommendation.
- Name string
- Optional. A filter that returns results that match the name specified.
- State string
- A filter that returns results that match the lifecycle state specified.
- map[string]string
- Target
Compartments []GetProfiles Profile Collection Item Target Compartment - Optional. The compartments specified in the profile override for a recommendation.
-
[]Get
Profiles Profile Collection Item Target Tag - Optional. The tags specified in the profile override for a recommendation.
- Time
Created string - The date and time the profile was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the profile was last updated, in the format defined by RFC3339.
- aggregation
Interval IntegerIn Days - The time period over which to collect data for the recommendations, measured in number of days.
- compartment
Id String - The OCID of the compartment.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"foo-namespace.bar-key": "value"} - description String
- Text describing the profile. Avoid entering confidential information.
- Map<String,String>
- Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - id String
- The unique OCID of the profile.
- levels
Configurations List<GetProfiles Profile Collection Item Levels Configuration> - A list of configuration levels for each recommendation.
- name String
- Optional. A filter that returns results that match the name specified.
- state String
- A filter that returns results that match the lifecycle state specified.
- Map<String,String>
- target
Compartments List<GetProfiles Profile Collection Item Target Compartment> - Optional. The compartments specified in the profile override for a recommendation.
-
List<Get
Profiles Profile Collection Item Target Tag> - Optional. The tags specified in the profile override for a recommendation.
- time
Created String - The date and time the profile was created, in the format defined by RFC3339.
- time
Updated String - The date and time the profile was last updated, in the format defined by RFC3339.
- aggregation
Interval numberIn Days - The time period over which to collect data for the recommendations, measured in number of days.
- compartment
Id string - The OCID of the compartment.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"foo-namespace.bar-key": "value"} - description string
- Text describing the profile. Avoid entering confidential information.
- {[key: string]: string}
- Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - id string
- The unique OCID of the profile.
- levels
Configurations GetProfiles Profile Collection Item Levels Configuration[] - A list of configuration levels for each recommendation.
- name string
- Optional. A filter that returns results that match the name specified.
- state string
- A filter that returns results that match the lifecycle state specified.
- {[key: string]: string}
- target
Compartments GetProfiles Profile Collection Item Target Compartment[] - Optional. The compartments specified in the profile override for a recommendation.
-
Get
Profiles Profile Collection Item Target Tag[] - Optional. The tags specified in the profile override for a recommendation.
- time
Created string - The date and time the profile was created, in the format defined by RFC3339.
- time
Updated string - The date and time the profile was last updated, in the format defined by RFC3339.
- aggregation_
interval_ intin_ days - The time period over which to collect data for the recommendations, measured in number of days.
- compartment_
id str - The OCID of the compartment.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"foo-namespace.bar-key": "value"} - description str
- Text describing the profile. Avoid entering confidential information.
- Mapping[str, str]
- Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - id str
- The unique OCID of the profile.
- levels_
configurations Sequence[GetProfiles Profile Collection Item Levels Configuration] - A list of configuration levels for each recommendation.
- name str
- Optional. A filter that returns results that match the name specified.
- state str
- A filter that returns results that match the lifecycle state specified.
- Mapping[str, str]
- target_
compartments Sequence[GetProfiles Profile Collection Item Target Compartment] - Optional. The compartments specified in the profile override for a recommendation.
-
Sequence[Get
Profiles Profile Collection Item Target Tag] - Optional. The tags specified in the profile override for a recommendation.
- time_
created str - The date and time the profile was created, in the format defined by RFC3339.
- time_
updated str - The date and time the profile was last updated, in the format defined by RFC3339.
- aggregation
Interval NumberIn Days - The time period over which to collect data for the recommendations, measured in number of days.
- compartment
Id String - The OCID of the compartment.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"foo-namespace.bar-key": "value"} - description String
- Text describing the profile. Avoid entering confidential information.
- Map<String>
- Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - id String
- The unique OCID of the profile.
- levels
Configurations List<Property Map> - A list of configuration levels for each recommendation.
- name String
- Optional. A filter that returns results that match the name specified.
- state String
- A filter that returns results that match the lifecycle state specified.
- Map<String>
- target
Compartments List<Property Map> - Optional. The compartments specified in the profile override for a recommendation.
- List<Property Map>
- Optional. The tags specified in the profile override for a recommendation.
- time
Created String - The date and time the profile was created, in the format defined by RFC3339.
- time
Updated String - The date and time the profile was last updated, in the format defined by RFC3339.
GetProfilesProfileCollectionItemLevelsConfiguration
- Items
List<Get
Profiles Profile Collection Item Levels Configuration Item> - The list of tags specified in the current profile override.
- Items
[]Get
Profiles Profile Collection Item Levels Configuration Item - The list of tags specified in the current profile override.
- items
List<Get
Profiles Profile Collection Item Levels Configuration Item> - The list of tags specified in the current profile override.
- items
Get
Profiles Profile Collection Item Levels Configuration Item[] - The list of tags specified in the current profile override.
- items
Sequence[Get
Profiles Profile Collection Item Levels Configuration Item] - The list of tags specified in the current profile override.
- items List<Property Map>
- The list of tags specified in the current profile override.
GetProfilesProfileCollectionItemLevelsConfigurationItem
- Level string
- The pre-defined profile level.
- Recommendation
Id string - The unique OCID of the recommendation.
- Level string
- The pre-defined profile level.
- Recommendation
Id string - The unique OCID of the recommendation.
- level String
- The pre-defined profile level.
- recommendation
Id String - The unique OCID of the recommendation.
- level string
- The pre-defined profile level.
- recommendation
Id string - The unique OCID of the recommendation.
- level str
- The pre-defined profile level.
- recommendation_
id str - The unique OCID of the recommendation.
- level String
- The pre-defined profile level.
- recommendation
Id String - The unique OCID of the recommendation.
GetProfilesProfileCollectionItemTargetCompartment
- Items List<string>
- The list of tags specified in the current profile override.
- Items []string
- The list of tags specified in the current profile override.
- items List<String>
- The list of tags specified in the current profile override.
- items string[]
- The list of tags specified in the current profile override.
- items Sequence[str]
- The list of tags specified in the current profile override.
- items List<String>
- The list of tags specified in the current profile override.
GetProfilesProfileCollectionItemTargetTag
- Items
List<Get
Profiles Profile Collection Item Target Tag Item> - The list of tags specified in the current profile override.
- Items
[]Get
Profiles Profile Collection Item Target Tag Item - The list of tags specified in the current profile override.
- items
List<Get
Profiles Profile Collection Item Target Tag Item> - The list of tags specified in the current profile override.
- items
Get
Profiles Profile Collection Item Target Tag Item[] - The list of tags specified in the current profile override.
- items
Sequence[Get
Profiles Profile Collection Item Target Tag Item] - The list of tags specified in the current profile override.
- items List<Property Map>
- The list of tags specified in the current profile override.
GetProfilesProfileCollectionItemTargetTagItem
- Tag
Definition stringName - The name you use to refer to the tag, also known as the tag key.
- Tag
Namespace stringName - The name of the tag namespace.
- Tag
Value stringType - Specifies which tag value types in the
tagValuesfield result in overrides of the recommendation criteria. - Tag
Values List<string> - The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
- Tag
Definition stringName - The name you use to refer to the tag, also known as the tag key.
- Tag
Namespace stringName - The name of the tag namespace.
- Tag
Value stringType - Specifies which tag value types in the
tagValuesfield result in overrides of the recommendation criteria. - Tag
Values []string - The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
- tag
Definition StringName - The name you use to refer to the tag, also known as the tag key.
- tag
Namespace StringName - The name of the tag namespace.
- tag
Value StringType - Specifies which tag value types in the
tagValuesfield result in overrides of the recommendation criteria. - tag
Values List<String> - The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
- tag
Definition stringName - The name you use to refer to the tag, also known as the tag key.
- tag
Namespace stringName - The name of the tag namespace.
- tag
Value stringType - Specifies which tag value types in the
tagValuesfield result in overrides of the recommendation criteria. - tag
Values string[] - The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
- tag_
definition_ strname - The name you use to refer to the tag, also known as the tag key.
- tag_
namespace_ strname - The name of the tag namespace.
- tag_
value_ strtype - Specifies which tag value types in the
tagValuesfield result in overrides of the recommendation criteria. - tag_
values Sequence[str] - The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
- tag
Definition StringName - The name you use to refer to the tag, also known as the tag key.
- tag
Namespace StringName - The name of the tag namespace.
- tag
Value StringType - Specifies which tag value types in the
tagValuesfield result in overrides of the recommendation criteria. - tag
Values List<String> - The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
