Get-OCIGoldengateConnectionsList

SYNOPSIS

Invokes GoldenGate service - ListConnections operation.

SYNTAX

Limit

Get-OCIGoldengateConnectionsList -CompartmentId <String> [-TechnologyType <System.Collections.Generic.List`1[Oci.GoldengateService.Models.TechnologyType]>] [-ConnectionType <System.Collections.Generic.List`1[Oci.GoldengateService.Models.ConnectionType]>] [-AssignedDeploymentId <String>] [-AssignableDeploymentId <String>] [-AssignableDeploymentType <DeploymentType>] [-LifecycleState <LifecycleStateEnum>] [-DisplayName <String>] [-Limit <Int32>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIGoldengateConnectionsList -CompartmentId <String> [-TechnologyType <System.Collections.Generic.List`1[Oci.GoldengateService.Models.TechnologyType]>] [-ConnectionType <System.Collections.Generic.List`1[Oci.GoldengateService.Models.ConnectionType]>] [-AssignedDeploymentId <String>] [-AssignableDeploymentId <String>] [-AssignableDeploymentType <DeploymentType>] [-LifecycleState <LifecycleStateEnum>] [-DisplayName <String>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Lists the Connections in the compartment.

PARAMETERS

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AssignableDeploymentId

Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AssignableDeploymentType

Filters for connections which can be assigned to the latest version of the specified deployment type.

Type: DeploymentType
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Ogg, DatabaseOracle, Bigdata, DatabaseMicrosoftSqlserver, DatabaseMysql, DatabasePostgresql, DatabaseDb2Zos, DatabaseDb2I, Ggsa, DataTransforms

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AssignedDeploymentId

The OCID of the deployment which for the connection must be assigned.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CompartmentId

The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigFile

The path to the config file.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConnectionType

The array of connection types.

Type: System.Collections.Generic.List`1[Oci.GoldengateService.Models.ConnectionType]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Goldengate, Kafka, KafkaSchemaRegistry, Mysql, JavaMessageService, MicrosoftSqlserver, OciObjectStorage, Oracle, AzureDataLakeStorage, Postgresql, AzureSynapseAnalytics, Snowflake, AmazonS3, Hdfs, OracleAiDataPlatform, OracleNosql, Mongodb, AmazonKinesis, AmazonRedshift, Db2, Redis, Elasticsearch, Generic, GoogleCloudStorage, GoogleBigquery, Databricks, GooglePubsub, MicrosoftFabric, Iceberg

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DisplayName

A filter to return only the resources that match the entire 'displayName' given.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LifecycleState

A filter to return only connections having the 'lifecycleState' given.

Type: LifecycleStateEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Creating, Updating, Active, Deleting, Deleted, Failed

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

The maximum number of items to return.

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OpcRequestId

The client request ID for tracing.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortBy

The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: TimeCreated, DisplayName

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortOrder

The sort order to use, either 'asc' or 'desc'.

Type: SortOrder
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TechnologyType

The array of technology types.

Type: System.Collections.Generic.List`1[Oci.GoldengateService.Models.TechnologyType]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Goldengate, Generic, OciAutonomousDatabase, OciAutonomousJsonDatabase, OciCacheWithRedis, OciMysql, OciObjectStorage, OciPostgresql, OciStreaming, OciStreamingWithApacheKafka, OracleDatabase, OracleExadata, OracleExadataDatabaseAtAzure, OracleAutonomousDatabaseAtAzure, OracleJsonCollection, OracleExadataDatabaseAtGoogleCloud, OracleAutonomousDatabaseAtGoogleCloud, OracleExadataDatabaseAtAws, OracleAutonomousDatabaseAtAws, OracleAiDataPlatform, OracleNosql, OracleRestDataServices, OracleWeblogicJms, AmazonRdsOracle, AmazonRdsSqlserver, AmazonS3, AmazonAuroraMysql, AmazonAuroraPostgresql, AmazonDocumentDb, AmazonKinesis, AmazonRedshift, AmazonRdsMariadb, AmazonRdsMysql, AmazonRdsPostgresql, ApacheIceberg, ApacheKafka, AzureCosmosDbForMongodb, AzureCosmosDbForPostgresql, AzureDataLakeStorage, AzureEventHubs, AzureMysql, AzurePostgresql, AzureSqlserverManagedInstance, AzureSqlserverNonManagedInstance, AzureSynapseAnalytics, ConfluentKafka, ConfluentSchemaRegistry, Databricks, Db2I, Db2Zos, Elasticsearch, GoogleAlloyDbForPostgresql, GoogleBigquery, GoogleCloudStorage, GoogleCloudSqlMysql, GoogleCloudSqlPostgresql, GoogleCloudSqlSqlserver, GooglePubsub, Hdfs, Mariadb, MicrosoftSqlserver, MicrosoftFabricLakehouse, MicrosoftFabricMirror, Mongodb, MysqlServer, MysqlHeatwaveOnAzure, MysqlHeatwaveOnAws, PostgresqlServer, Redis, Singlestoredb, SinglestoredbCloud, Snowflake

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

OUTPUTS

• Oci.GoldengateService.Models.ConnectionCollection
• Oci.GoldengateService.Responses.ListConnectionsResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples