1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. UsageProxy
  5. getResourceQuotas
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.UsageProxy.getResourceQuotas

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides the list of Resource Quotas in Oracle Cloud Infrastructure Usage Proxy service.

Returns the resource quota details under a tenancy

Important: Calls to this API will only succeed against the endpoint in the home region.

Example Usage

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

const testResourceQuotas = oci.UsageProxy.getResourceQuotas({
    compartmentId: compartmentId,
    serviceName: testService.name,
    serviceEntitlement: resourceQuotaServiceEntitlement,
});
Copy
import pulumi
import pulumi_oci as oci

test_resource_quotas = oci.UsageProxy.get_resource_quotas(compartment_id=compartment_id,
    service_name=test_service["name"],
    service_entitlement=resource_quota_service_entitlement)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := usageproxy.GetResourceQuotas(ctx, &usageproxy.GetResourceQuotasArgs{
			CompartmentId:      compartmentId,
			ServiceName:        testService.Name,
			ServiceEntitlement: pulumi.StringRef(resourceQuotaServiceEntitlement),
		}, 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 testResourceQuotas = Oci.UsageProxy.GetResourceQuotas.Invoke(new()
    {
        CompartmentId = compartmentId,
        ServiceName = testService.Name,
        ServiceEntitlement = resourceQuotaServiceEntitlement,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.UsageProxy.UsageProxyFunctions;
import com.pulumi.oci.UsageProxy.inputs.GetResourceQuotasArgs;
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 testResourceQuotas = UsageProxyFunctions.getResourceQuotas(GetResourceQuotasArgs.builder()
            .compartmentId(compartmentId)
            .serviceName(testService.name())
            .serviceEntitlement(resourceQuotaServiceEntitlement)
            .build());

    }
}
Copy
variables:
  testResourceQuotas:
    fn::invoke:
      function: oci:UsageProxy:getResourceQuotas
      arguments:
        compartmentId: ${compartmentId}
        serviceName: ${testService.name}
        serviceEntitlement: ${resourceQuotaServiceEntitlement}
Copy

Using getResourceQuotas

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 getResourceQuotas(args: GetResourceQuotasArgs, opts?: InvokeOptions): Promise<GetResourceQuotasResult>
function getResourceQuotasOutput(args: GetResourceQuotasOutputArgs, opts?: InvokeOptions): Output<GetResourceQuotasResult>
Copy
def get_resource_quotas(compartment_id: Optional[str] = None,
                        filters: Optional[Sequence[_usageproxy.GetResourceQuotasFilter]] = None,
                        service_entitlement: Optional[str] = None,
                        service_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetResourceQuotasResult
def get_resource_quotas_output(compartment_id: Optional[pulumi.Input[str]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[_usageproxy.GetResourceQuotasFilterArgs]]]] = None,
                        service_entitlement: Optional[pulumi.Input[str]] = None,
                        service_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetResourceQuotasResult]
Copy
func GetResourceQuotas(ctx *Context, args *GetResourceQuotasArgs, opts ...InvokeOption) (*GetResourceQuotasResult, error)
func GetResourceQuotasOutput(ctx *Context, args *GetResourceQuotasOutputArgs, opts ...InvokeOption) GetResourceQuotasResultOutput
Copy

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

public static class GetResourceQuotas 
{
    public static Task<GetResourceQuotasResult> InvokeAsync(GetResourceQuotasArgs args, InvokeOptions? opts = null)
    public static Output<GetResourceQuotasResult> Invoke(GetResourceQuotasInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetResourceQuotasResult> getResourceQuotas(GetResourceQuotasArgs args, InvokeOptions options)
public static Output<GetResourceQuotasResult> getResourceQuotas(GetResourceQuotasArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:UsageProxy/getResourceQuotas:getResourceQuotas
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the root compartment.
ServiceName This property is required. string
Service Name.
Filters Changes to this property will trigger replacement. List<GetResourceQuotasFilter>
ServiceEntitlement string
Service entitlement Id.
CompartmentId This property is required. string
The OCID of the root compartment.
ServiceName This property is required. string
Service Name.
Filters Changes to this property will trigger replacement. []GetResourceQuotasFilter
ServiceEntitlement string
Service entitlement Id.
compartmentId This property is required. String
The OCID of the root compartment.
serviceName This property is required. String
Service Name.
filters Changes to this property will trigger replacement. List<GetResourceQuotasFilter>
serviceEntitlement String
Service entitlement Id.
compartmentId This property is required. string
The OCID of the root compartment.
serviceName This property is required. string
Service Name.
filters Changes to this property will trigger replacement. GetResourceQuotasFilter[]
serviceEntitlement string
Service entitlement Id.
compartment_id This property is required. str
The OCID of the root compartment.
service_name This property is required. str
Service Name.
filters Changes to this property will trigger replacement. Sequence[usageproxy.GetResourceQuotasFilter]
service_entitlement str
Service entitlement Id.
compartmentId This property is required. String
The OCID of the root compartment.
serviceName This property is required. String
Service Name.
filters Changes to this property will trigger replacement. List<Property Map>
serviceEntitlement String
Service entitlement Id.

getResourceQuotas Result

The following output properties are available:

CompartmentId string
Id string
The provider-assigned unique ID for this managed resource.
ResourceQuotumCollections List<GetResourceQuotasResourceQuotumCollection>
The list of resource_quotum_collection.
ServiceName string
Filters List<GetResourceQuotasFilter>
ServiceEntitlement string
CompartmentId string
Id string
The provider-assigned unique ID for this managed resource.
ResourceQuotumCollections []GetResourceQuotasResourceQuotumCollection
The list of resource_quotum_collection.
ServiceName string
Filters []GetResourceQuotasFilter
ServiceEntitlement string
compartmentId String
id String
The provider-assigned unique ID for this managed resource.
resourceQuotumCollections List<GetResourceQuotasResourceQuotumCollection>
The list of resource_quotum_collection.
serviceName String
filters List<GetResourceQuotasFilter>
serviceEntitlement String
compartmentId string
id string
The provider-assigned unique ID for this managed resource.
resourceQuotumCollections GetResourceQuotasResourceQuotumCollection[]
The list of resource_quotum_collection.
serviceName string
filters GetResourceQuotasFilter[]
serviceEntitlement string
compartmentId String
id String
The provider-assigned unique ID for this managed resource.
resourceQuotumCollections List<Property Map>
The list of resource_quotum_collection.
serviceName String
filters List<Property Map>
serviceEntitlement String

Supporting Types

GetResourceQuotasFilter

Name This property is required. string
The resource name.
Values This property is required. List<string>
Regex bool
Name This property is required. string
The resource name.
Values This property is required. []string
Regex bool
name This property is required. String
The resource name.
values This property is required. List<String>
regex Boolean
name This property is required. string
The resource name.
values This property is required. string[]
regex boolean
name This property is required. str
The resource name.
values This property is required. Sequence[str]
regex bool
name This property is required. String
The resource name.
values This property is required. List<String>
regex Boolean

GetResourceQuotasResourceQuotumCollection

IsAllowed This property is required. bool
Used to indicate if further quota consumption isAllowed.
Items This property is required. List<GetResourceQuotasResourceQuotumCollectionItem>
The list of resource quota details.
IsAllowed This property is required. bool
Used to indicate if further quota consumption isAllowed.
Items This property is required. []GetResourceQuotasResourceQuotumCollectionItem
The list of resource quota details.
isAllowed This property is required. Boolean
Used to indicate if further quota consumption isAllowed.
items This property is required. List<GetResourceQuotasResourceQuotumCollectionItem>
The list of resource quota details.
isAllowed This property is required. boolean
Used to indicate if further quota consumption isAllowed.
items This property is required. GetResourceQuotasResourceQuotumCollectionItem[]
The list of resource quota details.
is_allowed This property is required. bool
Used to indicate if further quota consumption isAllowed.
items This property is required. Sequence[usageproxy.GetResourceQuotasResourceQuotumCollectionItem]
The list of resource quota details.
isAllowed This property is required. Boolean
Used to indicate if further quota consumption isAllowed.
items This property is required. List<Property Map>
The list of resource quota details.

GetResourceQuotasResourceQuotumCollectionItem

AffectedResource This property is required. string
The affected resource name.
Balance This property is required. double
The quota balance.
IsAllowed This property is required. bool
Used to indicate if further quota consumption isAllowed.
IsDependency This property is required. bool
Used to indicate any resource dependencies.
IsOverage This property is required. bool
Used to indicate if overages are incurred.
Name This property is required. string
The resource name.
PurchasedLimit This property is required. double
The purchased quota limit.
Service This property is required. string
The service name.
AffectedResource This property is required. string
The affected resource name.
Balance This property is required. float64
The quota balance.
IsAllowed This property is required. bool
Used to indicate if further quota consumption isAllowed.
IsDependency This property is required. bool
Used to indicate any resource dependencies.
IsOverage This property is required. bool
Used to indicate if overages are incurred.
Name This property is required. string
The resource name.
PurchasedLimit This property is required. float64
The purchased quota limit.
Service This property is required. string
The service name.
affectedResource This property is required. String
The affected resource name.
balance This property is required. Double
The quota balance.
isAllowed This property is required. Boolean
Used to indicate if further quota consumption isAllowed.
isDependency This property is required. Boolean
Used to indicate any resource dependencies.
isOverage This property is required. Boolean
Used to indicate if overages are incurred.
name This property is required. String
The resource name.
purchasedLimit This property is required. Double
The purchased quota limit.
service This property is required. String
The service name.
affectedResource This property is required. string
The affected resource name.
balance This property is required. number
The quota balance.
isAllowed This property is required. boolean
Used to indicate if further quota consumption isAllowed.
isDependency This property is required. boolean
Used to indicate any resource dependencies.
isOverage This property is required. boolean
Used to indicate if overages are incurred.
name This property is required. string
The resource name.
purchasedLimit This property is required. number
The purchased quota limit.
service This property is required. string
The service name.
affected_resource This property is required. str
The affected resource name.
balance This property is required. float
The quota balance.
is_allowed This property is required. bool
Used to indicate if further quota consumption isAllowed.
is_dependency This property is required. bool
Used to indicate any resource dependencies.
is_overage This property is required. bool
Used to indicate if overages are incurred.
name This property is required. str
The resource name.
purchased_limit This property is required. float
The purchased quota limit.
service This property is required. str
The service name.
affectedResource This property is required. String
The affected resource name.
balance This property is required. Number
The quota balance.
isAllowed This property is required. Boolean
Used to indicate if further quota consumption isAllowed.
isDependency This property is required. Boolean
Used to indicate any resource dependencies.
isOverage This property is required. Boolean
Used to indicate if overages are incurred.
name This property is required. String
The resource name.
purchasedLimit This property is required. Number
The purchased quota limit.
service This property is required. String
The service name.

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi