Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.Core.getCrossConnectGroups

This data source provides the list of Cross Connect Groups in Oracle Cloud Infrastructure Core service.

Lists the cross-connect groups in the specified compartment.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCrossConnectGroups = Oci.Core.GetCrossConnectGroups.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Cross_connect_group_display_name,
        State = @var.Cross_connect_group_state,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.GetCrossConnectGroups(ctx, &core.GetCrossConnectGroupsArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Cross_connect_group_display_name),
			State:         pulumi.StringRef(_var.Cross_connect_group_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.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetCrossConnectGroupsArgs;
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 testCrossConnectGroups = CoreFunctions.getCrossConnectGroups(GetCrossConnectGroupsArgs.builder()
            .compartmentId(var_.compartment_id())
            .displayName(var_.cross_connect_group_display_name())
            .state(var_.cross_connect_group_state())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_cross_connect_groups = oci.Core.get_cross_connect_groups(compartment_id=var["compartment_id"],
    display_name=var["cross_connect_group_display_name"],
    state=var["cross_connect_group_state"])

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

const testCrossConnectGroups = oci.Core.getCrossConnectGroups({
    compartmentId: _var.compartment_id,
    displayName: _var.cross_connect_group_display_name,
    state: _var.cross_connect_group_state,
});

variables:
  testCrossConnectGroups:
    fn::invoke:
      Function: oci:Core:getCrossConnectGroups
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.cross_connect_group_display_name}
        state: ${var.cross_connect_group_state}

Using getCrossConnectGroups

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 getCrossConnectGroups(args: GetCrossConnectGroupsArgs, opts?: InvokeOptions): Promise<GetCrossConnectGroupsResult>
function getCrossConnectGroupsOutput(args: GetCrossConnectGroupsOutputArgs, opts?: InvokeOptions): Output<GetCrossConnectGroupsResult>

def get_cross_connect_groups(compartment_id: Optional[str] = None,
                             display_name: Optional[str] = None,
                             filters: Optional[Sequence[_core.GetCrossConnectGroupsFilter]] = None,
                             state: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCrossConnectGroupsResult
def get_cross_connect_groups_output(compartment_id: Optional[pulumi.Input[str]] = None,
                             display_name: Optional[pulumi.Input[str]] = None,
                             filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetCrossConnectGroupsFilterArgs]]]] = None,
                             state: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCrossConnectGroupsResult]

func GetCrossConnectGroups(ctx *Context, args *GetCrossConnectGroupsArgs, opts ...InvokeOption) (*GetCrossConnectGroupsResult, error)
func GetCrossConnectGroupsOutput(ctx *Context, args *GetCrossConnectGroupsOutputArgs, opts ...InvokeOption) GetCrossConnectGroupsResultOutput

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

public static class GetCrossConnectGroups 
{
    public static Task<GetCrossConnectGroupsResult> InvokeAsync(GetCrossConnectGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetCrossConnectGroupsResult> Invoke(GetCrossConnectGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCrossConnectGroupsResult> getCrossConnectGroups(GetCrossConnectGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Core/getCrossConnectGroups:getCrossConnectGroups
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetCrossConnectGroupsFilter>
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

CompartmentId string: The OCID of the compartment.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetCrossConnectGroupsFilter
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String: The OCID of the compartment.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetCrossConnectGroupsFilter>
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId string: The OCID of the compartment.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetCrossConnectGroupsFilter[]
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartment_id str: The OCID of the compartment.
display_name str: A filter to return only resources that match the given display name exactly.
filters GetCrossConnectGroupsFilter]
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String: The OCID of the compartment.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

getCrossConnectGroups Result

The following output properties are available:

CompartmentId string: The OCID of the compartment containing the cross-connect group.
CrossConnectGroups List<GetCrossConnectGroupsCrossConnectGroup>: The list of cross_connect_groups.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetCrossConnectGroupsFilter>
State string: The cross-connect group's current state.

CompartmentId string: The OCID of the compartment containing the cross-connect group.
CrossConnectGroups []GetCrossConnectGroupsCrossConnectGroup: The list of cross_connect_groups.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetCrossConnectGroupsFilter
State string: The cross-connect group's current state.

compartmentId String: The OCID of the compartment containing the cross-connect group.
crossConnectGroups List<GetCrossConnectGroupsCrossConnectGroup>: The list of cross_connect_groups.
id String: The provider-assigned unique ID for this managed resource.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetCrossConnectGroupsFilter>
state String: The cross-connect group's current state.

compartmentId string: The OCID of the compartment containing the cross-connect group.
crossConnectGroups GetCrossConnectGroupsCrossConnectGroup[]: The list of cross_connect_groups.
id string: The provider-assigned unique ID for this managed resource.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetCrossConnectGroupsFilter[]
state string: The cross-connect group's current state.

compartment_id str: The OCID of the compartment containing the cross-connect group.
cross_connect_groups GetCrossConnectGroupsCrossConnectGroup]: The list of cross_connect_groups.
id str: The provider-assigned unique ID for this managed resource.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetCrossConnectGroupsFilter]
state str: The cross-connect group's current state.

compartmentId String: The OCID of the compartment containing the cross-connect group.
crossConnectGroups List<Property Map>: The list of cross_connect_groups.
id String: The provider-assigned unique ID for this managed resource.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<Property Map>
state String: The cross-connect group's current state.

Supporting Types

GetCrossConnectGroupsCrossConnectGroup

CompartmentId string: The OCID of the compartment.
CustomerReferenceName string: A reference name or identifier for the physical fiber connection that this cross-connect group uses.
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 filter to return only resources that match the given display name exactly.
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 cross-connect group's Oracle ID (OCID).
MacsecProperties List<GetCrossConnectGroupsCrossConnectGroupMacsecProperty>: Properties used for MACsec (if capable).
OciLogicalDeviceName string: The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
OciPhysicalDeviceName string: The FastConnect device that terminates the physical connection.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TimeCreated string: The date and time the cross-connect group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

CompartmentId string: The OCID of the compartment.
CustomerReferenceName string: A reference name or identifier for the physical fiber connection that this cross-connect group uses.
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 filter to return only resources that match the given display name exactly.
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 cross-connect group's Oracle ID (OCID).
MacsecProperties []GetCrossConnectGroupsCrossConnectGroupMacsecProperty: Properties used for MACsec (if capable).
OciLogicalDeviceName string: The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
OciPhysicalDeviceName string: The FastConnect device that terminates the physical connection.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TimeCreated string: The date and time the cross-connect group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String: The OCID of the compartment.
customerReferenceName String: A reference name or identifier for the physical fiber connection that this cross-connect group uses.
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 filter to return only resources that match the given display name exactly.
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 cross-connect group's Oracle ID (OCID).
macsecProperties List<GetCrossConnectGroupsCrossConnectGroupMacsecProperty>: Properties used for MACsec (if capable).
ociLogicalDeviceName String: The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
ociPhysicalDeviceName String: The FastConnect device that terminates the physical connection.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated String: The date and time the cross-connect group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId string: The OCID of the compartment.
customerReferenceName string: A reference name or identifier for the physical fiber connection that this cross-connect group uses.
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 filter to return only resources that match the given display name exactly.
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 cross-connect group's Oracle ID (OCID).
macsecProperties GetCrossConnectGroupsCrossConnectGroupMacsecProperty[]: Properties used for MACsec (if capable).
ociLogicalDeviceName string: The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
ociPhysicalDeviceName string: The FastConnect device that terminates the physical connection.
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated string: The date and time the cross-connect group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartment_id str: The OCID of the compartment.
customer_reference_name str: A reference name or identifier for the physical fiber connection that this cross-connect group uses.
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 filter to return only resources that match the given display name exactly.
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 cross-connect group's Oracle ID (OCID).
macsec_properties GetCrossConnectGroupsCrossConnectGroupMacsecProperty]: Properties used for MACsec (if capable).
oci_logical_device_name str: The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
oci_physical_device_name str: The FastConnect device that terminates the physical connection.
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
time_created str: The date and time the cross-connect group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String: The OCID of the compartment.
customerReferenceName String: A reference name or identifier for the physical fiber connection that this cross-connect group uses.
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 filter to return only resources that match the given display name exactly.
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 cross-connect group's Oracle ID (OCID).
macsecProperties List<Property Map>: Properties used for MACsec (if capable).
ociLogicalDeviceName String: The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
ociPhysicalDeviceName String: The FastConnect device that terminates the physical connection.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
timeCreated String: The date and time the cross-connect group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

GetCrossConnectGroupsCrossConnectGroupMacsecProperty

EncryptionCipher string: Type of encryption cipher suite to use for the MACsec connection.
PrimaryKeys List<GetCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey>: An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

EncryptionCipher string: Type of encryption cipher suite to use for the MACsec connection.
PrimaryKeys []GetCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey: An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

encryptionCipher String: Type of encryption cipher suite to use for the MACsec connection.
primaryKeys List<GetCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey>: An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

encryptionCipher string: Type of encryption cipher suite to use for the MACsec connection.
primaryKeys GetCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey[]: An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

encryption_cipher str: Type of encryption cipher suite to use for the MACsec connection.
primary_keys GetCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey]: An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

encryptionCipher String: Type of encryption cipher suite to use for the MACsec connection.
primaryKeys List<Property Map>: An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

GetCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey

ConnectivityAssociationKeySecretId string: Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
ConnectivityAssociationKeySecretVersion string: The secret version of the connectivityAssociationKey secret in Vault.
ConnectivityAssociationNameSecretId string: Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
ConnectivityAssociationNameSecretVersion string: The secret version of the connectivity association name secret in Vault.

ConnectivityAssociationKeySecretId string: Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
ConnectivityAssociationKeySecretVersion string: The secret version of the connectivityAssociationKey secret in Vault.
ConnectivityAssociationNameSecretId string: Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
ConnectivityAssociationNameSecretVersion string: The secret version of the connectivity association name secret in Vault.

connectivityAssociationKeySecretId String: Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
connectivityAssociationKeySecretVersion String: The secret version of the connectivityAssociationKey secret in Vault.
connectivityAssociationNameSecretId String: Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
connectivityAssociationNameSecretVersion String: The secret version of the connectivity association name secret in Vault.

connectivityAssociationKeySecretId string: Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
connectivityAssociationKeySecretVersion string: The secret version of the connectivityAssociationKey secret in Vault.
connectivityAssociationNameSecretId string: Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
connectivityAssociationNameSecretVersion string: The secret version of the connectivity association name secret in Vault.

connectivity_association_key_secret_id str: Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
connectivity_association_key_secret_version str: The secret version of the connectivityAssociationKey secret in Vault.
connectivity_association_name_secret_id str: Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
connectivity_association_name_secret_version str: The secret version of the connectivity association name secret in Vault.

connectivityAssociationKeySecretId String: Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
connectivityAssociationKeySecretVersion String: The secret version of the connectivityAssociationKey secret in Vault.
connectivityAssociationNameSecretId String: Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
connectivityAssociationNameSecretVersion String: The secret version of the connectivity association name secret in Vault.

GetCrossConnectGroupsFilter

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

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.