oci.Core.getCrossConnectGroups
Explore with Pulumi AI
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 System.Linq;
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:
- Compartment
Id string The OCID of the compartment.
- Display
Name string A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Cross Connect Groups Filter> - State string
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Compartment
Id string The OCID of the compartment.
- Display
Name string A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Cross Connect Groups Filter - State string
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id String The OCID of the compartment.
- display
Name String A filter to return only resources that match the given display name exactly.
- filters
List<Get
Cross Connect Groups Filter> - state String
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id string The OCID of the compartment.
- display
Name string A filter to return only resources that match the given display name exactly.
- filters
Get
Cross Connect Groups Filter[] - 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
Get
Cross Connect Groups Filter] - state str
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id String The OCID of the compartment.
- display
Name 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:
- Compartment
Id string The OCID of the compartment containing the cross-connect group.
- Cross
Connect List<GetGroups Cross Connect Groups Cross Connect Group> The list of cross_connect_groups.
- Id string
The provider-assigned unique ID for this managed resource.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
List<Get
Cross Connect Groups Filter> - State string
The cross-connect group's current state.
- Compartment
Id string The OCID of the compartment containing the cross-connect group.
- Cross
Connect []GetGroups Cross Connect Groups Cross Connect Group The list of cross_connect_groups.
- Id string
The provider-assigned unique ID for this managed resource.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
[]Get
Cross Connect Groups Filter - State string
The cross-connect group's current state.
- compartment
Id String The OCID of the compartment containing the cross-connect group.
- cross
Connect List<GetGroups Cross Connect Groups Cross Connect Group> The list of cross_connect_groups.
- id String
The provider-assigned unique ID for this managed resource.
- display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
List<Get
Cross Connect Groups Filter> - state String
The cross-connect group's current state.
- compartment
Id string The OCID of the compartment containing the cross-connect group.
- cross
Connect GetGroups Cross Connect Groups Cross Connect Group[] The list of cross_connect_groups.
- id string
The provider-assigned unique ID for this managed resource.
- display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Cross Connect Groups Filter[] - state string
The cross-connect group's current state.
- compartment_
id str The OCID of the compartment containing the cross-connect group.
- cross_
connect_ Getgroups Cross Connect Groups Cross Connect Group] 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
Get
Cross Connect Groups Filter] - state str
The cross-connect group's current state.
- compartment
Id String The OCID of the compartment containing the cross-connect group.
- cross
Connect List<Property Map>Groups The list of cross_connect_groups.
- id String
The provider-assigned unique ID for this managed resource.
- display
Name 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
- Compartment
Id string The OCID of the compartment.
- Customer
Reference stringName A reference name or identifier for the physical fiber connection that this cross-connect group uses.
- 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"}
- Display
Name string A filter to return only resources that match the given display name exactly.
- 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).
- Macsec
Properties List<GetCross Connect Groups Cross Connect Group Macsec Property> Properties used for MACsec (if capable).
- Oci
Logical stringDevice Name The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- Oci
Physical stringDevice Name 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.
- Time
Created 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 string The OCID of the compartment.
- Customer
Reference stringName A reference name or identifier for the physical fiber connection that this cross-connect group uses.
- 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"}
- Display
Name string A filter to return only resources that match the given display name exactly.
- 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).
- Macsec
Properties []GetCross Connect Groups Cross Connect Group Macsec Property Properties used for MACsec (if capable).
- Oci
Logical stringDevice Name The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- Oci
Physical stringDevice Name 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.
- Time
Created 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 String The OCID of the compartment.
- customer
Reference StringName A reference name or identifier for the physical fiber connection that this cross-connect group uses.
- 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"}
- display
Name String A filter to return only resources that match the given display name exactly.
- 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).
- macsec
Properties List<GetCross Connect Groups Cross Connect Group Macsec Property> Properties used for MACsec (if capable).
- oci
Logical StringDevice Name The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- oci
Physical StringDevice Name 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.
- time
Created 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 string The OCID of the compartment.
- customer
Reference stringName A reference name or identifier for the physical fiber connection that this cross-connect group uses.
- {[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"}
- display
Name string A filter to return only resources that match the given display name exactly.
- {[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).
- macsec
Properties GetCross Connect Groups Cross Connect Group Macsec Property[] Properties used for MACsec (if capable).
- oci
Logical stringDevice Name The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- oci
Physical stringDevice Name 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.
- time
Created 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_ strname A reference name or identifier for the physical fiber connection that this cross-connect group uses.
- 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.
- 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 GetCross Connect Groups Cross Connect Group Macsec Property] Properties used for MACsec (if capable).
- oci_
logical_ strdevice_ name The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- oci_
physical_ strdevice_ name 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
- compartment
Id String The OCID of the compartment.
- customer
Reference StringName A reference name or identifier for the physical fiber connection that this cross-connect group uses.
- 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"}
- display
Name String A filter to return only resources that match the given display name exactly.
- 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).
- macsec
Properties List<Property Map> Properties used for MACsec (if capable).
- oci
Logical StringDevice Name The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- oci
Physical StringDevice Name 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.
- time
Created 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
- Encryption
Cipher string Type of encryption cipher suite to use for the MACsec connection.
- Is
Unprotected boolTraffic Allowed Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
- Primary
Keys List<GetCross Connect Groups Cross Connect Group Macsec Property Primary Key> 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 string Type of encryption cipher suite to use for the MACsec connection.
- Is
Unprotected boolTraffic Allowed Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
- Primary
Keys []GetCross Connect Groups Cross Connect Group Macsec Property Primary Key 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 String Type of encryption cipher suite to use for the MACsec connection.
- is
Unprotected BooleanTraffic Allowed Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
- primary
Keys List<GetCross Connect Groups Cross Connect Group Macsec Property Primary Key> 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 string Type of encryption cipher suite to use for the MACsec connection.
- is
Unprotected booleanTraffic Allowed Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
- primary
Keys GetCross Connect Groups Cross Connect Group Macsec Property Primary Key[] 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.
- is_
unprotected_ booltraffic_ allowed Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
- primary_
keys GetCross Connect Groups Cross Connect Group Macsec Property Primary Key] 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.
- encryption
Cipher String Type of encryption cipher suite to use for the MACsec connection.
- is
Unprotected BooleanTraffic Allowed Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.
- primary
Keys 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
- Connectivity
Association stringKey Secret Id Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
- Connectivity
Association stringKey Secret Version The secret version of the
connectivityAssociationKey
secret in Vault.- Connectivity
Association stringName Secret Id Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
- Connectivity
Association stringName Secret Version The secret version of the connectivity association name secret in Vault.
- Connectivity
Association stringKey Secret Id Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
- Connectivity
Association stringKey Secret Version The secret version of the
connectivityAssociationKey
secret in Vault.- Connectivity
Association stringName Secret Id Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
- Connectivity
Association stringName Secret Version The secret version of the connectivity association name secret in Vault.
- connectivity
Association StringKey Secret Id Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
- connectivity
Association StringKey Secret Version The secret version of the
connectivityAssociationKey
secret in Vault.- connectivity
Association StringName Secret Id Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
- connectivity
Association StringName Secret Version The secret version of the connectivity association name secret in Vault.
- connectivity
Association stringKey Secret Id Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
- connectivity
Association stringKey Secret Version The secret version of the
connectivityAssociationKey
secret in Vault.- connectivity
Association stringName Secret Id Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
- connectivity
Association stringName Secret Version The secret version of the connectivity association name secret in Vault.
- connectivity_
association_ strkey_ secret_ id Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
- connectivity_
association_ strkey_ secret_ version The secret version of the
connectivityAssociationKey
secret in Vault.- connectivity_
association_ strname_ secret_ id Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
- connectivity_
association_ strname_ secret_ version The secret version of the connectivity association name secret in Vault.
- connectivity
Association StringKey Secret Id Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.
- connectivity
Association StringKey Secret Version The secret version of the
connectivityAssociationKey
secret in Vault.- connectivity
Association StringName Secret Id Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.
- connectivity
Association StringName Secret Version The secret version of the connectivity association name secret in Vault.
GetCrossConnectGroupsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.