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

oci.Limits.getLimitValues

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 Limit Values in Oracle Cloud Infrastructure Limits service.

    Includes a full list of resource limits belonging to a given service. If subscription Id is provided, limit value for subscription will be returned.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testLimitValues = oci.Limits.getLimitValues({
        compartmentId: tenancyOcid,
        serviceName: testService.name,
        availabilityDomain: limitValueAvailabilityDomain,
        name: limitValueName,
        scopeType: limitValueScopeType,
        subscriptionId: subscriptionOcid,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_limit_values = oci.Limits.get_limit_values(compartment_id=tenancy_ocid,
        service_name=test_service["name"],
        availability_domain=limit_value_availability_domain,
        name=limit_value_name,
        scope_type=limit_value_scope_type,
        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.GetLimitValues(ctx, &limits.GetLimitValuesArgs{
    			CompartmentId:      tenancyOcid,
    			ServiceName:        testService.Name,
    			AvailabilityDomain: pulumi.StringRef(limitValueAvailabilityDomain),
    			Name:               pulumi.StringRef(limitValueName),
    			ScopeType:          pulumi.StringRef(limitValueScopeType),
    			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 testLimitValues = Oci.Limits.GetLimitValues.Invoke(new()
        {
            CompartmentId = tenancyOcid,
            ServiceName = testService.Name,
            AvailabilityDomain = limitValueAvailabilityDomain,
            Name = limitValueName,
            ScopeType = limitValueScopeType,
            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.GetLimitValuesArgs;
    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 testLimitValues = LimitsFunctions.getLimitValues(GetLimitValuesArgs.builder()
                .compartmentId(tenancyOcid)
                .serviceName(testService.name())
                .availabilityDomain(limitValueAvailabilityDomain)
                .name(limitValueName)
                .scopeType(limitValueScopeType)
                .subscriptionId(subscriptionOcid)
                .build());
    
        }
    }
    
    variables:
      testLimitValues:
        fn::invoke:
          Function: oci:Limits:getLimitValues
          Arguments:
            compartmentId: ${tenancyOcid}
            serviceName: ${testService.name}
            availabilityDomain: ${limitValueAvailabilityDomain}
            name: ${limitValueName}
            scopeType: ${limitValueScopeType}
            subscriptionId: ${subscriptionOcid}
    

    Using getLimitValues

    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 getLimitValues(args: GetLimitValuesArgs, opts?: InvokeOptions): Promise<GetLimitValuesResult>
    function getLimitValuesOutput(args: GetLimitValuesOutputArgs, opts?: InvokeOptions): Output<GetLimitValuesResult>
    def get_limit_values(availability_domain: Optional[str] = None,
                         compartment_id: Optional[str] = None,
                         filters: Optional[Sequence[_limits.GetLimitValuesFilter]] = None,
                         name: Optional[str] = None,
                         scope_type: Optional[str] = None,
                         service_name: Optional[str] = None,
                         subscription_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetLimitValuesResult
    def get_limit_values_output(availability_domain: Optional[pulumi.Input[str]] = None,
                         compartment_id: Optional[pulumi.Input[str]] = None,
                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[_limits.GetLimitValuesFilterArgs]]]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         scope_type: Optional[pulumi.Input[str]] = None,
                         service_name: Optional[pulumi.Input[str]] = None,
                         subscription_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetLimitValuesResult]
    func GetLimitValues(ctx *Context, args *GetLimitValuesArgs, opts ...InvokeOption) (*GetLimitValuesResult, error)
    func GetLimitValuesOutput(ctx *Context, args *GetLimitValuesOutputArgs, opts ...InvokeOption) GetLimitValuesResultOutput

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

    public static class GetLimitValues 
    {
        public static Task<GetLimitValuesResult> InvokeAsync(GetLimitValuesArgs args, InvokeOptions? opts = null)
        public static Output<GetLimitValuesResult> Invoke(GetLimitValuesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLimitValuesResult> getLimitValues(GetLimitValuesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Limits/getLimitValues:getLimitValues
      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).
    ServiceName string
    The target service name.
    AvailabilityDomain string
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    Filters List<GetLimitValuesFilter>
    Name string
    Optional field, can be used to see a specific resource limit value.
    ScopeType string
    Filter entries by scope type.
    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).
    ServiceName string
    The target service name.
    AvailabilityDomain string
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    Filters []GetLimitValuesFilter
    Name string
    Optional field, can be used to see a specific resource limit value.
    ScopeType string
    Filter entries by scope type.
    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).
    serviceName String
    The target service name.
    availabilityDomain String
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    filters List<GetLimitValuesFilter>
    name String
    Optional field, can be used to see a specific resource limit value.
    scopeType String
    Filter entries by scope type.
    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).
    serviceName string
    The target service name.
    availabilityDomain string
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    filters GetLimitValuesFilter[]
    name string
    Optional field, can be used to see a specific resource limit value.
    scopeType string
    Filter entries by scope type.
    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).
    service_name str
    The target service name.
    availability_domain str
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    filters Sequence[limits.GetLimitValuesFilter]
    name str
    Optional field, can be used to see a specific resource limit value.
    scope_type str
    Filter entries by scope type.
    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).
    serviceName String
    The target service name.
    availabilityDomain String
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    filters List<Property Map>
    name String
    Optional field, can be used to see a specific resource limit value.
    scopeType String
    Filter entries by scope type.
    subscriptionId String
    The OCID of the subscription assigned to tenant

    getLimitValues Result

    The following output properties are available:

    CompartmentId string
    Id string
    The provider-assigned unique ID for this managed resource.
    LimitValues List<GetLimitValuesLimitValue>
    The list of limit_values.
    ServiceName string
    AvailabilityDomain string
    If present, the returned value is only specific to this availability domain.
    Filters List<GetLimitValuesFilter>
    Name string
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    ScopeType string
    The scope type of the limit.
    SubscriptionId string
    CompartmentId string
    Id string
    The provider-assigned unique ID for this managed resource.
    LimitValues []GetLimitValuesLimitValue
    The list of limit_values.
    ServiceName string
    AvailabilityDomain string
    If present, the returned value is only specific to this availability domain.
    Filters []GetLimitValuesFilter
    Name string
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    ScopeType string
    The scope type of the limit.
    SubscriptionId string
    compartmentId String
    id String
    The provider-assigned unique ID for this managed resource.
    limitValues List<GetLimitValuesLimitValue>
    The list of limit_values.
    serviceName String
    availabilityDomain String
    If present, the returned value is only specific to this availability domain.
    filters List<GetLimitValuesFilter>
    name String
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    scopeType String
    The scope type of the limit.
    subscriptionId String
    compartmentId string
    id string
    The provider-assigned unique ID for this managed resource.
    limitValues GetLimitValuesLimitValue[]
    The list of limit_values.
    serviceName string
    availabilityDomain string
    If present, the returned value is only specific to this availability domain.
    filters GetLimitValuesFilter[]
    name string
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    scopeType string
    The scope type of the limit.
    subscriptionId string
    compartment_id str
    id str
    The provider-assigned unique ID for this managed resource.
    limit_values Sequence[limits.GetLimitValuesLimitValue]
    The list of limit_values.
    service_name str
    availability_domain str
    If present, the returned value is only specific to this availability domain.
    filters Sequence[limits.GetLimitValuesFilter]
    name str
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    scope_type str
    The scope type of the limit.
    subscription_id str
    compartmentId String
    id String
    The provider-assigned unique ID for this managed resource.
    limitValues List<Property Map>
    The list of limit_values.
    serviceName String
    availabilityDomain String
    If present, the returned value is only specific to this availability domain.
    filters List<Property Map>
    name String
    The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
    scopeType String
    The scope type of the limit.
    subscriptionId String

    Supporting Types

    GetLimitValuesFilter

    Name string
    Optional field, can be used to see a specific resource limit value.
    Values List<string>
    Regex bool
    Name string
    Optional field, can be used to see a specific resource limit value.
    Values []string
    Regex bool
    name String
    Optional field, can be used to see a specific resource limit value.
    values List<String>
    regex Boolean
    name string
    Optional field, can be used to see a specific resource limit value.
    values string[]
    regex boolean
    name str
    Optional field, can be used to see a specific resource limit value.
    values Sequence[str]
    regex bool
    name String
    Optional field, can be used to see a specific resource limit value.
    values List<String>
    regex Boolean

    GetLimitValuesLimitValue

    AvailabilityDomain string
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    Name string
    Optional field, can be used to see a specific resource limit value.
    ScopeType string
    Filter entries by scope type.
    Value string
    The resource limit value.
    AvailabilityDomain string
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    Name string
    Optional field, can be used to see a specific resource limit value.
    ScopeType string
    Filter entries by scope type.
    Value string
    The resource limit value.
    availabilityDomain String
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    name String
    Optional field, can be used to see a specific resource limit value.
    scopeType String
    Filter entries by scope type.
    value String
    The resource limit value.
    availabilityDomain string
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    name string
    Optional field, can be used to see a specific resource limit value.
    scopeType string
    Filter entries by scope type.
    value string
    The resource limit value.
    availability_domain str
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    name str
    Optional field, can be used to see a specific resource limit value.
    scope_type str
    Filter entries by scope type.
    value str
    The resource limit value.
    availabilityDomain String
    Filter entries by availability domain. This implies that only AD-specific values are returned.
    name String
    Optional field, can be used to see a specific resource limit value.
    scopeType String
    Filter entries by scope type.
    value String
    The resource limit value.

    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