Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Vbs
  5. getInstVbsInstances
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.Vbs.getInstVbsInstances

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides the list of Vbs Instances in Oracle Cloud Infrastructure Vbs Inst service.

Returns a list of VbsInstances.

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,
});
Copy
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)
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

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

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>
Copy
def get_inst_vbs_instances(compartment_id: Optional[str] = None,
                           filters: Optional[Sequence[_vbs.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[_vbs.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]
Copy
func GetInstVbsInstances(ctx *Context, args *GetInstVbsInstancesArgs, opts ...InvokeOption) (*GetInstVbsInstancesResult, error)
func GetInstVbsInstancesOutput(ctx *Context, args *GetInstVbsInstancesOutputArgs, opts ...InvokeOption) GetInstVbsInstancesResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetInstVbsInstancesResult> getInstVbsInstances(GetInstVbsInstancesArgs args, InvokeOptions options)
public static Output<GetInstVbsInstancesResult> getInstVbsInstances(GetInstVbsInstancesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Vbs/getInstVbsInstances:getInstVbsInstances
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
Filters Changes to this property will trigger replacement. 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 This property is required. string
The ID of the compartment in which to list resources.
Filters Changes to this property will trigger replacement. []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 This property is required. String
The ID of the compartment in which to list resources.
filters Changes to this property will trigger replacement. 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 This property is required. string
The ID of the compartment in which to list resources.
filters Changes to this property will trigger replacement. 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 This property is required. str
The ID of the compartment in which to list resources.
filters Changes to this property will trigger replacement. Sequence[vbs.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 This property is required. String
The ID of the compartment in which to list resources.
filters Changes to this property will trigger replacement. 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[vbs.GetInstVbsInstancesVbsInstanceSummaryCollection]
The list of vbs_instance_summary_collection.
filters Sequence[vbs.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 This property is required. string
A filter to return only resources that match the entire name given.
Values This property is required. List<string>
Regex bool
Name This property is required. string
A filter to return only resources that match the entire name given.
Values This property is required. []string
Regex bool
name This property is required. String
A filter to return only resources that match the entire name given.
values This property is required. List<String>
regex Boolean
name This property is required. string
A filter to return only resources that match the entire name given.
values This property is required. string[]
regex boolean
name This property is required. str
A filter to return only resources that match the entire name given.
values This property is required. Sequence[str]
regex bool
name This property is required. String
A filter to return only resources that match the entire name given.
values This property is required. List<String>
regex Boolean

GetInstVbsInstancesVbsInstanceSummaryCollection

items This property is required. List<Property Map>

GetInstVbsInstancesVbsInstanceSummaryCollectionItem

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
Service instance display name
FreeformTags This property is required. 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 This property is required. string
unique VbsInstance identifier
IdcsAccessToken This property is required. string
IsResourceUsageAgreementGranted This property is required. bool
Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
LifecyleDetails This property is required. 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 This property is required. string
A filter to return only resources that match the entire name given.
ResourceCompartmentId This property is required. string
Compartment where VBS may create additional resources for the service instance
State This property is required. string
A filter to return only resources their lifecycleState matches the given lifecycleState.
SystemTags This property is required. Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The time the the VbsInstance was created. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time the VbsInstance was updated. An RFC3339 formatted datetime string
VbsAccessUrl This property is required. string
Public web URL for accessing the VBS service instance
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
Service instance display name
FreeformTags This property is required. 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 This property is required. string
unique VbsInstance identifier
IdcsAccessToken This property is required. string
IsResourceUsageAgreementGranted This property is required. bool
Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
LifecyleDetails This property is required. 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 This property is required. string
A filter to return only resources that match the entire name given.
ResourceCompartmentId This property is required. string
Compartment where VBS may create additional resources for the service instance
State This property is required. string
A filter to return only resources their lifecycleState matches the given lifecycleState.
SystemTags This property is required. map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The time the the VbsInstance was created. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time the VbsInstance was updated. An RFC3339 formatted datetime string
VbsAccessUrl This property is required. string
Public web URL for accessing the VBS service instance
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
Service instance display name
freeformTags This property is required. 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 This property is required. String
unique VbsInstance identifier
idcsAccessToken This property is required. String
isResourceUsageAgreementGranted This property is required. Boolean
Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
lifecyleDetails This property is required. 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 This property is required. String
A filter to return only resources that match the entire name given.
resourceCompartmentId This property is required. String
Compartment where VBS may create additional resources for the service instance
state This property is required. String
A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags This property is required. Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The time the the VbsInstance was created. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time the VbsInstance was updated. An RFC3339 formatted datetime string
vbsAccessUrl This property is required. String
Public web URL for accessing the VBS service instance
compartmentId This property is required. string
The ID of the compartment in which to list resources.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. string
Service instance display name
freeformTags This property is required. {[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 This property is required. string
unique VbsInstance identifier
idcsAccessToken This property is required. string
isResourceUsageAgreementGranted This property is required. boolean
Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
lifecyleDetails This property is required. 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 This property is required. string
A filter to return only resources that match the entire name given.
resourceCompartmentId This property is required. string
Compartment where VBS may create additional resources for the service instance
state This property is required. string
A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags This property is required. {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. string
The time the the VbsInstance was created. An RFC3339 formatted datetime string
timeUpdated This property is required. string
The time the VbsInstance was updated. An RFC3339 formatted datetime string
vbsAccessUrl This property is required. string
Public web URL for accessing the VBS service instance
compartment_id This property is required. str
The ID of the compartment in which to list resources.
defined_tags This property is required. 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 This property is required. str
Service instance display name
freeform_tags This property is required. 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 This property is required. str
unique VbsInstance identifier
idcs_access_token This property is required. str
is_resource_usage_agreement_granted This property is required. bool
Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
lifecyle_details This property is required. 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 This property is required. str
A filter to return only resources that match the entire name given.
resource_compartment_id This property is required. str
Compartment where VBS may create additional resources for the service instance
state This property is required. str
A filter to return only resources their lifecycleState matches the given lifecycleState.
system_tags This property is required. Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created This property is required. str
The time the the VbsInstance was created. An RFC3339 formatted datetime string
time_updated This property is required. str
The time the VbsInstance was updated. An RFC3339 formatted datetime string
vbs_access_url This property is required. str
Public web URL for accessing the VBS service instance
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
Service instance display name
freeformTags This property is required. 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 This property is required. String
unique VbsInstance identifier
idcsAccessToken This property is required. String
isResourceUsageAgreementGranted This property is required. Boolean
Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
lifecyleDetails This property is required. 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 This property is required. String
A filter to return only resources that match the entire name given.
resourceCompartmentId This property is required. String
Compartment where VBS may create additional resources for the service instance
state This property is required. String
A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags This property is required. Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The time the the VbsInstance was created. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time the VbsInstance was updated. An RFC3339 formatted datetime string
vbsAccessUrl This property is required. 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.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci