1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Vbs
  5. getInstVbsInstances
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.Vbs.getInstVbsInstances

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

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

    Returns a list of VbsInstances.

    Example Usage

    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 = @var.Compartment_id,
            Id = @var.Vbs_instance_id,
            Name = @var.Vbs_instance_name,
            State = @var.Vbs_instance_state,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/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: _var.Compartment_id,
    			Id:            pulumi.StringRef(_var.Vbs_instance_id),
    			Name:          pulumi.StringRef(_var.Vbs_instance_name),
    			State:         pulumi.StringRef(_var.Vbs_instance_state),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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(var_.compartment_id())
                .id(var_.vbs_instance_id())
                .name(var_.vbs_instance_name())
                .state(var_.vbs_instance_state())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_vbs_instances = oci.Vbs.get_inst_vbs_instances(compartment_id=var["compartment_id"],
        id=var["vbs_instance_id"],
        name=var["vbs_instance_name"],
        state=var["vbs_instance_state"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testVbsInstances = oci.Vbs.getInstVbsInstances({
        compartmentId: _var.compartment_id,
        id: _var.vbs_instance_id,
        name: _var.vbs_instance_name,
        state: _var.vbs_instance_state,
    });
    
    variables:
      testVbsInstances:
        fn::invoke:
          Function: oci:Vbs:getInstVbsInstances
          Arguments:
            compartmentId: ${var.compartment_id}
            id: ${var.vbs_instance_id}
            name: ${var.vbs_instance_name}
            state: ${var.vbs_instance_state}
    

    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[_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]
    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)
    // Output-based functions aren't available in Java yet
    
    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 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 GetInstVbsInstancesVbsInstanceSummaryCollection]
    The list of vbs_instance_summary_collection.
    filters 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

    GetInstVbsInstancesVbsInstanceSummaryCollectionItem

    CompartmentId string
    The ID of the compartment in which to list resources.
    DefinedTags Dictionary<string, object>
    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, object>
    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, object>
    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]interface{}
    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]interface{}
    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]interface{}
    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,Object>
    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,Object>
    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,Object>
    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]: any}
    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]: any}
    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]: any}
    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, Any]
    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, Any]
    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, Any]
    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<Any>
    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<Any>
    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<Any>
    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.
    oci logo
    Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi