1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CapacityManagement
  5. getNamespaceOccOverviews
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.CapacityManagement.getNamespaceOccOverviews

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

    This data source provides the list of Namespace Occ Overviews in Oracle Cloud Infrastructure Capacity Management service.

    Lists an overview of all resources in that namespace in a given time interval.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testNamespaceOccOverviews = oci.CapacityManagement.getNamespaceOccOverviews({
        compartmentId: compartmentId,
        namespace: namespaceOccOverviewNamespace,
        from: namespaceOccOverviewFrom,
        to: namespaceOccOverviewTo,
        workloadType: namespaceOccOverviewWorkloadType,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_namespace_occ_overviews = oci.CapacityManagement.get_namespace_occ_overviews(compartment_id=compartment_id,
        namespace=namespace_occ_overview_namespace,
        from_=namespace_occ_overview_from,
        to=namespace_occ_overview_to,
        workload_type=namespace_occ_overview_workload_type)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/CapacityManagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := CapacityManagement.GetNamespaceOccOverviews(ctx, &capacitymanagement.GetNamespaceOccOverviewsArgs{
    			CompartmentId: compartmentId,
    			Namespace:     namespaceOccOverviewNamespace,
    			From:          pulumi.StringRef(namespaceOccOverviewFrom),
    			To:            pulumi.StringRef(namespaceOccOverviewTo),
    			WorkloadType:  pulumi.StringRef(namespaceOccOverviewWorkloadType),
    		}, 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 testNamespaceOccOverviews = Oci.CapacityManagement.GetNamespaceOccOverviews.Invoke(new()
        {
            CompartmentId = compartmentId,
            Namespace = namespaceOccOverviewNamespace,
            From = namespaceOccOverviewFrom,
            To = namespaceOccOverviewTo,
            WorkloadType = namespaceOccOverviewWorkloadType,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.CapacityManagement.CapacityManagementFunctions;
    import com.pulumi.oci.CapacityManagement.inputs.GetNamespaceOccOverviewsArgs;
    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 testNamespaceOccOverviews = CapacityManagementFunctions.getNamespaceOccOverviews(GetNamespaceOccOverviewsArgs.builder()
                .compartmentId(compartmentId)
                .namespace(namespaceOccOverviewNamespace)
                .from(namespaceOccOverviewFrom)
                .to(namespaceOccOverviewTo)
                .workloadType(namespaceOccOverviewWorkloadType)
                .build());
    
        }
    }
    
    variables:
      testNamespaceOccOverviews:
        fn::invoke:
          Function: oci:CapacityManagement:getNamespaceOccOverviews
          Arguments:
            compartmentId: ${compartmentId}
            namespace: ${namespaceOccOverviewNamespace}
            from: ${namespaceOccOverviewFrom}
            to: ${namespaceOccOverviewTo}
            workloadType: ${namespaceOccOverviewWorkloadType}
    

    Using getNamespaceOccOverviews

    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 getNamespaceOccOverviews(args: GetNamespaceOccOverviewsArgs, opts?: InvokeOptions): Promise<GetNamespaceOccOverviewsResult>
    function getNamespaceOccOverviewsOutput(args: GetNamespaceOccOverviewsOutputArgs, opts?: InvokeOptions): Output<GetNamespaceOccOverviewsResult>
    def get_namespace_occ_overviews(compartment_id: Optional[str] = None,
                                    filters: Optional[Sequence[_capacitymanagement.GetNamespaceOccOverviewsFilter]] = None,
                                    from_: Optional[str] = None,
                                    namespace: Optional[str] = None,
                                    to: Optional[str] = None,
                                    workload_type: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetNamespaceOccOverviewsResult
    def get_namespace_occ_overviews_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_capacitymanagement.GetNamespaceOccOverviewsFilterArgs]]]] = None,
                                    from_: Optional[pulumi.Input[str]] = None,
                                    namespace: Optional[pulumi.Input[str]] = None,
                                    to: Optional[pulumi.Input[str]] = None,
                                    workload_type: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetNamespaceOccOverviewsResult]
    func GetNamespaceOccOverviews(ctx *Context, args *GetNamespaceOccOverviewsArgs, opts ...InvokeOption) (*GetNamespaceOccOverviewsResult, error)
    func GetNamespaceOccOverviewsOutput(ctx *Context, args *GetNamespaceOccOverviewsOutputArgs, opts ...InvokeOption) GetNamespaceOccOverviewsResultOutput

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

    public static class GetNamespaceOccOverviews 
    {
        public static Task<GetNamespaceOccOverviewsResult> InvokeAsync(GetNamespaceOccOverviewsArgs args, InvokeOptions? opts = null)
        public static Output<GetNamespaceOccOverviewsResult> Invoke(GetNamespaceOccOverviewsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNamespaceOccOverviewsResult> getNamespaceOccOverviews(GetNamespaceOccOverviewsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:CapacityManagement/getNamespaceOccOverviews:getNamespaceOccOverviews
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    Namespace string
    The namespace by which we would filter the list.
    Filters List<GetNamespaceOccOverviewsFilter>
    From string
    The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation.
    To string
    The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation.
    WorkloadType string
    Workload type using the resources in an availability catalog can be filtered.
    CompartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    Namespace string
    The namespace by which we would filter the list.
    Filters []GetNamespaceOccOverviewsFilter
    From string
    The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation.
    To string
    The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation.
    WorkloadType string
    Workload type using the resources in an availability catalog can be filtered.
    compartmentId String
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    namespace String
    The namespace by which we would filter the list.
    filters List<GetNamespaceOccOverviewsFilter>
    from String
    The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation.
    to String
    The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation.
    workloadType String
    Workload type using the resources in an availability catalog can be filtered.
    compartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    namespace string
    The namespace by which we would filter the list.
    filters GetNamespaceOccOverviewsFilter[]
    from string
    The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation.
    to string
    The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation.
    workloadType string
    Workload type using the resources in an availability catalog can be filtered.
    compartment_id str
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    namespace str
    The namespace by which we would filter the list.
    filters Sequence[capacitymanagement.GetNamespaceOccOverviewsFilter]
    from_ str
    The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation.
    to str
    The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation.
    workload_type str
    Workload type using the resources in an availability catalog can be filtered.
    compartmentId String
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    namespace String
    The namespace by which we would filter the list.
    filters List<Property Map>
    from String
    The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation.
    to String
    The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation.
    workloadType String
    Workload type using the resources in an availability catalog can be filtered.

    getNamespaceOccOverviews Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment from which the api call is made. This will be used for authorizing the request.
    Id string
    The provider-assigned unique ID for this managed resource.
    Namespace string
    OccOverviewCollections List<GetNamespaceOccOverviewsOccOverviewCollection>
    The list of occ_overview_collection.
    Filters List<GetNamespaceOccOverviewsFilter>
    From string
    To string
    WorkloadType string
    CompartmentId string
    The OCID of the compartment from which the api call is made. This will be used for authorizing the request.
    Id string
    The provider-assigned unique ID for this managed resource.
    Namespace string
    OccOverviewCollections []GetNamespaceOccOverviewsOccOverviewCollection
    The list of occ_overview_collection.
    Filters []GetNamespaceOccOverviewsFilter
    From string
    To string
    WorkloadType string
    compartmentId String
    The OCID of the compartment from which the api call is made. This will be used for authorizing the request.
    id String
    The provider-assigned unique ID for this managed resource.
    namespace String
    occOverviewCollections List<GetNamespaceOccOverviewsOccOverviewCollection>
    The list of occ_overview_collection.
    filters List<GetNamespaceOccOverviewsFilter>
    from String
    to String
    workloadType String
    compartmentId string
    The OCID of the compartment from which the api call is made. This will be used for authorizing the request.
    id string
    The provider-assigned unique ID for this managed resource.
    namespace string
    occOverviewCollections GetNamespaceOccOverviewsOccOverviewCollection[]
    The list of occ_overview_collection.
    filters GetNamespaceOccOverviewsFilter[]
    from string
    to string
    workloadType string
    compartment_id str
    The OCID of the compartment from which the api call is made. This will be used for authorizing the request.
    id str
    The provider-assigned unique ID for this managed resource.
    namespace str
    occ_overview_collections Sequence[capacitymanagement.GetNamespaceOccOverviewsOccOverviewCollection]
    The list of occ_overview_collection.
    filters Sequence[capacitymanagement.GetNamespaceOccOverviewsFilter]
    from_ str
    to str
    workload_type str
    compartmentId String
    The OCID of the compartment from which the api call is made. This will be used for authorizing the request.
    id String
    The provider-assigned unique ID for this managed resource.
    namespace String
    occOverviewCollections List<Property Map>
    The list of occ_overview_collection.
    filters List<Property Map>
    from String
    to String
    workloadType String

    Supporting Types

    GetNamespaceOccOverviewsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetNamespaceOccOverviewsOccOverviewCollection

    items List<Property Map>
    An array of overview summary.

    GetNamespaceOccOverviewsOccOverviewCollectionItem

    CapacityRequestsBlob string
    A raw json blob containing all the capacity requests corresponding to the resource name
    CompartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    PeriodValue string
    The name of the month along with year for which this summary corresponds to.
    ResourceName string
    The name of the resource for which we have aggregated the value.
    TotalAvailable string
    The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.
    TotalCancelled string
    The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.
    TotalDemanded string
    The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.
    TotalRejected string
    The quantity of the resource which is rejected by Oracle.
    TotalSupplied string
    The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.
    TotalUnfulfilled string
    The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.
    Unit string
    The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.
    WorkloadTypeBreakdownBlob string
    A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types
    CapacityRequestsBlob string
    A raw json blob containing all the capacity requests corresponding to the resource name
    CompartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    PeriodValue string
    The name of the month along with year for which this summary corresponds to.
    ResourceName string
    The name of the resource for which we have aggregated the value.
    TotalAvailable string
    The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.
    TotalCancelled string
    The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.
    TotalDemanded string
    The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.
    TotalRejected string
    The quantity of the resource which is rejected by Oracle.
    TotalSupplied string
    The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.
    TotalUnfulfilled string
    The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.
    Unit string
    The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.
    WorkloadTypeBreakdownBlob string
    A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types
    capacityRequestsBlob String
    A raw json blob containing all the capacity requests corresponding to the resource name
    compartmentId String
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    periodValue String
    The name of the month along with year for which this summary corresponds to.
    resourceName String
    The name of the resource for which we have aggregated the value.
    totalAvailable String
    The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.
    totalCancelled String
    The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.
    totalDemanded String
    The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.
    totalRejected String
    The quantity of the resource which is rejected by Oracle.
    totalSupplied String
    The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.
    totalUnfulfilled String
    The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.
    unit String
    The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.
    workloadTypeBreakdownBlob String
    A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types
    capacityRequestsBlob string
    A raw json blob containing all the capacity requests corresponding to the resource name
    compartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    periodValue string
    The name of the month along with year for which this summary corresponds to.
    resourceName string
    The name of the resource for which we have aggregated the value.
    totalAvailable string
    The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.
    totalCancelled string
    The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.
    totalDemanded string
    The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.
    totalRejected string
    The quantity of the resource which is rejected by Oracle.
    totalSupplied string
    The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.
    totalUnfulfilled string
    The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.
    unit string
    The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.
    workloadTypeBreakdownBlob string
    A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types
    capacity_requests_blob str
    A raw json blob containing all the capacity requests corresponding to the resource name
    compartment_id str
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    period_value str
    The name of the month along with year for which this summary corresponds to.
    resource_name str
    The name of the resource for which we have aggregated the value.
    total_available str
    The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.
    total_cancelled str
    The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.
    total_demanded str
    The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.
    total_rejected str
    The quantity of the resource which is rejected by Oracle.
    total_supplied str
    The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.
    total_unfulfilled str
    The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.
    unit str
    The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.
    workload_type_breakdown_blob str
    A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types
    capacityRequestsBlob String
    A raw json blob containing all the capacity requests corresponding to the resource name
    compartmentId String
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    periodValue String
    The name of the month along with year for which this summary corresponds to.
    resourceName String
    The name of the resource for which we have aggregated the value.
    totalAvailable String
    The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.
    totalCancelled String
    The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.
    totalDemanded String
    The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.
    totalRejected String
    The quantity of the resource which is rejected by Oracle.
    totalSupplied String
    The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.
    totalUnfulfilled String
    The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.
    unit String
    The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.
    workloadTypeBreakdownBlob String
    A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi