Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Limits
  5. getLimitDefinitions
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Limits.getLimitDefinitions

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Limit Definitions in Oracle Cloud Infrastructure Limits service.

    Includes a list of resource limits that are currently supported. If subscription Id is provided, then only resource limits supported by subscription will be returned If the ‘areQuotasSupported’ property is true, you can create quota policies on top of this limit at the compartment level.

    Example Usage

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

const testLimitDefinitions = oci.Limits.getLimitDefinitions({
    compartmentId: tenancyOcid,
    name: limitDefinitionName,
    serviceName: testService.name,
    subscriptionId: subscriptionOcid,
});

    import pulumi
import pulumi_oci as oci

test_limit_definitions = oci.Limits.get_limit_definitions(compartment_id=tenancy_ocid,
    name=limit_definition_name,
    service_name=test_service["name"],
    subscription_id=subscription_ocid)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Limits.GetLimitDefinitions(ctx, &limits.GetLimitDefinitionsArgs{
			CompartmentId:  tenancyOcid,
			Name:           pulumi.StringRef(limitDefinitionName),
			ServiceName:    pulumi.StringRef(testService.Name),
			SubscriptionId: pulumi.StringRef(subscriptionOcid),
		}, 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 testLimitDefinitions = Oci.Limits.GetLimitDefinitions.Invoke(new()
    {
        CompartmentId = tenancyOcid,
        Name = limitDefinitionName,
        ServiceName = testService.Name,
        SubscriptionId = subscriptionOcid,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Limits.LimitsFunctions;
import com.pulumi.oci.Limits.inputs.GetLimitDefinitionsArgs;
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 testLimitDefinitions = LimitsFunctions.getLimitDefinitions(GetLimitDefinitionsArgs.builder()
            .compartmentId(tenancyOcid)
            .name(limitDefinitionName)
            .serviceName(testService.name())
            .subscriptionId(subscriptionOcid)
            .build());

    }
}

    variables:
  testLimitDefinitions:
    fn::invoke:
      Function: oci:Limits:getLimitDefinitions
      Arguments:
        compartmentId: ${tenancyOcid}
        name: ${limitDefinitionName}
        serviceName: ${testService.name}
        subscriptionId: ${subscriptionOcid}

    Using getLimitDefinitions

    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 getLimitDefinitions(args: GetLimitDefinitionsArgs, opts?: InvokeOptions): Promise<GetLimitDefinitionsResult>
function getLimitDefinitionsOutput(args: GetLimitDefinitionsOutputArgs, opts?: InvokeOptions): Output<GetLimitDefinitionsResult>
    def get_limit_definitions(compartment_id: Optional[str] = None,
                          filters: Optional[Sequence[_limits.GetLimitDefinitionsFilter]] = None,
                          name: Optional[str] = None,
                          service_name: Optional[str] = None,
                          subscription_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetLimitDefinitionsResult
def get_limit_definitions_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_limits.GetLimitDefinitionsFilterArgs]]]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          service_name: Optional[pulumi.Input[str]] = None,
                          subscription_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetLimitDefinitionsResult]
    func GetLimitDefinitions(ctx *Context, args *GetLimitDefinitionsArgs, opts ...InvokeOption) (*GetLimitDefinitionsResult, error)
func GetLimitDefinitionsOutput(ctx *Context, args *GetLimitDefinitionsOutputArgs, opts ...InvokeOption) GetLimitDefinitionsResultOutput

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

    public static class GetLimitDefinitions 
{
    public static Task<GetLimitDefinitionsResult> InvokeAsync(GetLimitDefinitionsArgs args, InvokeOptions? opts = null)
    public static Output<GetLimitDefinitionsResult> Invoke(GetLimitDefinitionsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLimitDefinitionsResult> getLimitDefinitions(GetLimitDefinitionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Limits/getLimitDefinitions:getLimitDefinitions
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    Filters List<GetLimitDefinitionsFilter>
    Name string
    Optional field, filter for a specific resource limit.
    ServiceName string
    The target service name.
    SubscriptionId string
    The OCID of the subscription assigned to tenant
    CompartmentId string
    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    Filters []GetLimitDefinitionsFilter
    Name string
    Optional field, filter for a specific resource limit.
    ServiceName string
    The target service name.
    SubscriptionId string
    The OCID of the subscription assigned to tenant
    compartmentId String
    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    filters List<GetLimitDefinitionsFilter>
    name String
    Optional field, filter for a specific resource limit.
    serviceName String
    The target service name.
    subscriptionId String
    The OCID of the subscription assigned to tenant
    compartmentId string
    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    filters GetLimitDefinitionsFilter[]
    name string
    Optional field, filter for a specific resource limit.
    serviceName string
    The target service name.
    subscriptionId string
    The OCID of the subscription assigned to tenant
    compartment_id str
    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    filters Sequence[limits.GetLimitDefinitionsFilter]
    name str
    Optional field, filter for a specific resource limit.
    service_name str
    The target service name.
    subscription_id str
    The OCID of the subscription assigned to tenant
    compartmentId String
    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
    filters List<Property Map>
    name String
    Optional field, filter for a specific resource limit.
    serviceName String
    The target service name.
    subscriptionId String
    The OCID of the subscription assigned to tenant

    getLimitDefinitions Result

    The following output properties are available:

    CompartmentId string
    Id string
    The provider-assigned unique ID for this managed resource.
    LimitDefinitions List<GetLimitDefinitionsLimitDefinition>
    The list of limit_definitions.
    Filters List<GetLimitDefinitionsFilter>
    Name string
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    ServiceName string
    The service name of the limit.
    SubscriptionId string
    CompartmentId string
    Id string
    The provider-assigned unique ID for this managed resource.
    LimitDefinitions []GetLimitDefinitionsLimitDefinition
    The list of limit_definitions.
    Filters []GetLimitDefinitionsFilter
    Name string
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    ServiceName string
    The service name of the limit.
    SubscriptionId string
    compartmentId String
    id String
    The provider-assigned unique ID for this managed resource.
    limitDefinitions List<GetLimitDefinitionsLimitDefinition>
    The list of limit_definitions.
    filters List<GetLimitDefinitionsFilter>
    name String
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    serviceName String
    The service name of the limit.
    subscriptionId String
    compartmentId string
    id string
    The provider-assigned unique ID for this managed resource.
    limitDefinitions GetLimitDefinitionsLimitDefinition[]
    The list of limit_definitions.
    filters GetLimitDefinitionsFilter[]
    name string
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    serviceName string
    The service name of the limit.
    subscriptionId string
    compartment_id str
    id str
    The provider-assigned unique ID for this managed resource.
    limit_definitions Sequence[limits.GetLimitDefinitionsLimitDefinition]
    The list of limit_definitions.
    filters Sequence[limits.GetLimitDefinitionsFilter]
    name str
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    service_name str
    The service name of the limit.
    subscription_id str
    compartmentId String
    id String
    The provider-assigned unique ID for this managed resource.
    limitDefinitions List<Property Map>
    The list of limit_definitions.
    filters List<Property Map>
    name String
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    serviceName String
    The service name of the limit.
    subscriptionId String

    Supporting Types

    GetLimitDefinitionsFilter

    Name string
    Optional field, filter for a specific resource limit.
    Values List<string>
    Regex bool
    Name string
    Optional field, filter for a specific resource limit.
    Values []string
    Regex bool
    name String
    Optional field, filter for a specific resource limit.
    values List<String>
    regex Boolean
    name string
    Optional field, filter for a specific resource limit.
    values string[]
    regex boolean
    name str
    Optional field, filter for a specific resource limit.
    values Sequence[str]
    regex bool
    name String
    Optional field, filter for a specific resource limit.
    values List<String>
    regex Boolean

    GetLimitDefinitionsLimitDefinition

    AreQuotasSupported bool
    If true, quota policies can be created on top of this resource limit.
    Description string
    The limit description.
    IsDeprecated bool
    Indicates if the limit has been deprecated.
    IsDynamic bool
    The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.
    IsEligibleForLimitIncrease bool
    Indicates if the customer can request a limit increase for this resource.
    IsResourceAvailabilitySupported bool
    Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.
    Name string
    Optional field, filter for a specific resource limit.
    ScopeType string
    Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.
    ServiceName string
    The target service name.
    SupportedQuotaFamilies List<string>
    Supported quota family names for creation of quota policy.
    SupportedSubscriptions List<string>
    An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.
    AreQuotasSupported bool
    If true, quota policies can be created on top of this resource limit.
    Description string
    The limit description.
    IsDeprecated bool
    Indicates if the limit has been deprecated.
    IsDynamic bool
    The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.
    IsEligibleForLimitIncrease bool
    Indicates if the customer can request a limit increase for this resource.
    IsResourceAvailabilitySupported bool
    Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.
    Name string
    Optional field, filter for a specific resource limit.
    ScopeType string
    Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.
    ServiceName string
    The target service name.
    SupportedQuotaFamilies []string
    Supported quota family names for creation of quota policy.
    SupportedSubscriptions []string
    An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.
    areQuotasSupported Boolean
    If true, quota policies can be created on top of this resource limit.
    description String
    The limit description.
    isDeprecated Boolean
    Indicates if the limit has been deprecated.
    isDynamic Boolean
    The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.
    isEligibleForLimitIncrease Boolean
    Indicates if the customer can request a limit increase for this resource.
    isResourceAvailabilitySupported Boolean
    Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.
    name String
    Optional field, filter for a specific resource limit.
    scopeType String
    Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.
    serviceName String
    The target service name.
    supportedQuotaFamilies List<String>
    Supported quota family names for creation of quota policy.
    supportedSubscriptions List<String>
    An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.
    areQuotasSupported boolean
    If true, quota policies can be created on top of this resource limit.
    description string
    The limit description.
    isDeprecated boolean
    Indicates if the limit has been deprecated.
    isDynamic boolean
    The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.
    isEligibleForLimitIncrease boolean
    Indicates if the customer can request a limit increase for this resource.
    isResourceAvailabilitySupported boolean
    Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.
    name string
    Optional field, filter for a specific resource limit.
    scopeType string
    Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.
    serviceName string
    The target service name.
    supportedQuotaFamilies string[]
    Supported quota family names for creation of quota policy.
    supportedSubscriptions string[]
    An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.
    are_quotas_supported bool
    If true, quota policies can be created on top of this resource limit.
    description str
    The limit description.
    is_deprecated bool
    Indicates if the limit has been deprecated.
    is_dynamic bool
    The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.
    is_eligible_for_limit_increase bool
    Indicates if the customer can request a limit increase for this resource.
    is_resource_availability_supported bool
    Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.
    name str
    Optional field, filter for a specific resource limit.
    scope_type str
    Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.
    service_name str
    The target service name.
    supported_quota_families Sequence[str]
    Supported quota family names for creation of quota policy.
    supported_subscriptions Sequence[str]
    An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.
    areQuotasSupported Boolean
    If true, quota policies can be created on top of this resource limit.
    description String
    The limit description.
    isDeprecated Boolean
    Indicates if the limit has been deprecated.
    isDynamic Boolean
    The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.
    isEligibleForLimitIncrease Boolean
    Indicates if the customer can request a limit increase for this resource.
    isResourceAvailabilitySupported Boolean
    Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.
    name String
    Optional field, filter for a specific resource limit.
    scopeType String
    Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.
    serviceName String
    The target service name.
    supportedQuotaFamilies List<String>
    Supported quota family names for creation of quota policy.
    supportedSubscriptions List<String>
    An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.

    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.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci