Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getOnpremConnectors

This data source provides the list of On Prem Connectors in Oracle Cloud Infrastructure Data Safe service.

Gets a list of on-premises connectors.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testOnPremConnectors = Output.Create(Oci.DataSafe.GetOnpremConnectors.InvokeAsync(new Oci.DataSafe.GetOnpremConnectorsArgs
        {
            CompartmentId = @var.Compartment_id,
            AccessLevel = @var.On_prem_connector_access_level,
            CompartmentIdInSubtree = @var.On_prem_connector_compartment_id_in_subtree,
            DisplayName = @var.On_prem_connector_display_name,
            OnPremConnectorId = oci_data_safe_on_prem_connector.Test_on_prem_connector.Id,
            OnPremConnectorLifecycleState = @var.On_prem_connector_on_prem_connector_lifecycle_state,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.GetOnpremConnectors(ctx, &datasafe.GetOnpremConnectorsArgs{
			CompartmentId:                 _var.Compartment_id,
			AccessLevel:                   pulumi.StringRef(_var.On_prem_connector_access_level),
			CompartmentIdInSubtree:        pulumi.BoolRef(_var.On_prem_connector_compartment_id_in_subtree),
			DisplayName:                   pulumi.StringRef(_var.On_prem_connector_display_name),
			OnPremConnectorId:             pulumi.StringRef(oci_data_safe_on_prem_connector.Test_on_prem_connector.Id),
			OnPremConnectorLifecycleState: pulumi.StringRef(_var.On_prem_connector_on_prem_connector_lifecycle_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_on_prem_connectors = oci.DataSafe.get_onprem_connectors(compartment_id=var["compartment_id"],
    access_level=var["on_prem_connector_access_level"],
    compartment_id_in_subtree=var["on_prem_connector_compartment_id_in_subtree"],
    display_name=var["on_prem_connector_display_name"],
    on_prem_connector_id=oci_data_safe_on_prem_connector["test_on_prem_connector"]["id"],
    on_prem_connector_lifecycle_state=var["on_prem_connector_on_prem_connector_lifecycle_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testOnPremConnectors = oci.DataSafe.getOnpremConnectors({
    compartmentId: _var.compartment_id,
    accessLevel: _var.on_prem_connector_access_level,
    compartmentIdInSubtree: _var.on_prem_connector_compartment_id_in_subtree,
    displayName: _var.on_prem_connector_display_name,
    onPremConnectorId: oci_data_safe_on_prem_connector.test_on_prem_connector.id,
    onPremConnectorLifecycleState: _var.on_prem_connector_on_prem_connector_lifecycle_state,
});

Coming soon!

Using getOnpremConnectors

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 getOnpremConnectors(args: GetOnpremConnectorsArgs, opts?: InvokeOptions): Promise<GetOnpremConnectorsResult>
function getOnpremConnectorsOutput(args: GetOnpremConnectorsOutputArgs, opts?: InvokeOptions): Output<GetOnpremConnectorsResult>
def get_onprem_connectors(access_level: Optional[str] = None,
                          compartment_id: Optional[str] = None,
                          compartment_id_in_subtree: Optional[bool] = None,
                          display_name: Optional[str] = None,
                          filters: Optional[Sequence[_datasafe.GetOnpremConnectorsFilter]] = None,
                          on_prem_connector_id: Optional[str] = None,
                          on_prem_connector_lifecycle_state: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetOnpremConnectorsResult
def get_onprem_connectors_output(access_level: Optional[pulumi.Input[str]] = None,
                          compartment_id: Optional[pulumi.Input[str]] = None,
                          compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datasafe.GetOnpremConnectorsFilterArgs]]]] = None,
                          on_prem_connector_id: Optional[pulumi.Input[str]] = None,
                          on_prem_connector_lifecycle_state: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetOnpremConnectorsResult]
func GetOnpremConnectors(ctx *Context, args *GetOnpremConnectorsArgs, opts ...InvokeOption) (*GetOnpremConnectorsResult, error)
func GetOnpremConnectorsOutput(ctx *Context, args *GetOnpremConnectorsOutputArgs, opts ...InvokeOption) GetOnpremConnectorsResultOutput

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

public static class GetOnpremConnectors 
{
    public static Task<GetOnpremConnectorsResult> InvokeAsync(GetOnpremConnectorsArgs args, InvokeOptions? opts = null)
    public static Output<GetOnpremConnectorsResult> Invoke(GetOnpremConnectorsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOnpremConnectorsResult> getOnpremConnectors(GetOnpremConnectorsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataSafe/getOnpremConnectors:getOnpremConnectors
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

AccessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

CompartmentIdInSubtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

DisplayName string

A filter to return only resources that match the specified display name.

Filters List<GetOnpremConnectorsFilter>
OnPremConnectorId string

A filter to return only the on-premises connector that matches the specified id.

OnPremConnectorLifecycleState string

A filter to return only on-premises connector resources that match the specified lifecycle state.

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

AccessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

CompartmentIdInSubtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

DisplayName string

A filter to return only resources that match the specified display name.

Filters []GetOnpremConnectorsFilter
OnPremConnectorId string

A filter to return only the on-premises connector that matches the specified id.

OnPremConnectorLifecycleState string

A filter to return only on-premises connector resources that match the specified lifecycle state.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

accessLevel String

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree Boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName String

A filter to return only resources that match the specified display name.

filters List<GetOnpremConnectorsFilter>
onPremConnectorId String

A filter to return only the on-premises connector that matches the specified id.

onPremConnectorLifecycleState String

A filter to return only on-premises connector resources that match the specified lifecycle state.

compartmentId string

A filter to return only resources that match the specified compartment OCID.

accessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName string

A filter to return only resources that match the specified display name.

filters GetOnpremConnectorsFilter[]
onPremConnectorId string

A filter to return only the on-premises connector that matches the specified id.

onPremConnectorLifecycleState string

A filter to return only on-premises connector resources that match the specified lifecycle state.

compartment_id str

A filter to return only resources that match the specified compartment OCID.

access_level str

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartment_id_in_subtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

display_name str

A filter to return only resources that match the specified display name.

filters GetOnpremConnectorsFilter]
on_prem_connector_id str

A filter to return only the on-premises connector that matches the specified id.

on_prem_connector_lifecycle_state str

A filter to return only on-premises connector resources that match the specified lifecycle state.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

accessLevel String

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree Boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName String

A filter to return only resources that match the specified display name.

filters List<Property Map>
onPremConnectorId String

A filter to return only the on-premises connector that matches the specified id.

onPremConnectorLifecycleState String

A filter to return only on-premises connector resources that match the specified lifecycle state.

getOnpremConnectors Result

The following output properties are available:

CompartmentId string

The OCID of the compartment that contains the on-premises connector.

Id string

The provider-assigned unique ID for this managed resource.

OnPremConnectors List<GetOnpremConnectorsOnPremConnector>

The list of on_prem_connectors.

AccessLevel string
CompartmentIdInSubtree bool
DisplayName string

The display name of the on-premises connector.

Filters List<GetOnpremConnectorsFilter>
OnPremConnectorId string
OnPremConnectorLifecycleState string
CompartmentId string

The OCID of the compartment that contains the on-premises connector.

Id string

The provider-assigned unique ID for this managed resource.

OnPremConnectors []GetOnpremConnectorsOnPremConnector

The list of on_prem_connectors.

AccessLevel string
CompartmentIdInSubtree bool
DisplayName string

The display name of the on-premises connector.

Filters []GetOnpremConnectorsFilter
OnPremConnectorId string
OnPremConnectorLifecycleState string
compartmentId String

The OCID of the compartment that contains the on-premises connector.

id String

The provider-assigned unique ID for this managed resource.

onPremConnectors List<GetOnpremConnectorsOnPremConnector>

The list of on_prem_connectors.

accessLevel String
compartmentIdInSubtree Boolean
displayName String

The display name of the on-premises connector.

filters List<GetOnpremConnectorsFilter>
onPremConnectorId String
onPremConnectorLifecycleState String
compartmentId string

The OCID of the compartment that contains the on-premises connector.

id string

The provider-assigned unique ID for this managed resource.

onPremConnectors GetOnpremConnectorsOnPremConnector[]

The list of on_prem_connectors.

accessLevel string
compartmentIdInSubtree boolean
displayName string

The display name of the on-premises connector.

filters GetOnpremConnectorsFilter[]
onPremConnectorId string
onPremConnectorLifecycleState string
compartment_id str

The OCID of the compartment that contains the on-premises connector.

id str

The provider-assigned unique ID for this managed resource.

on_prem_connectors GetOnpremConnectorsOnPremConnector]

The list of on_prem_connectors.

access_level str
compartment_id_in_subtree bool
display_name str

The display name of the on-premises connector.

filters GetOnpremConnectorsFilter]
on_prem_connector_id str
on_prem_connector_lifecycle_state str
compartmentId String

The OCID of the compartment that contains the on-premises connector.

id String

The provider-assigned unique ID for this managed resource.

onPremConnectors List<Property Map>

The list of on_prem_connectors.

accessLevel String
compartmentIdInSubtree Boolean
displayName String

The display name of the on-premises connector.

filters List<Property Map>
onPremConnectorId String
onPremConnectorLifecycleState String

Supporting Types

GetOnpremConnectorsFilter

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

GetOnpremConnectorsOnPremConnector

AvailableVersion string

Latest available version of the on-premises connector.

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

CreatedVersion string

Created version of the on-premises connector.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

Description string

The description of the on-premises connector.

DisplayName string

A filter to return only resources that match the specified display name.

FreeformTags Dictionary<string, object>

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 on-premises connector.

LifecycleDetails string

Details about the current state of the on-premises connector.

State string

The current state of the on-premises connector.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The date and time the on-premises connector was created, in the format defined by RFC3339.

AvailableVersion string

Latest available version of the on-premises connector.

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

CreatedVersion string

Created version of the on-premises connector.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

Description string

The description of the on-premises connector.

DisplayName string

A filter to return only resources that match the specified display name.

FreeformTags map[string]interface{}

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 on-premises connector.

LifecycleDetails string

Details about the current state of the on-premises connector.

State string

The current state of the on-premises connector.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The date and time the on-premises connector was created, in the format defined by RFC3339.

availableVersion String

Latest available version of the on-premises connector.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

createdVersion String

Created version of the on-premises connector.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

description String

The description of the on-premises connector.

displayName String

A filter to return only resources that match the specified display name.

freeformTags Map<String,Object>

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 on-premises connector.

lifecycleDetails String

Details about the current state of the on-premises connector.

state String

The current state of the on-premises connector.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The date and time the on-premises connector was created, in the format defined by RFC3339.

availableVersion string

Latest available version of the on-premises connector.

compartmentId string

A filter to return only resources that match the specified compartment OCID.

createdVersion string

Created version of the on-premises connector.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

description string

The description of the on-premises connector.

displayName string

A filter to return only resources that match the specified display name.

freeformTags {[key: string]: any}

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 on-premises connector.

lifecycleDetails string

Details about the current state of the on-premises connector.

state string

The current state of the on-premises connector.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The date and time the on-premises connector was created, in the format defined by RFC3339.

available_version str

Latest available version of the on-premises connector.

compartment_id str

A filter to return only resources that match the specified compartment OCID.

created_version str

Created version of the on-premises connector.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

description str

The description of the on-premises connector.

display_name str

A filter to return only resources that match the specified display name.

freeform_tags Mapping[str, Any]

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 on-premises connector.

lifecycle_details str

Details about the current state of the on-premises connector.

state str

The current state of the on-premises connector.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The date and time the on-premises connector was created, in the format defined by RFC3339.

availableVersion String

Latest available version of the on-premises connector.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

createdVersion String

Created version of the on-premises connector.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

description String

The description of the on-premises connector.

displayName String

A filter to return only resources that match the specified display name.

freeformTags Map<Any>

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 on-premises connector.

lifecycleDetails String

Details about the current state of the on-premises connector.

state String

The current state of the on-premises connector.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The date and time the on-premises connector was created, in the format defined by RFC3339.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.