Oracle Cloud Infrastructure
getCategories
This data source provides the list of Categories in Oracle Cloud Infrastructure Optimizer service.
Lists the supported Cloud Advisor categories.
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testCategories = Output.Create(Oci.Optimizer.GetCategories.InvokeAsync(new Oci.Optimizer.GetCategoriesArgs
{
CompartmentId = @var.Compartment_id,
CompartmentIdInSubtree = @var.Category_compartment_id_in_subtree,
Name = @var.Category_name,
State = @var.Category_state,
}));
}
}
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Optimizer"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Optimizer.GetCategories(ctx, &optimizer.GetCategoriesArgs{
CompartmentId: _var.Compartment_id,
CompartmentIdInSubtree: _var.Category_compartment_id_in_subtree,
Name: pulumi.StringRef(_var.Category_name),
State: pulumi.StringRef(_var.Category_state),
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_categories = oci.Optimizer.get_categories(compartment_id=var["compartment_id"],
compartment_id_in_subtree=var["category_compartment_id_in_subtree"],
name=var["category_name"],
state=var["category_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testCategories = oci.Optimizer.getCategories({
compartmentId: _var.compartment_id,
compartmentIdInSubtree: _var.category_compartment_id_in_subtree,
name: _var.category_name,
state: _var.category_state,
});
Coming soon!
Using getCategories
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 getCategories(args: GetCategoriesArgs, opts?: InvokeOptions): Promise<GetCategoriesResult>
function getCategoriesOutput(args: GetCategoriesOutputArgs, opts?: InvokeOptions): Output<GetCategoriesResult>
def get_categories(compartment_id: Optional[str] = None,
compartment_id_in_subtree: Optional[bool] = None,
filters: Optional[Sequence[_optimizer.GetCategoriesFilter]] = None,
name: Optional[str] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCategoriesResult
def get_categories_output(compartment_id: Optional[pulumi.Input[str]] = None,
compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_optimizer.GetCategoriesFilterArgs]]]] = None,
name: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCategoriesResult]
func GetCategories(ctx *Context, args *GetCategoriesArgs, opts ...InvokeOption) (*GetCategoriesResult, error)
func GetCategoriesOutput(ctx *Context, args *GetCategoriesOutputArgs, opts ...InvokeOption) GetCategoriesResultOutput
> Note: This function is named GetCategories
in the Go SDK.
public static class GetCategories
{
public static Task<GetCategoriesResult> InvokeAsync(GetCategoriesArgs args, InvokeOptions? opts = null)
public static Output<GetCategoriesResult> Invoke(GetCategoriesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCategoriesResult> getCategories(GetCategoriesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: oci:Optimizer/getCategories:getCategories
Arguments:
# Arguments dictionary
The following arguments are supported:
- Compartment
Id string The OCID of the compartment.
- Compartment
Id boolIn Subtree When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of
accessLevel
.- Filters
List<Get
Categories 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.
- Compartment
Id boolIn Subtree When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of
accessLevel
.- Filters
[]Get
Categories 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.
- compartment
Id BooleanIn Subtree When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of
accessLevel
.- filters
List<Get
Categories 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.
- compartment
Id booleanIn Subtree When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of
accessLevel
.- filters
Get
Categories 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.
- compartment_
id_ boolin_ subtree When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of
accessLevel
.- filters
Get
Categories 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.
- compartment
Id BooleanIn Subtree When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of
accessLevel
.- 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.
getCategories Result
The following output properties are available:
- Category
Collections List<GetCategories Category Collection> The list of category_collection.
- Compartment
Id string The OCID of the tenancy. The tenancy is the root compartment.
- Compartment
Id boolIn Subtree - Id string
The provider-assigned unique ID for this managed resource.
- Filters
List<Get
Categories Filter> - Name string
The name assigned to the category.
- State string
The category's current state.
- Category
Collections []GetCategories Category Collection The list of category_collection.
- Compartment
Id string The OCID of the tenancy. The tenancy is the root compartment.
- Compartment
Id boolIn Subtree - Id string
The provider-assigned unique ID for this managed resource.
- Filters
[]Get
Categories Filter - Name string
The name assigned to the category.
- State string
The category's current state.
- category
Collections List<GetCategories Category Collection> The list of category_collection.
- compartment
Id String The OCID of the tenancy. The tenancy is the root compartment.
- compartment
Id BooleanIn Subtree - id String
The provider-assigned unique ID for this managed resource.
- filters
List<Get
Categories Filter> - name String
The name assigned to the category.
- state String
The category's current state.
- category
Collections GetCategories Category Collection[] The list of category_collection.
- compartment
Id string The OCID of the tenancy. The tenancy is the root compartment.
- compartment
Id booleanIn Subtree - id string
The provider-assigned unique ID for this managed resource.
- filters
Get
Categories Filter[] - name string
The name assigned to the category.
- state string
The category's current state.
- category_
collections GetCategories Category Collection] The list of category_collection.
- compartment_
id str The OCID of the tenancy. The tenancy is the root compartment.
- compartment_
id_ boolin_ subtree - id str
The provider-assigned unique ID for this managed resource.
- filters
Get
Categories Filter] - name str
The name assigned to the category.
- state str
The category's current state.
- category
Collections List<Property Map> The list of category_collection.
- compartment
Id String The OCID of the tenancy. The tenancy is the root compartment.
- compartment
Id BooleanIn Subtree - id String
The provider-assigned unique ID for this managed resource.
- filters List<Property Map>
- name String
The name assigned to the category.
- state String
The category's current state.
Supporting Types
GetCategoriesCategoryCollection
GetCategoriesCategoryCollectionItem
- Compartment
Id string The OCID of the compartment.
- Description string
Text describing the category.
- Estimated
Cost doubleSaving The estimated cost savings, in dollars, for the category.
- Extended
Metadata Dictionary<string, object> Additional metadata key/value pairs for the category.
- Id string
The unique OCID of the category.
- Name string
Optional. A filter that returns results that match the name specified.
- Recommendation
Counts List<GetCategories Category Collection Item Recommendation Count> An array of
RecommendationCount
objects grouped by the level of importance assigned to the recommendation.- Resource
Counts List<GetCategories Category Collection Item Resource Count> An array of
ResourceCount
objects grouped by the status of the recommendation.- State string
A filter that returns results that match the lifecycle state specified.
- Time
Created string The date and time the category details were created, in the format defined by RFC3339.
- Time
Updated string The date and time the category details were last updated, in the format defined by RFC3339.
- Compartment
Id string The OCID of the compartment.
- Description string
Text describing the category.
- Estimated
Cost float64Saving The estimated cost savings, in dollars, for the category.
- Extended
Metadata map[string]interface{} Additional metadata key/value pairs for the category.
- Id string
The unique OCID of the category.
- Name string
Optional. A filter that returns results that match the name specified.
- Recommendation
Counts []GetCategories Category Collection Item Recommendation Count An array of
RecommendationCount
objects grouped by the level of importance assigned to the recommendation.- Resource
Counts []GetCategories Category Collection Item Resource Count An array of
ResourceCount
objects grouped by the status of the recommendation.- State string
A filter that returns results that match the lifecycle state specified.
- Time
Created string The date and time the category details were created, in the format defined by RFC3339.
- Time
Updated string The date and time the category details were last updated, in the format defined by RFC3339.
- compartment
Id String The OCID of the compartment.
- description String
Text describing the category.
- estimated
Cost DoubleSaving The estimated cost savings, in dollars, for the category.
- extended
Metadata Map<String,Object> Additional metadata key/value pairs for the category.
- id String
The unique OCID of the category.
- name String
Optional. A filter that returns results that match the name specified.
- recommendation
Counts List<GetCategories Category Collection Item Recommendation Count> An array of
RecommendationCount
objects grouped by the level of importance assigned to the recommendation.- resource
Counts List<GetCategories Category Collection Item Resource Count> An array of
ResourceCount
objects grouped by the status of the recommendation.- state String
A filter that returns results that match the lifecycle state specified.
- time
Created String The date and time the category details were created, in the format defined by RFC3339.
- time
Updated String The date and time the category details were last updated, in the format defined by RFC3339.
- compartment
Id string The OCID of the compartment.
- description string
Text describing the category.
- estimated
Cost numberSaving The estimated cost savings, in dollars, for the category.
- extended
Metadata {[key: string]: any} Additional metadata key/value pairs for the category.
- id string
The unique OCID of the category.
- name string
Optional. A filter that returns results that match the name specified.
- recommendation
Counts GetCategories Category Collection Item Recommendation Count[] An array of
RecommendationCount
objects grouped by the level of importance assigned to the recommendation.- resource
Counts GetCategories Category Collection Item Resource Count[] An array of
ResourceCount
objects grouped by the status of the recommendation.- state string
A filter that returns results that match the lifecycle state specified.
- time
Created string The date and time the category details were created, in the format defined by RFC3339.
- time
Updated string The date and time the category details were last updated, in the format defined by RFC3339.
- compartment_
id str The OCID of the compartment.
- description str
Text describing the category.
- estimated_
cost_ floatsaving The estimated cost savings, in dollars, for the category.
- extended_
metadata Mapping[str, Any] Additional metadata key/value pairs for the category.
- id str
The unique OCID of the category.
- name str
Optional. A filter that returns results that match the name specified.
- recommendation_
counts GetCategories Category Collection Item Recommendation Count] An array of
RecommendationCount
objects grouped by the level of importance assigned to the recommendation.- resource_
counts GetCategories Category Collection Item Resource Count] An array of
ResourceCount
objects grouped by the status of the recommendation.- state str
A filter that returns results that match the lifecycle state specified.
- time_
created str The date and time the category details were created, in the format defined by RFC3339.
- time_
updated str The date and time the category details were last updated, in the format defined by RFC3339.
- compartment
Id String The OCID of the compartment.
- description String
Text describing the category.
- estimated
Cost NumberSaving The estimated cost savings, in dollars, for the category.
- extended
Metadata Map<Any> Additional metadata key/value pairs for the category.
- id String
The unique OCID of the category.
- name String
Optional. A filter that returns results that match the name specified.
- recommendation
Counts List<Property Map> An array of
RecommendationCount
objects grouped by the level of importance assigned to the recommendation.- resource
Counts List<Property Map> An array of
ResourceCount
objects grouped by the status of the recommendation.- state String
A filter that returns results that match the lifecycle state specified.
- time
Created String The date and time the category details were created, in the format defined by RFC3339.
- time
Updated String The date and time the category details were last updated, in the format defined by RFC3339.
GetCategoriesCategoryCollectionItemRecommendationCount
- Count int
The count of resources.
- Importance string
The level of importance assigned to the recommendation.
- Count int
The count of resources.
- Importance string
The level of importance assigned to the recommendation.
- count Integer
The count of resources.
- importance String
The level of importance assigned to the recommendation.
- count number
The count of resources.
- importance string
The level of importance assigned to the recommendation.
- count int
The count of resources.
- importance str
The level of importance assigned to the recommendation.
- count Number
The count of resources.
- importance String
The level of importance assigned to the recommendation.
GetCategoriesCategoryCollectionItemResourceCount
GetCategoriesFilter
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.