Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CloudMigrations
  5. getMigrations
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.CloudMigrations.getMigrations

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides the list of Migrations in Oracle Cloud Infrastructure Cloud Migrations service.

Returns a list of migrations.

Example Usage

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

const testMigrations = oci.CloudMigrations.getMigrations({
    compartmentId: compartmentId,
    displayName: migrationDisplayName,
    migrationId: testMigration.id,
    state: migrationState,
});
Copy
import pulumi
import pulumi_oci as oci

test_migrations = oci.CloudMigrations.get_migrations(compartment_id=compartment_id,
    display_name=migration_display_name,
    migration_id=test_migration["id"],
    state=migration_state)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudmigrations.GetMigrations(ctx, &cloudmigrations.GetMigrationsArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(migrationDisplayName),
			MigrationId:   pulumi.StringRef(testMigration.Id),
			State:         pulumi.StringRef(migrationState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testMigrations = Oci.CloudMigrations.GetMigrations.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = migrationDisplayName,
        MigrationId = testMigration.Id,
        State = migrationState,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.CloudMigrations.CloudMigrationsFunctions;
import com.pulumi.oci.CloudMigrations.inputs.GetMigrationsArgs;
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 testMigrations = CloudMigrationsFunctions.getMigrations(GetMigrationsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(migrationDisplayName)
            .migrationId(testMigration.id())
            .state(migrationState)
            .build());

    }
}
Copy
variables:
  testMigrations:
    fn::invoke:
      function: oci:CloudMigrations:getMigrations
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${migrationDisplayName}
        migrationId: ${testMigration.id}
        state: ${migrationState}
Copy

Using getMigrations

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 getMigrations(args: GetMigrationsArgs, opts?: InvokeOptions): Promise<GetMigrationsResult>
function getMigrationsOutput(args: GetMigrationsOutputArgs, opts?: InvokeOptions): Output<GetMigrationsResult>
Copy
def get_migrations(compartment_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   filters: Optional[Sequence[_cloudmigrations.GetMigrationsFilter]] = None,
                   migration_id: Optional[str] = None,
                   state: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetMigrationsResult
def get_migrations_output(compartment_id: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_cloudmigrations.GetMigrationsFilterArgs]]]] = None,
                   migration_id: Optional[pulumi.Input[str]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetMigrationsResult]
Copy
func GetMigrations(ctx *Context, args *GetMigrationsArgs, opts ...InvokeOption) (*GetMigrationsResult, error)
func GetMigrationsOutput(ctx *Context, args *GetMigrationsOutputArgs, opts ...InvokeOption) GetMigrationsResultOutput
Copy

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

public static class GetMigrations 
{
    public static Task<GetMigrationsResult> InvokeAsync(GetMigrationsArgs args, InvokeOptions? opts = null)
    public static Output<GetMigrationsResult> Invoke(GetMigrationsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMigrationsResult> getMigrations(GetMigrationsArgs args, InvokeOptions options)
public static Output<GetMigrationsResult> getMigrations(GetMigrationsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:CloudMigrations/getMigrations:getMigrations
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire given display name.
Filters Changes to this property will trigger replacement. List<GetMigrationsFilter>
MigrationId string
Unique migration identifier
State string
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
CompartmentId string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire given display name.
Filters Changes to this property will trigger replacement. []GetMigrationsFilter
MigrationId string
Unique migration identifier
State string
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
compartmentId String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire given display name.
filters Changes to this property will trigger replacement. List<GetMigrationsFilter>
migrationId String
Unique migration identifier
state String
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
compartmentId string
The ID of the compartment in which to list resources.
displayName string
A filter to return only resources that match the entire given display name.
filters Changes to this property will trigger replacement. GetMigrationsFilter[]
migrationId string
Unique migration identifier
state string
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
compartment_id str
The ID of the compartment in which to list resources.
display_name str
A filter to return only resources that match the entire given display name.
filters Changes to this property will trigger replacement. Sequence[cloudmigrations.GetMigrationsFilter]
migration_id str
Unique migration identifier
state str
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
compartmentId String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire given display name.
filters Changes to this property will trigger replacement. List<Property Map>
migrationId String
Unique migration identifier
state String
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.

getMigrations Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
MigrationCollections List<GetMigrationsMigrationCollection>
The list of migration_collection.
CompartmentId string
Compartment Identifier
DisplayName string
Migration Identifier that can be renamed
Filters List<GetMigrationsFilter>
MigrationId string
State string
The current state of migration.
Id string
The provider-assigned unique ID for this managed resource.
MigrationCollections []GetMigrationsMigrationCollection
The list of migration_collection.
CompartmentId string
Compartment Identifier
DisplayName string
Migration Identifier that can be renamed
Filters []GetMigrationsFilter
MigrationId string
State string
The current state of migration.
id String
The provider-assigned unique ID for this managed resource.
migrationCollections List<GetMigrationsMigrationCollection>
The list of migration_collection.
compartmentId String
Compartment Identifier
displayName String
Migration Identifier that can be renamed
filters List<GetMigrationsFilter>
migrationId String
state String
The current state of migration.
id string
The provider-assigned unique ID for this managed resource.
migrationCollections GetMigrationsMigrationCollection[]
The list of migration_collection.
compartmentId string
Compartment Identifier
displayName string
Migration Identifier that can be renamed
filters GetMigrationsFilter[]
migrationId string
state string
The current state of migration.
id str
The provider-assigned unique ID for this managed resource.
migration_collections Sequence[cloudmigrations.GetMigrationsMigrationCollection]
The list of migration_collection.
compartment_id str
Compartment Identifier
display_name str
Migration Identifier that can be renamed
filters Sequence[cloudmigrations.GetMigrationsFilter]
migration_id str
state str
The current state of migration.
id String
The provider-assigned unique ID for this managed resource.
migrationCollections List<Property Map>
The list of migration_collection.
compartmentId String
Compartment Identifier
displayName String
Migration Identifier that can be renamed
filters List<Property Map>
migrationId String
state String
The current state of migration.

Supporting Types

GetMigrationsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetMigrationsMigrationCollection

items This property is required. List<Property Map>

GetMigrationsMigrationCollectionItem

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only resources that match the entire given display name.
FreeformTags This property is required. Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"}
Id This property is required. string
Unique identifier that is immutable on creation
IsCompleted This property is required. bool
Indicates whether migration is marked as completed.
LifecycleDetails This property is required. string
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
ReplicationScheduleId This property is required. string
Replication schedule identifier
State This property is required. string
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
SystemTags This property is required. Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The time when the migration project was created. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time when the migration project was updated. An RFC3339 formatted datetime string
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only resources that match the entire given display name.
FreeformTags This property is required. map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"}
Id This property is required. string
Unique identifier that is immutable on creation
IsCompleted This property is required. bool
Indicates whether migration is marked as completed.
LifecycleDetails This property is required. string
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
ReplicationScheduleId This property is required. string
Replication schedule identifier
State This property is required. string
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
SystemTags This property is required. map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The time when the migration project was created. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time when the migration project was updated. An RFC3339 formatted datetime string
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only resources that match the entire given display name.
freeformTags This property is required. Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"}
id This property is required. String
Unique identifier that is immutable on creation
isCompleted This property is required. Boolean
Indicates whether migration is marked as completed.
lifecycleDetails This property is required. String
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
replicationScheduleId This property is required. String
Replication schedule identifier
state This property is required. String
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
systemTags This property is required. Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The time when the migration project was created. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time when the migration project was updated. An RFC3339 formatted datetime string
compartmentId This property is required. string
The ID of the compartment in which to list resources.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. string
A filter to return only resources that match the entire given display name.
freeformTags This property is required. {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"}
id This property is required. string
Unique identifier that is immutable on creation
isCompleted This property is required. boolean
Indicates whether migration is marked as completed.
lifecycleDetails This property is required. string
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
replicationScheduleId This property is required. string
Replication schedule identifier
state This property is required. string
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
systemTags This property is required. {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. string
The time when the migration project was created. An RFC3339 formatted datetime string
timeUpdated This property is required. string
The time when the migration project was updated. An RFC3339 formatted datetime string
compartment_id This property is required. str
The ID of the compartment in which to list resources.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name This property is required. str
A filter to return only resources that match the entire given display name.
freeform_tags This property is required. Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"}
id This property is required. str
Unique identifier that is immutable on creation
is_completed This property is required. bool
Indicates whether migration is marked as completed.
lifecycle_details This property is required. str
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
replication_schedule_id This property is required. str
Replication schedule identifier
state This property is required. str
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
system_tags This property is required. Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created This property is required. str
The time when the migration project was created. An RFC3339 formatted datetime string
time_updated This property is required. str
The time when the migration project was updated. An RFC3339 formatted datetime string
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only resources that match the entire given display name.
freeformTags This property is required. Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {"bar-key": "value"}
id This property is required. String
Unique identifier that is immutable on creation
isCompleted This property is required. Boolean
Indicates whether migration is marked as completed.
lifecycleDetails This property is required. String
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
replicationScheduleId This property is required. String
Replication schedule identifier
state This property is required. String
A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
systemTags This property is required. Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The time when the migration project was created. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time when the migration project was updated. An RFC3339 formatted datetime string

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci