Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.Vbs.getInstVbsInstances

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testVbsInstances = oci.Vbs.getInstVbsInstances({
    compartmentId: compartmentId,
    id: vbsInstanceId,
    name: vbsInstanceName,
    state: vbsInstanceState,
});

import pulumi
import pulumi_oci as oci

test_vbs_instances = oci.Vbs.get_inst_vbs_instances(compartment_id=compartment_id,
    id=vbs_instance_id,
    name=vbs_instance_name,
    state=vbs_instance_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vbs.GetInstVbsInstances(ctx, &vbs.GetInstVbsInstancesArgs{
			CompartmentId: compartmentId,
			Id:            pulumi.StringRef(vbsInstanceId),
			Name:          pulumi.StringRef(vbsInstanceName),
			State:         pulumi.StringRef(vbsInstanceState),
		}, 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 testVbsInstances = Oci.Vbs.GetInstVbsInstances.Invoke(new()
    {
        CompartmentId = compartmentId,
        Id = vbsInstanceId,
        Name = vbsInstanceName,
        State = vbsInstanceState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Vbs.VbsFunctions;
import com.pulumi.oci.Vbs.inputs.GetInstVbsInstancesArgs;
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 testVbsInstances = VbsFunctions.getInstVbsInstances(GetInstVbsInstancesArgs.builder()
            .compartmentId(compartmentId)
            .id(vbsInstanceId)
            .name(vbsInstanceName)
            .state(vbsInstanceState)
            .build());

    }
}

variables:
  testVbsInstances:
    fn::invoke:
      function: oci:Vbs:getInstVbsInstances
      arguments:
        compartmentId: ${compartmentId}
        id: ${vbsInstanceId}
        name: ${vbsInstanceName}
        state: ${vbsInstanceState}

Using getInstVbsInstances

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 getInstVbsInstances(args: GetInstVbsInstancesArgs, opts?: InvokeOptions): Promise<GetInstVbsInstancesResult>
function getInstVbsInstancesOutput(args: GetInstVbsInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstVbsInstancesResult>

def get_inst_vbs_instances(compartment_id: Optional[str] = None,
                           filters: Optional[Sequence[GetInstVbsInstancesFilter]] = None,
                           id: Optional[str] = None,
                           name: Optional[str] = None,
                           state: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetInstVbsInstancesResult
def get_inst_vbs_instances_output(compartment_id: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetInstVbsInstancesFilterArgs]]]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetInstVbsInstancesResult]

func GetInstVbsInstances(ctx *Context, args *GetInstVbsInstancesArgs, opts ...InvokeOption) (*GetInstVbsInstancesResult, error)
func GetInstVbsInstancesOutput(ctx *Context, args *GetInstVbsInstancesOutputArgs, opts ...InvokeOption) GetInstVbsInstancesResultOutput

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

public static class GetInstVbsInstances 
{
    public static Task<GetInstVbsInstancesResult> InvokeAsync(GetInstVbsInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstVbsInstancesResult> Invoke(GetInstVbsInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstVbsInstancesResult> getInstVbsInstances(GetInstVbsInstancesArgs args, InvokeOptions options)
public static Output<GetInstVbsInstancesResult> getInstVbsInstances(GetInstVbsInstancesArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Vbs/getInstVbsInstances:getInstVbsInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of the compartment in which to list resources.
Filters List<GetInstVbsInstancesFilter>
Id string: unique VbsInstance identifier
Name string: A filter to return only resources that match the entire name given.
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.

CompartmentId string: The ID of the compartment in which to list resources.
Filters []GetInstVbsInstancesFilter
Id string: unique VbsInstance identifier
Name string: A filter to return only resources that match the entire name given.
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources.
filters List<GetInstInstancesFilter>
id String: unique VbsInstance identifier
name String: A filter to return only resources that match the entire name given.
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.

compartmentId string: The ID of the compartment in which to list resources.
filters GetInstVbsInstancesFilter[]
id string: unique VbsInstance identifier
name string: A filter to return only resources that match the entire name given.
state string: A filter to return only resources their lifecycleState matches the given lifecycleState.

compartment_id str: The ID of the compartment in which to list resources.
filters Sequence[GetInstVbsInstancesFilter]
id str: unique VbsInstance identifier
name str: A filter to return only resources that match the entire name given.
state str: A filter to return only resources their lifecycleState matches the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources.
filters List<Property Map>
id String: unique VbsInstance identifier
name String: A filter to return only resources that match the entire name given.
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.

getInstVbsInstances Result

The following output properties are available:

CompartmentId string: Compartment of the service instance
VbsInstanceSummaryCollections List<GetInstVbsInstancesVbsInstanceSummaryCollection>: The list of vbs_instance_summary_collection.
Filters List<GetInstVbsInstancesFilter>
Id string: Unique identifier that is immutable on creation
Name string: Service instance name (unique identifier)
State string: The current state of the VbsInstance.

CompartmentId string: Compartment of the service instance
VbsInstanceSummaryCollections []GetInstVbsInstancesVbsInstanceSummaryCollection: The list of vbs_instance_summary_collection.
Filters []GetInstVbsInstancesFilter
Id string: Unique identifier that is immutable on creation
Name string: Service instance name (unique identifier)
State string: The current state of the VbsInstance.

compartmentId String: Compartment of the service instance
vbsInstanceSummaryCollections List<GetInstInstancesInstanceSummaryCollection>: The list of vbs_instance_summary_collection.
filters List<GetInstInstancesFilter>
id String: Unique identifier that is immutable on creation
name String: Service instance name (unique identifier)
state String: The current state of the VbsInstance.

compartmentId string: Compartment of the service instance
vbsInstanceSummaryCollections GetInstVbsInstancesVbsInstanceSummaryCollection[]: The list of vbs_instance_summary_collection.
filters GetInstVbsInstancesFilter[]
id string: Unique identifier that is immutable on creation
name string: Service instance name (unique identifier)
state string: The current state of the VbsInstance.

compartment_id str: Compartment of the service instance
vbs_instance_summary_collections Sequence[GetInstVbsInstancesVbsInstanceSummaryCollection]: The list of vbs_instance_summary_collection.
filters Sequence[GetInstVbsInstancesFilter]
id str: Unique identifier that is immutable on creation
name str: Service instance name (unique identifier)
state str: The current state of the VbsInstance.

compartmentId String: Compartment of the service instance
vbsInstanceSummaryCollections List<Property Map>: The list of vbs_instance_summary_collection.
filters List<Property Map>
id String: Unique identifier that is immutable on creation
name String: Service instance name (unique identifier)
state String: The current state of the VbsInstance.

Supporting Types

GetInstVbsInstancesFilter

Name string: A filter to return only resources that match the entire name given.
Values List<string>
Regex bool

Name string: A filter to return only resources that match the entire name given.
Values []string
Regex bool

name String: A filter to return only resources that match the entire name given.
values List<String>
regex Boolean

name string: A filter to return only resources that match the entire name given.
values string[]
regex boolean

name str: A filter to return only resources that match the entire name given.
values Sequence[str]
regex bool

name String: A filter to return only resources that match the entire name given.
values List<String>
regex Boolean

GetInstVbsInstancesVbsInstanceSummaryCollection

Items List<GetInstVbsInstancesVbsInstanceSummaryCollectionItem>

Items []GetInstVbsInstancesVbsInstanceSummaryCollectionItem

items List<GetInstInstancesInstanceSummaryCollectionItem>

items GetInstVbsInstancesVbsInstanceSummaryCollectionItem[]

items Sequence[GetInstVbsInstancesVbsInstanceSummaryCollectionItem]

items List<Property Map>

GetInstVbsInstancesVbsInstanceSummaryCollectionItem

CompartmentId string: The ID 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. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: Service instance display name
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: unique VbsInstance identifier
IdcsAccessToken string
IsResourceUsageAgreementGranted bool: Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
LifecyleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Name string: A filter to return only resources that match the entire name given.
ResourceCompartmentId string: Compartment where VBS may create additional resources for the service instance
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the the VbsInstance was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the VbsInstance was updated. An RFC3339 formatted datetime string
VbsAccessUrl string: Public web URL for accessing the VBS service instance

CompartmentId string: The ID 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. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: Service instance display name
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: unique VbsInstance identifier
IdcsAccessToken string
IsResourceUsageAgreementGranted bool: Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
LifecyleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Name string: A filter to return only resources that match the entire name given.
ResourceCompartmentId string: Compartment where VBS may create additional resources for the service instance
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the the VbsInstance was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the VbsInstance was updated. An RFC3339 formatted datetime string
VbsAccessUrl string: Public web URL for accessing the VBS service instance

compartmentId String: The ID 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. Example: {"foo-namespace.bar-key": "value"}
displayName String: Service instance display name
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: unique VbsInstance identifier
idcsAccessToken String
isResourceUsageAgreementGranted Boolean: Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
lifecyleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
name String: A filter to return only resources that match the entire name given.
resourceCompartmentId String: Compartment where VBS may create additional resources for the service instance
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the the VbsInstance was created. An RFC3339 formatted datetime string
timeUpdated String: The time the VbsInstance was updated. An RFC3339 formatted datetime string
vbsAccessUrl String: Public web URL for accessing the VBS service instance

compartmentId string: The ID 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. Example: {"foo-namespace.bar-key": "value"}
displayName string: Service instance display name
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: unique VbsInstance identifier
idcsAccessToken string
isResourceUsageAgreementGranted boolean: Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
lifecyleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
name string: A filter to return only resources that match the entire name given.
resourceCompartmentId string: Compartment where VBS may create additional resources for the service instance
state string: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time the the VbsInstance was created. An RFC3339 formatted datetime string
timeUpdated string: The time the VbsInstance was updated. An RFC3339 formatted datetime string
vbsAccessUrl string: Public web URL for accessing the VBS service instance

compartment_id str: The ID 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. Example: {"foo-namespace.bar-key": "value"}
display_name str: Service instance display name
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: unique VbsInstance identifier
idcs_access_token str
is_resource_usage_agreement_granted bool: Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
lifecyle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
name str: A filter to return only resources that match the entire name given.
resource_compartment_id str: Compartment where VBS may create additional resources for the service instance
state str: A filter to return only resources their lifecycleState matches the given lifecycleState.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time the the VbsInstance was created. An RFC3339 formatted datetime string
time_updated str: The time the VbsInstance was updated. An RFC3339 formatted datetime string
vbs_access_url str: Public web URL for accessing the VBS service instance

compartmentId String: The ID 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. Example: {"foo-namespace.bar-key": "value"}
displayName String: Service instance display name
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: unique VbsInstance identifier
idcsAccessToken String
isResourceUsageAgreementGranted Boolean: Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
lifecyleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
name String: A filter to return only resources that match the entire name given.
resourceCompartmentId String: Compartment where VBS may create additional resources for the service instance
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the the VbsInstance was created. An RFC3339 formatted datetime string
timeUpdated String: The time the VbsInstance was updated. An RFC3339 formatted datetime string
vbsAccessUrl String: Public web URL for accessing the VBS service instance

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.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.Vbs.getInstVbsInstances

On this page

On this page

Example Usage

Using getInstVbsInstances

getInstVbsInstances Result

Supporting Types

GetInstVbsInstancesFilter

GetInstVbsInstancesVbsInstanceSummaryCollection

GetInstVbsInstancesVbsInstanceSummaryCollectionItem

Package Details

On this page

On this page