1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. UsageProxy
  5. getResourceQuotas
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.UsageProxy.getResourceQuotas

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 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,
    });
    
    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)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/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
    	})
    }
    
    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,
        });
    
    });
    
    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());
    
        }
    }
    
    variables:
      testResourceQuotas:
        fn::invoke:
          Function: oci:UsageProxy:getResourceQuotas
          Arguments:
            compartmentId: ${compartmentId}
            serviceName: ${testService.name}
            serviceEntitlement: ${resourceQuotaServiceEntitlement}
    

    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>
    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]
    func GetResourceQuotas(ctx *Context, args *GetResourceQuotasArgs, opts ...InvokeOption) (*GetResourceQuotasResult, error)
    func GetResourceQuotasOutput(ctx *Context, args *GetResourceQuotasOutputArgs, opts ...InvokeOption) GetResourceQuotasResultOutput

    > 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)
    }
    public static CompletableFuture<GetResourceQuotasResult> getResourceQuotas(GetResourceQuotasArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:UsageProxy/getResourceQuotas:getResourceQuotas
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the root compartment.
    ServiceName string
    Service Name.
    Filters List<GetResourceQuotasFilter>
    ServiceEntitlement string
    Service entitlement Id.
    CompartmentId string
    The OCID of the root compartment.
    ServiceName string
    Service Name.
    Filters []GetResourceQuotasFilter
    ServiceEntitlement string
    Service entitlement Id.
    compartmentId String
    The OCID of the root compartment.
    serviceName String
    Service Name.
    filters List<GetResourceQuotasFilter>
    serviceEntitlement String
    Service entitlement Id.
    compartmentId string
    The OCID of the root compartment.
    serviceName string
    Service Name.
    filters GetResourceQuotasFilter[]
    serviceEntitlement string
    Service entitlement Id.
    compartment_id str
    The OCID of the root compartment.
    service_name str
    Service Name.
    filters Sequence[usageproxy.GetResourceQuotasFilter]
    service_entitlement str
    Service entitlement Id.
    compartmentId String
    The OCID of the root compartment.
    serviceName String
    Service Name.
    filters 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 string
    The resource name.
    Values List<string>
    Regex bool
    Name string
    The resource name.
    Values []string
    Regex bool
    name String
    The resource name.
    values List<String>
    regex Boolean
    name string
    The resource name.
    values string[]
    regex boolean
    name str
    The resource name.
    values Sequence[str]
    regex bool
    name String
    The resource name.
    values List<String>
    regex Boolean

    GetResourceQuotasResourceQuotumCollection

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

    GetResourceQuotasResourceQuotumCollectionItem

    AffectedResource string
    The affected resource name.
    Balance double
    The quota balance.
    IsAllowed bool
    Used to indicate if further quota consumption isAllowed.
    IsDependency bool
    Used to indicate any resource dependencies.
    IsOverage bool
    Used to indicate if overages are incurred.
    Name string
    The resource name.
    PurchasedLimit double
    The purchased quota limit.
    Service string
    The service name.
    AffectedResource string
    The affected resource name.
    Balance float64
    The quota balance.
    IsAllowed bool
    Used to indicate if further quota consumption isAllowed.
    IsDependency bool
    Used to indicate any resource dependencies.
    IsOverage bool
    Used to indicate if overages are incurred.
    Name string
    The resource name.
    PurchasedLimit float64
    The purchased quota limit.
    Service string
    The service name.
    affectedResource String
    The affected resource name.
    balance Double
    The quota balance.
    isAllowed Boolean
    Used to indicate if further quota consumption isAllowed.
    isDependency Boolean
    Used to indicate any resource dependencies.
    isOverage Boolean
    Used to indicate if overages are incurred.
    name String
    The resource name.
    purchasedLimit Double
    The purchased quota limit.
    service String
    The service name.
    affectedResource string
    The affected resource name.
    balance number
    The quota balance.
    isAllowed boolean
    Used to indicate if further quota consumption isAllowed.
    isDependency boolean
    Used to indicate any resource dependencies.
    isOverage boolean
    Used to indicate if overages are incurred.
    name string
    The resource name.
    purchasedLimit number
    The purchased quota limit.
    service string
    The service name.
    affected_resource str
    The affected resource name.
    balance float
    The quota balance.
    is_allowed bool
    Used to indicate if further quota consumption isAllowed.
    is_dependency bool
    Used to indicate any resource dependencies.
    is_overage bool
    Used to indicate if overages are incurred.
    name str
    The resource name.
    purchased_limit float
    The purchased quota limit.
    service str
    The service name.
    affectedResource String
    The affected resource name.
    balance Number
    The quota balance.
    isAllowed Boolean
    Used to indicate if further quota consumption isAllowed.
    isDependency Boolean
    Used to indicate any resource dependencies.
    isOverage Boolean
    Used to indicate if overages are incurred.
    name String
    The resource name.
    purchasedLimit Number
    The purchased quota limit.
    service 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.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi