Oracle Cloud Infrastructure v3.10.0, Nov 5 25

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.oci.getApiaccesscontrolApiMetadatas

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Example Usage

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

const testApiMetadatas = oci.oci.getApiaccesscontrolApiMetadatas({
    compartmentId: compartmentId,
    displayName: apiMetadataDisplayName,
    resourceType: apiMetadataResourceType,
    state: apiMetadataState,
});

import pulumi
import pulumi_oci as oci

test_api_metadatas = oci.oci.get_apiaccesscontrol_api_metadatas(compartment_id=compartment_id,
    display_name=api_metadata_display_name,
    resource_type=api_metadata_resource_type,
    state=api_metadata_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oci.GetApiaccesscontrolApiMetadatas(ctx, &oci.GetApiaccesscontrolApiMetadatasArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(apiMetadataDisplayName),
			ResourceType:  pulumi.StringRef(apiMetadataResourceType),
			State:         pulumi.StringRef(apiMetadataState),
		}, 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 testApiMetadatas = Oci.Oci.GetApiaccesscontrolApiMetadatas.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = apiMetadataDisplayName,
        ResourceType = apiMetadataResourceType,
        State = apiMetadataState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.OciFunctions;
import com.pulumi.oci.oci.inputs.GetApiaccesscontrolApiMetadatasArgs;
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 testApiMetadatas = OciFunctions.getApiaccesscontrolApiMetadatas(GetApiaccesscontrolApiMetadatasArgs.builder()
            .compartmentId(compartmentId)
            .displayName(apiMetadataDisplayName)
            .resourceType(apiMetadataResourceType)
            .state(apiMetadataState)
            .build());

    }
}

variables:
  testApiMetadatas:
    fn::invoke:
      function: oci:oci:getApiaccesscontrolApiMetadatas
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${apiMetadataDisplayName}
        resourceType: ${apiMetadataResourceType}
        state: ${apiMetadataState}

Using getApiaccesscontrolApiMetadatas

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 getApiaccesscontrolApiMetadatas(args: GetApiaccesscontrolApiMetadatasArgs, opts?: InvokeOptions): Promise<GetApiaccesscontrolApiMetadatasResult>
function getApiaccesscontrolApiMetadatasOutput(args: GetApiaccesscontrolApiMetadatasOutputArgs, opts?: InvokeOptions): Output<GetApiaccesscontrolApiMetadatasResult>

def get_apiaccesscontrol_api_metadatas(compartment_id: Optional[str] = None,
                                       display_name: Optional[str] = None,
                                       filters: Optional[Sequence[GetApiaccesscontrolApiMetadatasFilter]] = None,
                                       resource_type: Optional[str] = None,
                                       state: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetApiaccesscontrolApiMetadatasResult
def get_apiaccesscontrol_api_metadatas_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                       display_name: Optional[pulumi.Input[str]] = None,
                                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetApiaccesscontrolApiMetadatasFilterArgs]]]] = None,
                                       resource_type: Optional[pulumi.Input[str]] = None,
                                       state: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetApiaccesscontrolApiMetadatasResult]

func GetApiaccesscontrolApiMetadatas(ctx *Context, args *GetApiaccesscontrolApiMetadatasArgs, opts ...InvokeOption) (*GetApiaccesscontrolApiMetadatasResult, error)
func GetApiaccesscontrolApiMetadatasOutput(ctx *Context, args *GetApiaccesscontrolApiMetadatasOutputArgs, opts ...InvokeOption) GetApiaccesscontrolApiMetadatasResultOutput

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

public static class GetApiaccesscontrolApiMetadatas 
{
    public static Task<GetApiaccesscontrolApiMetadatasResult> InvokeAsync(GetApiaccesscontrolApiMetadatasArgs args, InvokeOptions? opts = null)
    public static Output<GetApiaccesscontrolApiMetadatasResult> Invoke(GetApiaccesscontrolApiMetadatasInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiaccesscontrolApiMetadatasResult> getApiaccesscontrolApiMetadatas(GetApiaccesscontrolApiMetadatasArgs args, InvokeOptions options)
public static Output<GetApiaccesscontrolApiMetadatasResult> getApiaccesscontrolApiMetadatas(GetApiaccesscontrolApiMetadatasArgs args, InvokeOptions options)

fn::invoke:
  function: oci:oci/getApiaccesscontrolApiMetadatas:getApiaccesscontrolApiMetadatas
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetApiaccesscontrolApiMetadatasFilter>
ResourceType string: A filter to return only lists of resources that match the entire given service type.
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetApiaccesscontrolApiMetadatasFilter
ResourceType string: A filter to return only lists of resources that match the entire given service type.
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetApiaccesscontrolApiMetadatasFilter>
resourceType String: A filter to return only lists of resources that match the entire given service type.
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId string: The OCID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetApiaccesscontrolApiMetadatasFilter[]
resourceType string: A filter to return only lists of resources that match the entire given service type.
state string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

compartment_id str: The OCID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the given display name exactly.
filters Sequence[GetApiaccesscontrolApiMetadatasFilter]
resource_type str: A filter to return only lists of resources that match the entire given service type.
state str: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>
resourceType String: A filter to return only lists of resources that match the entire given service type.
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

getApiaccesscontrolApiMetadatas Result

The following output properties are available:

ApiMetadataCollections List<GetApiaccesscontrolApiMetadatasApiMetadataCollection>: The list of api_metadata_collection.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentId string
DisplayName string: The operation Name of the api. The name must be unique.
Filters List<GetApiaccesscontrolApiMetadatasFilter>
ResourceType string
State string: The current state of the ApiMetadata.

ApiMetadataCollections []GetApiaccesscontrolApiMetadatasApiMetadataCollection: The list of api_metadata_collection.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentId string
DisplayName string: The operation Name of the api. The name must be unique.
Filters []GetApiaccesscontrolApiMetadatasFilter
ResourceType string
State string: The current state of the ApiMetadata.

apiMetadataCollections List<GetApiaccesscontrolApiMetadatasApiMetadataCollection>: The list of api_metadata_collection.
id String: The provider-assigned unique ID for this managed resource.
compartmentId String
displayName String: The operation Name of the api. The name must be unique.
filters List<GetApiaccesscontrolApiMetadatasFilter>
resourceType String
state String: The current state of the ApiMetadata.

apiMetadataCollections GetApiaccesscontrolApiMetadatasApiMetadataCollection[]: The list of api_metadata_collection.
id string: The provider-assigned unique ID for this managed resource.
compartmentId string
displayName string: The operation Name of the api. The name must be unique.
filters GetApiaccesscontrolApiMetadatasFilter[]
resourceType string
state string: The current state of the ApiMetadata.

api_metadata_collections Sequence[GetApiaccesscontrolApiMetadatasApiMetadataCollection]: The list of api_metadata_collection.
id str: The provider-assigned unique ID for this managed resource.
compartment_id str
display_name str: The operation Name of the api. The name must be unique.
filters Sequence[GetApiaccesscontrolApiMetadatasFilter]
resource_type str
state str: The current state of the ApiMetadata.

apiMetadataCollections List<Property Map>: The list of api_metadata_collection.
id String: The provider-assigned unique ID for this managed resource.
compartmentId String
displayName String: The operation Name of the api. The name must be unique.
filters List<Property Map>
resourceType String
state String: The current state of the ApiMetadata.

Supporting Types

GetApiaccesscontrolApiMetadatasApiMetadataCollection

Items List<GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem>

Items []GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem

items List<GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem>

items GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem[]

items Sequence[GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem]

items List<Property Map>

GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem

ApiName string: The name of the api to execute the api request.
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 filter to return only resources that match the given display name exactly.
EntityType string: ResourceType to which the apiMetadata belongs to.
Fields List<string>: List of the fields that is use while calling post or put for the data.
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 the ApiDetail.
LifecycleDetails string: A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
Path string: rest path of the api.
ServiceName string: The service Name to which the api belongs to.
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeDeleted string: The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

ApiName string: The name of the api to execute the api request.
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 filter to return only resources that match the given display name exactly.
EntityType string: ResourceType to which the apiMetadata belongs to.
Fields []string: List of the fields that is use while calling post or put for the data.
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 the ApiDetail.
LifecycleDetails string: A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
Path string: rest path of the api.
ServiceName string: The service Name to which the api belongs to.
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeDeleted string: The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

apiName String: The name of the api to execute the api request.
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 filter to return only resources that match the given display name exactly.
entityType String: ResourceType to which the apiMetadata belongs to.
fields List<String>: List of the fields that is use while calling post or put for the data.
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 the ApiDetail.
lifecycleDetails String: A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
path String: rest path of the api.
serviceName String: The service Name to which the api belongs to.
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeDeleted String: The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

apiName string: The name of the api to execute the api request.
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 filter to return only resources that match the given display name exactly.
entityType string: ResourceType to which the apiMetadata belongs to.
fields string[]: List of the fields that is use while calling post or put for the data.
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 the ApiDetail.
lifecycleDetails string: A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
path string: rest path of the api.
serviceName string: The service Name to which the api belongs to.
state string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeDeleted string: The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string: The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

api_name str: The name of the api to execute the api request.
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 filter to return only resources that match the given display name exactly.
entity_type str: ResourceType to which the apiMetadata belongs to.
fields Sequence[str]: List of the fields that is use while calling post or put for the data.
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 the ApiDetail.
lifecycle_details str: A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
path str: rest path of the api.
service_name str: The service Name to which the api belongs to.
state str: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
time_deleted str: The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
time_updated str: The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

apiName String: The name of the api to execute the api request.
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 filter to return only resources that match the given display name exactly.
entityType String: ResourceType to which the apiMetadata belongs to.
fields List<String>: List of the fields that is use while calling post or put for the data.
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 the ApiDetail.
lifecycleDetails String: A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
path String: rest path of the api.
serviceName String: The service Name to which the api belongs to.
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeDeleted String: The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

GetApiaccesscontrolApiMetadatasFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

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 v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

oci.oci.getApiaccesscontrolApiMetadatas

On this page

On this page

Example Usage

Using getApiaccesscontrolApiMetadatas

getApiaccesscontrolApiMetadatas Result

Supporting Types

GetApiaccesscontrolApiMetadatasApiMetadataCollection

GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem

GetApiaccesscontrolApiMetadatasFilter

Package Details

On this page

On this page