Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. getOutboundConnectors
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.FileStorage.getOutboundConnectors

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Outbound Connectors in Oracle Cloud Infrastructure File Storage service.

    Lists the outbound connector resources in the specified compartment.

    Example Usage

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

const testOutboundConnectors = oci.FileStorage.getOutboundConnectors({
    availabilityDomain: outboundConnectorAvailabilityDomain,
    compartmentId: compartmentId,
    displayName: outboundConnectorDisplayName,
    id: outboundConnectorId,
    state: outboundConnectorState,
});

    import pulumi
import pulumi_oci as oci

test_outbound_connectors = oci.FileStorage.get_outbound_connectors(availability_domain=outbound_connector_availability_domain,
    compartment_id=compartment_id,
    display_name=outbound_connector_display_name,
    id=outbound_connector_id,
    state=outbound_connector_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := FileStorage.GetOutboundConnectors(ctx, &filestorage.GetOutboundConnectorsArgs{
			AvailabilityDomain: outboundConnectorAvailabilityDomain,
			CompartmentId:      compartmentId,
			DisplayName:        pulumi.StringRef(outboundConnectorDisplayName),
			Id:                 pulumi.StringRef(outboundConnectorId),
			State:              pulumi.StringRef(outboundConnectorState),
		}, 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 testOutboundConnectors = Oci.FileStorage.GetOutboundConnectors.Invoke(new()
    {
        AvailabilityDomain = outboundConnectorAvailabilityDomain,
        CompartmentId = compartmentId,
        DisplayName = outboundConnectorDisplayName,
        Id = outboundConnectorId,
        State = outboundConnectorState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.FileStorageFunctions;
import com.pulumi.oci.FileStorage.inputs.GetOutboundConnectorsArgs;
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 testOutboundConnectors = FileStorageFunctions.getOutboundConnectors(GetOutboundConnectorsArgs.builder()
            .availabilityDomain(outboundConnectorAvailabilityDomain)
            .compartmentId(compartmentId)
            .displayName(outboundConnectorDisplayName)
            .id(outboundConnectorId)
            .state(outboundConnectorState)
            .build());

    }
}

    variables:
  testOutboundConnectors:
    fn::invoke:
      Function: oci:FileStorage:getOutboundConnectors
      Arguments:
        availabilityDomain: ${outboundConnectorAvailabilityDomain}
        compartmentId: ${compartmentId}
        displayName: ${outboundConnectorDisplayName}
        id: ${outboundConnectorId}
        state: ${outboundConnectorState}

    Using getOutboundConnectors

    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 getOutboundConnectors(args: GetOutboundConnectorsArgs, opts?: InvokeOptions): Promise<GetOutboundConnectorsResult>
function getOutboundConnectorsOutput(args: GetOutboundConnectorsOutputArgs, opts?: InvokeOptions): Output<GetOutboundConnectorsResult>
    def get_outbound_connectors(availability_domain: Optional[str] = None,
                            compartment_id: Optional[str] = None,
                            display_name: Optional[str] = None,
                            filters: Optional[Sequence[_filestorage.GetOutboundConnectorsFilter]] = None,
                            id: Optional[str] = None,
                            state: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetOutboundConnectorsResult
def get_outbound_connectors_output(availability_domain: Optional[pulumi.Input[str]] = None,
                            compartment_id: Optional[pulumi.Input[str]] = None,
                            display_name: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[_filestorage.GetOutboundConnectorsFilterArgs]]]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            state: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetOutboundConnectorsResult]
    func GetOutboundConnectors(ctx *Context, args *GetOutboundConnectorsArgs, opts ...InvokeOption) (*GetOutboundConnectorsResult, error)
func GetOutboundConnectorsOutput(ctx *Context, args *GetOutboundConnectorsOutputArgs, opts ...InvokeOption) GetOutboundConnectorsResultOutput

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

    public static class GetOutboundConnectors 
{
    public static Task<GetOutboundConnectorsResult> InvokeAsync(GetOutboundConnectorsArgs args, InvokeOptions? opts = null)
    public static Output<GetOutboundConnectorsResult> Invoke(GetOutboundConnectorsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOutboundConnectorsResult> getOutboundConnectors(GetOutboundConnectorsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:FileStorage/getOutboundConnectors:getOutboundConnectors
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    Filters List<GetOutboundConnectorsFilter>
    Id string
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    State string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    Filters []GetOutboundConnectorsFilter
    Id string
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    State string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    filters List<GetOutboundConnectorsFilter>
    id String
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    availabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId string
    The OCID of the compartment.
    displayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    filters GetOutboundConnectorsFilter[]
    id string
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    state string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    availability_domain str
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartment_id str
    The OCID of the compartment.
    display_name str
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    filters Sequence[filestorage.GetOutboundConnectorsFilter]
    id str
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    state str
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    filters List<Property Map>
    id String
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.

    getOutboundConnectors Result

    The following output properties are available:

    AvailabilityDomain string
    The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
    CompartmentId string
    The OCID of the compartment that contains the outbound connector.
    OutboundConnectors List<GetOutboundConnectorsOutboundConnector>
    The list of outbound_connectors.
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
    Filters List<GetOutboundConnectorsFilter>
    Id string
    The OCID of the outbound connector.
    State string
    The current state of this outbound connector.
    AvailabilityDomain string
    The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
    CompartmentId string
    The OCID of the compartment that contains the outbound connector.
    OutboundConnectors []GetOutboundConnectorsOutboundConnector
    The list of outbound_connectors.
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
    Filters []GetOutboundConnectorsFilter
    Id string
    The OCID of the outbound connector.
    State string
    The current state of this outbound connector.
    availabilityDomain String
    The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
    compartmentId String
    The OCID of the compartment that contains the outbound connector.
    outboundConnectors List<GetOutboundConnectorsOutboundConnector>
    The list of outbound_connectors.
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
    filters List<GetOutboundConnectorsFilter>
    id String
    The OCID of the outbound connector.
    state String
    The current state of this outbound connector.
    availabilityDomain string
    The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
    compartmentId string
    The OCID of the compartment that contains the outbound connector.
    outboundConnectors GetOutboundConnectorsOutboundConnector[]
    The list of outbound_connectors.
    displayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
    filters GetOutboundConnectorsFilter[]
    id string
    The OCID of the outbound connector.
    state string
    The current state of this outbound connector.
    availability_domain str
    The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
    compartment_id str
    The OCID of the compartment that contains the outbound connector.
    outbound_connectors Sequence[filestorage.GetOutboundConnectorsOutboundConnector]
    The list of outbound_connectors.
    display_name str
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
    filters Sequence[filestorage.GetOutboundConnectorsFilter]
    id str
    The OCID of the outbound connector.
    state str
    The current state of this outbound connector.
    availabilityDomain String
    The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
    compartmentId String
    The OCID of the compartment that contains the outbound connector.
    outboundConnectors List<Property Map>
    The list of outbound_connectors.
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
    filters List<Property Map>
    id String
    The OCID of the outbound connector.
    state String
    The current state of this outbound connector.

    Supporting Types

    GetOutboundConnectorsFilter

    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

    GetOutboundConnectorsOutboundConnector

    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    BindDistinguishedName string
    The LDAP Distinguished Name of the account.
    CompartmentId string
    The OCID of the compartment.
    ConnectorType string
    The account type of this outbound 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"}
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    Endpoints List<GetOutboundConnectorsOutboundConnectorEndpoint>
    Array of server endpoints to use when connecting with the LDAP bind account.
    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
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    PasswordSecretId string
    The OCID of the password for the LDAP bind account in the Vault.
    PasswordSecretVersion int
    Version of the password secret in the Vault to use.
    State string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    TimeCreated string
    The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    BindDistinguishedName string
    The LDAP Distinguished Name of the account.
    CompartmentId string
    The OCID of the compartment.
    ConnectorType string
    The account type of this outbound 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"}
    DisplayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    Endpoints []GetOutboundConnectorsOutboundConnectorEndpoint
    Array of server endpoints to use when connecting with the LDAP bind account.
    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
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    PasswordSecretId string
    The OCID of the password for the LDAP bind account in the Vault.
    PasswordSecretVersion int
    Version of the password secret in the Vault to use.
    State string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    TimeCreated string
    The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    bindDistinguishedName String
    The LDAP Distinguished Name of the account.
    compartmentId String
    The OCID of the compartment.
    connectorType String
    The account type of this outbound 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"}
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    endpoints List<GetOutboundConnectorsOutboundConnectorEndpoint>
    Array of server endpoints to use when connecting with the LDAP bind account.
    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
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    passwordSecretId String
    The OCID of the password for the LDAP bind account in the Vault.
    passwordSecretVersion Integer
    Version of the password secret in the Vault to use.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    timeCreated String
    The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    bindDistinguishedName string
    The LDAP Distinguished Name of the account.
    compartmentId string
    The OCID of the compartment.
    connectorType string
    The account type of this outbound 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"}
    displayName string
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    endpoints GetOutboundConnectorsOutboundConnectorEndpoint[]
    Array of server endpoints to use when connecting with the LDAP bind account.
    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
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    passwordSecretId string
    The OCID of the password for the LDAP bind account in the Vault.
    passwordSecretVersion number
    Version of the password secret in the Vault to use.
    state string
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    timeCreated string
    The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availability_domain str
    The name of the availability domain. Example: Uocm:PHX-AD-1
    bind_distinguished_name str
    The LDAP Distinguished Name of the account.
    compartment_id str
    The OCID of the compartment.
    connector_type str
    The account type of this outbound 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"}
    display_name str
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    endpoints Sequence[filestorage.GetOutboundConnectorsOutboundConnectorEndpoint]
    Array of server endpoints to use when connecting with the LDAP bind account.
    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
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    password_secret_id str
    The OCID of the password for the LDAP bind account in the Vault.
    password_secret_version int
    Version of the password secret in the Vault to use.
    state str
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    time_created str
    The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    bindDistinguishedName String
    The LDAP Distinguished Name of the account.
    compartmentId String
    The OCID of the compartment.
    connectorType String
    The account type of this outbound 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"}
    displayName String
    A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource
    endpoints List<Property Map>
    Array of server endpoints to use when connecting with the LDAP bind account.
    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
    Filter results by OCID. Must be an OCID of the correct type for the resouce type.
    passwordSecretId String
    The OCID of the password for the LDAP bind account in the Vault.
    passwordSecretVersion Number
    Version of the password secret in the Vault to use.
    state String
    Filter results by the specified lifecycle state. Must be a valid state for the resource type.
    timeCreated String
    The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    GetOutboundConnectorsOutboundConnectorEndpoint

    Hostname string
    Name of the DNS server.
    Port string
    Port of the DNS server.
    Hostname string
    Name of the DNS server.
    Port string
    Port of the DNS server.
    hostname String
    Name of the DNS server.
    port String
    Port of the DNS server.
    hostname string
    Name of the DNS server.
    port string
    Port of the DNS server.
    hostname str
    Name of the DNS server.
    port str
    Port of the DNS server.
    hostname String
    Name of the DNS server.
    port String
    Port of the DNS server.

    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.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci