Oracle Cloud Infrastructure v2.31.0, Apr 17 25

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

oci.ApiGateway.getUsagePlans

Explore with Pulumi AI

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

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testUsagePlans = oci.ApiGateway.getUsagePlans({
    compartmentId: compartmentId,
    displayName: usagePlanDisplayName,
    state: usagePlanState,
});

import pulumi
import pulumi_oci as oci

test_usage_plans = oci.ApiGateway.get_usage_plans(compartment_id=compartment_id,
    display_name=usage_plan_display_name,
    state=usage_plan_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.GetUsagePlans(ctx, &apigateway.GetUsagePlansArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(usagePlanDisplayName),
			State:         pulumi.StringRef(usagePlanState),
		}, 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 testUsagePlans = Oci.ApiGateway.GetUsagePlans.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = usagePlanDisplayName,
        State = usagePlanState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetUsagePlansArgs;
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 testUsagePlans = ApiGatewayFunctions.getUsagePlans(GetUsagePlansArgs.builder()
            .compartmentId(compartmentId)
            .displayName(usagePlanDisplayName)
            .state(usagePlanState)
            .build());

    }
}

variables:
  testUsagePlans:
    fn::invoke:
      function: oci:ApiGateway:getUsagePlans
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${usagePlanDisplayName}
        state: ${usagePlanState}

Using getUsagePlans

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.

TypeScript
Python
Go
C#
Java
YAML

function getUsagePlans(args: GetUsagePlansArgs, opts?: InvokeOptions): Promise<GetUsagePlansResult>
function getUsagePlansOutput(args: GetUsagePlansOutputArgs, opts?: InvokeOptions): Output<GetUsagePlansResult>

def get_usage_plans(compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    filters: Optional[Sequence[_apigateway.GetUsagePlansFilter]] = None,
                    state: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetUsagePlansResult
def get_usage_plans_output(compartment_id: Optional[pulumi.Input[str]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_apigateway.GetUsagePlansFilterArgs]]]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetUsagePlansResult]

func GetUsagePlans(ctx *Context, args *GetUsagePlansArgs, opts ...InvokeOption) (*GetUsagePlansResult, error)
func GetUsagePlansOutput(ctx *Context, args *GetUsagePlansOutputArgs, opts ...InvokeOption) GetUsagePlansResultOutput

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

public static class GetUsagePlans 
{
    public static Task<GetUsagePlansResult> InvokeAsync(GetUsagePlansArgs args, InvokeOptions? opts = null)
    public static Output<GetUsagePlansResult> Invoke(GetUsagePlansInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUsagePlansResult> getUsagePlans(GetUsagePlansArgs args, InvokeOptions options)
public static Output<GetUsagePlansResult> getUsagePlans(GetUsagePlansArgs args, InvokeOptions options)

fn::invoke:
  function: oci:ApiGateway/getUsagePlans:getUsagePlans
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ocid of the compartment in which to list resources.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
Filters List<GetUsagePlansFilter>
State string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

CompartmentId string: The ocid of the compartment in which to list resources.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
Filters []GetUsagePlansFilter
State string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

compartmentId String: The ocid of the compartment in which to list resources.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
filters List<GetUsagePlansFilter>
state String: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

compartmentId string: The ocid of the compartment in which to list resources.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
filters GetUsagePlansFilter[]
state string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

compartment_id str: The ocid of the compartment in which to list resources.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
filters Sequence[apigateway.GetUsagePlansFilter]
state str: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

compartmentId String: The ocid of the compartment in which to list resources.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
filters List<Property Map>
state String: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

getUsagePlans Result

The following output properties are available:

CompartmentId string: The OCID of the compartment in which the resource is created.
Id string: The provider-assigned unique ID for this managed resource.
UsagePlanCollections List<GetUsagePlansUsagePlanCollection>: The list of usage_plan_collection.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
Filters List<GetUsagePlansFilter>
State string: The current state of the usage plan.

CompartmentId string: The OCID of the compartment in which the resource is created.
Id string: The provider-assigned unique ID for this managed resource.
UsagePlanCollections []GetUsagePlansUsagePlanCollection: The list of usage_plan_collection.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
Filters []GetUsagePlansFilter
State string: The current state of the usage plan.

compartmentId String: The OCID of the compartment in which the resource is created.
id String: The provider-assigned unique ID for this managed resource.
usagePlanCollections List<GetUsagePlansUsagePlanCollection>: The list of usage_plan_collection.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters List<GetUsagePlansFilter>
state String: The current state of the usage plan.

compartmentId string: The OCID of the compartment in which the resource is created.
id string: The provider-assigned unique ID for this managed resource.
usagePlanCollections GetUsagePlansUsagePlanCollection[]: The list of usage_plan_collection.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters GetUsagePlansFilter[]
state string: The current state of the usage plan.

compartment_id str: The OCID of the compartment in which the resource is created.
id str: The provider-assigned unique ID for this managed resource.
usage_plan_collections Sequence[apigateway.GetUsagePlansUsagePlanCollection]: The list of usage_plan_collection.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters Sequence[apigateway.GetUsagePlansFilter]
state str: The current state of the usage plan.

compartmentId String: The OCID of the compartment in which the resource is created.
id String: The provider-assigned unique ID for this managed resource.
usagePlanCollections List<Property Map>: The list of usage_plan_collection.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters List<Property Map>
state String: The current state of the usage plan.

Supporting Types

GetUsagePlansFilter

Name string: An entitlement name, unique within a usage plan.
Values List<string>
Regex bool

Name string: An entitlement name, unique within a usage plan.
Values []string
Regex bool

name String: An entitlement name, unique within a usage plan.
values List<String>
regex Boolean

name string: An entitlement name, unique within a usage plan.
values string[]
regex boolean

name str: An entitlement name, unique within a usage plan.
values Sequence[str]
regex bool

name String: An entitlement name, unique within a usage plan.
values List<String>
regex Boolean

GetUsagePlansUsagePlanCollection

Items List<GetUsagePlansUsagePlanCollectionItem>

Items []GetUsagePlansUsagePlanCollectionItem

items List<GetUsagePlansUsagePlanCollectionItem>

items GetUsagePlansUsagePlanCollectionItem[]

items Sequence[apigateway.GetUsagePlansUsagePlanCollectionItem]

items List<Property Map>

GetUsagePlansUsagePlanCollectionItem

CompartmentId string: The ocid of the compartment in which to list resources.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
Entitlements List<GetUsagePlansUsagePlanCollectionItemEntitlement>: A collection of entitlements currently assigned to the usage plan.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of a usage plan resource.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
State string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.

CompartmentId string: The ocid of the compartment in which to list resources.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
Entitlements []GetUsagePlansUsagePlanCollectionItemEntitlement: A collection of entitlements currently assigned to the usage plan.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of a usage plan resource.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
State string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.

compartmentId String: The ocid of the compartment in which to list resources.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
entitlements List<GetUsagePlansUsagePlanCollectionItemEntitlement>: A collection of entitlements currently assigned to the usage plan.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of a usage plan resource.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state String: A filter to return only resources that match the given lifecycle state. Example: ACTIVE
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.

compartmentId string: The ocid of the compartment in which to list resources.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
entitlements GetUsagePlansUsagePlanCollectionItemEntitlement[]: A collection of entitlements currently assigned to the usage plan.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of a usage plan resource.
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE
timeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.

compartment_id str: The ocid of the compartment in which to list resources.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
entitlements Sequence[apigateway.GetUsagePlansUsagePlanCollectionItemEntitlement]: A collection of entitlements currently assigned to the usage plan.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of a usage plan resource.
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state str: A filter to return only resources that match the given lifecycle state. Example: ACTIVE
time_created str: The time this resource was created. An RFC3339 formatted datetime string.
time_updated str: The time this resource was last updated. An RFC3339 formatted datetime string.

compartmentId String: The ocid of the compartment in which to list resources.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
entitlements List<Property Map>: A collection of entitlements currently assigned to the usage plan.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of a usage plan resource.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
state String: A filter to return only resources that match the given lifecycle state. Example: ACTIVE
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.

GetUsagePlansUsagePlanCollectionItemEntitlement

Description string: A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
Name string: An entitlement name, unique within a usage plan.
Quotas List<GetUsagePlansUsagePlanCollectionItemEntitlementQuota>: Quota policy for a usage plan.
RateLimits List<GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit>: Rate-limiting policy for a usage plan.
Targets List<GetUsagePlansUsagePlanCollectionItemEntitlementTarget>: A collection of targeted deployments that the entitlement will be applied to.

Description string: A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
Name string: An entitlement name, unique within a usage plan.
Quotas []GetUsagePlansUsagePlanCollectionItemEntitlementQuota: Quota policy for a usage plan.
RateLimits []GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit: Rate-limiting policy for a usage plan.
Targets []GetUsagePlansUsagePlanCollectionItemEntitlementTarget: A collection of targeted deployments that the entitlement will be applied to.

description String: A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
name String: An entitlement name, unique within a usage plan.
quotas List<GetUsagePlansUsagePlanCollectionItemEntitlementQuota>: Quota policy for a usage plan.
rateLimits List<GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit>: Rate-limiting policy for a usage plan.
targets List<GetUsagePlansUsagePlanCollectionItemEntitlementTarget>: A collection of targeted deployments that the entitlement will be applied to.

description string: A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
name string: An entitlement name, unique within a usage plan.
quotas GetUsagePlansUsagePlanCollectionItemEntitlementQuota[]: Quota policy for a usage plan.
rateLimits GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit[]: Rate-limiting policy for a usage plan.
targets GetUsagePlansUsagePlanCollectionItemEntitlementTarget[]: A collection of targeted deployments that the entitlement will be applied to.

description str: A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
name str: An entitlement name, unique within a usage plan.
quotas Sequence[apigateway.GetUsagePlansUsagePlanCollectionItemEntitlementQuota]: Quota policy for a usage plan.
rate_limits Sequence[apigateway.GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit]: Rate-limiting policy for a usage plan.
targets Sequence[apigateway.GetUsagePlansUsagePlanCollectionItemEntitlementTarget]: A collection of targeted deployments that the entitlement will be applied to.

description String: A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
name String: An entitlement name, unique within a usage plan.
quotas List<Property Map>: Quota policy for a usage plan.
rateLimits List<Property Map>: Rate-limiting policy for a usage plan.
targets List<Property Map>: A collection of targeted deployments that the entitlement will be applied to.

GetUsagePlansUsagePlanCollectionItemEntitlementQuota

OperationOnBreach string: What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
ResetPolicy string: The policy that controls when quotas will reset. Example: CALENDAR
Unit string: The unit of time over which rate limits are calculated. Example: SECOND
Value int: The number of requests that can be made per time period.

OperationOnBreach string: What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
ResetPolicy string: The policy that controls when quotas will reset. Example: CALENDAR
Unit string: The unit of time over which rate limits are calculated. Example: SECOND
Value int: The number of requests that can be made per time period.

operationOnBreach String: What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
resetPolicy String: The policy that controls when quotas will reset. Example: CALENDAR
unit String: The unit of time over which rate limits are calculated. Example: SECOND
value Integer: The number of requests that can be made per time period.

operationOnBreach string: What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
resetPolicy string: The policy that controls when quotas will reset. Example: CALENDAR
unit string: The unit of time over which rate limits are calculated. Example: SECOND
value number: The number of requests that can be made per time period.

operation_on_breach str: What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
reset_policy str: The policy that controls when quotas will reset. Example: CALENDAR
unit str: The unit of time over which rate limits are calculated. Example: SECOND
value int: The number of requests that can be made per time period.

operationOnBreach String: What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
resetPolicy String: The policy that controls when quotas will reset. Example: CALENDAR
unit String: The unit of time over which rate limits are calculated. Example: SECOND
value Number: The number of requests that can be made per time period.

GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit

Unit string: The unit of time over which rate limits are calculated. Example: SECOND
Value int: The number of requests that can be made per time period.

Unit string: The unit of time over which rate limits are calculated. Example: SECOND
Value int: The number of requests that can be made per time period.

unit String: The unit of time over which rate limits are calculated. Example: SECOND
value Integer: The number of requests that can be made per time period.

unit string: The unit of time over which rate limits are calculated. Example: SECOND
value number: The number of requests that can be made per time period.

unit str: The unit of time over which rate limits are calculated. Example: SECOND
value int: The number of requests that can be made per time period.

unit String: The unit of time over which rate limits are calculated. Example: SECOND
value Number: The number of requests that can be made per time period.

GetUsagePlansUsagePlanCollectionItemEntitlementTarget

DeploymentId string: The OCID of a deployment resource.

DeploymentId string: The OCID of a deployment resource.

deploymentId String: The OCID of a deployment resource.

deploymentId string: The OCID of a deployment resource.

deployment_id str: The OCID of a deployment resource.

deploymentId String: The OCID of a deployment resource.

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

pulumi/pulumi-oci

oci.ApiGateway.getUsagePlans

On this page

On this page

Example Usage

Using getUsagePlans

getUsagePlans Result

Supporting Types

GetUsagePlansFilter

GetUsagePlansUsagePlanCollection

GetUsagePlansUsagePlanCollectionItem

GetUsagePlansUsagePlanCollectionItemEntitlement

GetUsagePlansUsagePlanCollectionItemEntitlementQuota

GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit

GetUsagePlansUsagePlanCollectionItemEntitlementTarget

Package Details

On this page

On this page