Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. dbforpostgresql
  5. getMigration
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.dbforpostgresql.getMigration

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets details of a migration. Azure REST API version: 2023-03-01-preview.

    Other available API versions: 2021-06-15-privatepreview, 2022-05-01-preview, 2023-06-01-preview, 2023-12-01-preview, 2024-03-01-preview, 2024-08-01, 2024-11-01-preview.

    Using getMigration

    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 getMigration(args: GetMigrationArgs, opts?: InvokeOptions): Promise<GetMigrationResult>
function getMigrationOutput(args: GetMigrationOutputArgs, opts?: InvokeOptions): Output<GetMigrationResult>
    def get_migration(migration_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  subscription_id: Optional[str] = None,
                  target_db_server_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetMigrationResult
def get_migration_output(migration_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  subscription_id: Optional[pulumi.Input[str]] = None,
                  target_db_server_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetMigrationResult]
    func LookupMigration(ctx *Context, args *LookupMigrationArgs, opts ...InvokeOption) (*LookupMigrationResult, error)
func LookupMigrationOutput(ctx *Context, args *LookupMigrationOutputArgs, opts ...InvokeOption) LookupMigrationResultOutput

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

    public static class GetMigration 
{
    public static Task<GetMigrationResult> InvokeAsync(GetMigrationArgs args, InvokeOptions? opts = null)
    public static Output<GetMigrationResult> Invoke(GetMigrationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMigrationResult> getMigration(GetMigrationArgs args, InvokeOptions options)
public static Output<GetMigrationResult> getMigration(GetMigrationArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:dbforpostgresql:getMigration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    MigrationName string
    The name of the migration.
    ResourceGroupName string
    The resource group name of the target database server.
    TargetDbServerName string
    The name of the target database server.
    SubscriptionId string
    The subscription ID of the target database server.
    MigrationName string
    The name of the migration.
    ResourceGroupName string
    The resource group name of the target database server.
    TargetDbServerName string
    The name of the target database server.
    SubscriptionId string
    The subscription ID of the target database server.
    migrationName String
    The name of the migration.
    resourceGroupName String
    The resource group name of the target database server.
    targetDbServerName String
    The name of the target database server.
    subscriptionId String
    The subscription ID of the target database server.
    migrationName string
    The name of the migration.
    resourceGroupName string
    The resource group name of the target database server.
    targetDbServerName string
    The name of the target database server.
    subscriptionId string
    The subscription ID of the target database server.
    migration_name str
    The name of the migration.
    resource_group_name str
    The resource group name of the target database server.
    target_db_server_name str
    The name of the target database server.
    subscription_id str
    The subscription ID of the target database server.
    migrationName String
    The name of the migration.
    resourceGroupName String
    The resource group name of the target database server.
    targetDbServerName String
    The name of the target database server.
    subscriptionId String
    The subscription ID of the target database server.

    getMigration Result

    The following output properties are available:

    CurrentStatus Pulumi.AzureNative.DBforPostgreSQL.Outputs.MigrationStatusResponse
    Current status of migration
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    MigrationId string
    ID for migration, a GUID.
    Name string
    The name of the resource
    SourceDbServerMetadata Pulumi.AzureNative.DBforPostgreSQL.Outputs.DbServerMetadataResponse
    Metadata of the source database server
    SystemData Pulumi.AzureNative.DBforPostgreSQL.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TargetDbServerMetadata Pulumi.AzureNative.DBforPostgreSQL.Outputs.DbServerMetadataResponse
    Metadata of the target database server
    TargetDbServerResourceId string
    ResourceId of the source database server
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Cancel string
    To trigger cancel for entire migration we need to send this flag as True
    DbsToCancelMigrationOn List<string>
    When you want to trigger cancel for specific databases send cancel flag as True and database names in this array
    DbsToMigrate List<string>
    Number of databases to migrate
    DbsToTriggerCutoverOn List<string>
    When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array
    MigrationMode string
    There are two types of migration modes Online and Offline
    MigrationWindowEndTimeInUtc string
    End time in UTC for migration window
    MigrationWindowStartTimeInUtc string
    Start time in UTC for migration window
    OverwriteDbsInTarget string
    Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.
    SetupLogicalReplicationOnSourceDbIfNeeded string
    Indicates whether to setup LogicalReplicationOnSourceDb, if needed
    SourceDbServerFullyQualifiedDomainName string
    Source server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    SourceDbServerResourceId string
    ResourceId of the source database server
    StartDataMigration string
    Indicates whether the data migration should start right away
    Tags Dictionary<string, string>
    Resource tags.
    TargetDbServerFullyQualifiedDomainName string
    Target server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    TriggerCutover string
    To trigger cutover for entire migration we need to send this flag as True
    CurrentStatus MigrationStatusResponse
    Current status of migration
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    MigrationId string
    ID for migration, a GUID.
    Name string
    The name of the resource
    SourceDbServerMetadata DbServerMetadataResponse
    Metadata of the source database server
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TargetDbServerMetadata DbServerMetadataResponse
    Metadata of the target database server
    TargetDbServerResourceId string
    ResourceId of the source database server
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Cancel string
    To trigger cancel for entire migration we need to send this flag as True
    DbsToCancelMigrationOn []string
    When you want to trigger cancel for specific databases send cancel flag as True and database names in this array
    DbsToMigrate []string
    Number of databases to migrate
    DbsToTriggerCutoverOn []string
    When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array
    MigrationMode string
    There are two types of migration modes Online and Offline
    MigrationWindowEndTimeInUtc string
    End time in UTC for migration window
    MigrationWindowStartTimeInUtc string
    Start time in UTC for migration window
    OverwriteDbsInTarget string
    Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.
    SetupLogicalReplicationOnSourceDbIfNeeded string
    Indicates whether to setup LogicalReplicationOnSourceDb, if needed
    SourceDbServerFullyQualifiedDomainName string
    Source server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    SourceDbServerResourceId string
    ResourceId of the source database server
    StartDataMigration string
    Indicates whether the data migration should start right away
    Tags map[string]string
    Resource tags.
    TargetDbServerFullyQualifiedDomainName string
    Target server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    TriggerCutover string
    To trigger cutover for entire migration we need to send this flag as True
    currentStatus MigrationStatusResponse
    Current status of migration
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    migrationId String
    ID for migration, a GUID.
    name String
    The name of the resource
    sourceDbServerMetadata DbServerMetadataResponse
    Metadata of the source database server
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    targetDbServerMetadata DbServerMetadataResponse
    Metadata of the target database server
    targetDbServerResourceId String
    ResourceId of the source database server
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    cancel String
    To trigger cancel for entire migration we need to send this flag as True
    dbsToCancelMigrationOn List<String>
    When you want to trigger cancel for specific databases send cancel flag as True and database names in this array
    dbsToMigrate List<String>
    Number of databases to migrate
    dbsToTriggerCutoverOn List<String>
    When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array
    migrationMode String
    There are two types of migration modes Online and Offline
    migrationWindowEndTimeInUtc String
    End time in UTC for migration window
    migrationWindowStartTimeInUtc String
    Start time in UTC for migration window
    overwriteDbsInTarget String
    Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.
    setupLogicalReplicationOnSourceDbIfNeeded String
    Indicates whether to setup LogicalReplicationOnSourceDb, if needed
    sourceDbServerFullyQualifiedDomainName String
    Source server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    sourceDbServerResourceId String
    ResourceId of the source database server
    startDataMigration String
    Indicates whether the data migration should start right away
    tags Map<String,String>
    Resource tags.
    targetDbServerFullyQualifiedDomainName String
    Target server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    triggerCutover String
    To trigger cutover for entire migration we need to send this flag as True
    currentStatus MigrationStatusResponse
    Current status of migration
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    migrationId string
    ID for migration, a GUID.
    name string
    The name of the resource
    sourceDbServerMetadata DbServerMetadataResponse
    Metadata of the source database server
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    targetDbServerMetadata DbServerMetadataResponse
    Metadata of the target database server
    targetDbServerResourceId string
    ResourceId of the source database server
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    cancel string
    To trigger cancel for entire migration we need to send this flag as True
    dbsToCancelMigrationOn string[]
    When you want to trigger cancel for specific databases send cancel flag as True and database names in this array
    dbsToMigrate string[]
    Number of databases to migrate
    dbsToTriggerCutoverOn string[]
    When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array
    migrationMode string
    There are two types of migration modes Online and Offline
    migrationWindowEndTimeInUtc string
    End time in UTC for migration window
    migrationWindowStartTimeInUtc string
    Start time in UTC for migration window
    overwriteDbsInTarget string
    Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.
    setupLogicalReplicationOnSourceDbIfNeeded string
    Indicates whether to setup LogicalReplicationOnSourceDb, if needed
    sourceDbServerFullyQualifiedDomainName string
    Source server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    sourceDbServerResourceId string
    ResourceId of the source database server
    startDataMigration string
    Indicates whether the data migration should start right away
    tags {[key: string]: string}
    Resource tags.
    targetDbServerFullyQualifiedDomainName string
    Target server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    triggerCutover string
    To trigger cutover for entire migration we need to send this flag as True
    current_status MigrationStatusResponse
    Current status of migration
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    migration_id str
    ID for migration, a GUID.
    name str
    The name of the resource
    source_db_server_metadata DbServerMetadataResponse
    Metadata of the source database server
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    target_db_server_metadata DbServerMetadataResponse
    Metadata of the target database server
    target_db_server_resource_id str
    ResourceId of the source database server
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    cancel str
    To trigger cancel for entire migration we need to send this flag as True
    dbs_to_cancel_migration_on Sequence[str]
    When you want to trigger cancel for specific databases send cancel flag as True and database names in this array
    dbs_to_migrate Sequence[str]
    Number of databases to migrate
    dbs_to_trigger_cutover_on Sequence[str]
    When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array
    migration_mode str
    There are two types of migration modes Online and Offline
    migration_window_end_time_in_utc str
    End time in UTC for migration window
    migration_window_start_time_in_utc str
    Start time in UTC for migration window
    overwrite_dbs_in_target str
    Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.
    setup_logical_replication_on_source_db_if_needed str
    Indicates whether to setup LogicalReplicationOnSourceDb, if needed
    source_db_server_fully_qualified_domain_name str
    Source server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    source_db_server_resource_id str
    ResourceId of the source database server
    start_data_migration str
    Indicates whether the data migration should start right away
    tags Mapping[str, str]
    Resource tags.
    target_db_server_fully_qualified_domain_name str
    Target server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    trigger_cutover str
    To trigger cutover for entire migration we need to send this flag as True
    currentStatus Property Map
    Current status of migration
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    migrationId String
    ID for migration, a GUID.
    name String
    The name of the resource
    sourceDbServerMetadata Property Map
    Metadata of the source database server
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    targetDbServerMetadata Property Map
    Metadata of the target database server
    targetDbServerResourceId String
    ResourceId of the source database server
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    cancel String
    To trigger cancel for entire migration we need to send this flag as True
    dbsToCancelMigrationOn List<String>
    When you want to trigger cancel for specific databases send cancel flag as True and database names in this array
    dbsToMigrate List<String>
    Number of databases to migrate
    dbsToTriggerCutoverOn List<String>
    When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array
    migrationMode String
    There are two types of migration modes Online and Offline
    migrationWindowEndTimeInUtc String
    End time in UTC for migration window
    migrationWindowStartTimeInUtc String
    Start time in UTC for migration window
    overwriteDbsInTarget String
    Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists.
    setupLogicalReplicationOnSourceDbIfNeeded String
    Indicates whether to setup LogicalReplicationOnSourceDb, if needed
    sourceDbServerFullyQualifiedDomainName String
    Source server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    sourceDbServerResourceId String
    ResourceId of the source database server
    startDataMigration String
    Indicates whether the data migration should start right away
    tags Map<String>
    Resource tags.
    targetDbServerFullyQualifiedDomainName String
    Target server fully qualified domain name or ip. It is a optional value, if customer provide it, dms will always use it for connection
    triggerCutover String
    To trigger cutover for entire migration we need to send this flag as True

    Supporting Types

    DbServerMetadataResponse

    Location string
    Location of database server
    Sku Pulumi.AzureNative.DBforPostgreSQL.Inputs.ServerSkuResponse
    SKU for the database server
    StorageMb int
    Storage size in MB for database server
    Version string
    Version for database engine
    Location string
    Location of database server
    Sku ServerSkuResponse
    SKU for the database server
    StorageMb int
    Storage size in MB for database server
    Version string
    Version for database engine
    location String
    Location of database server
    sku ServerSkuResponse
    SKU for the database server
    storageMb Integer
    Storage size in MB for database server
    version String
    Version for database engine
    location string
    Location of database server
    sku ServerSkuResponse
    SKU for the database server
    storageMb number
    Storage size in MB for database server
    version string
    Version for database engine
    location str
    Location of database server
    sku ServerSkuResponse
    SKU for the database server
    storage_mb int
    Storage size in MB for database server
    version str
    Version for database engine
    location String
    Location of database server
    sku Property Map
    SKU for the database server
    storageMb Number
    Storage size in MB for database server
    version String
    Version for database engine

    MigrationStatusResponse

    CurrentSubStateDetails Pulumi.AzureNative.DBforPostgreSQL.Inputs.MigrationSubStateDetailsResponse
    Current Migration sub state details.
    Error string
    Error message, if any, for the migration state
    State string
    State of migration
    CurrentSubStateDetails MigrationSubStateDetailsResponse
    Current Migration sub state details.
    Error string
    Error message, if any, for the migration state
    State string
    State of migration
    currentSubStateDetails MigrationSubStateDetailsResponse
    Current Migration sub state details.
    error String
    Error message, if any, for the migration state
    state String
    State of migration
    currentSubStateDetails MigrationSubStateDetailsResponse
    Current Migration sub state details.
    error string
    Error message, if any, for the migration state
    state string
    State of migration
    current_sub_state_details MigrationSubStateDetailsResponse
    Current Migration sub state details.
    error str
    Error message, if any, for the migration state
    state str
    State of migration
    currentSubStateDetails Property Map
    Current Migration sub state details.
    error String
    Error message, if any, for the migration state
    state String
    State of migration

    MigrationSubStateDetailsResponse

    CurrentSubState string
    Migration sub state.
    CurrentSubState string
    Migration sub state.
    currentSubState String
    Migration sub state.
    currentSubState string
    Migration sub state.
    current_sub_state str
    Migration sub state.
    currentSubState String
    Migration sub state.

    ServerSkuResponse

    Name string
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    Tier string
    The tier of the particular SKU, e.g. Burstable.
    Name string
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    Tier string
    The tier of the particular SKU, e.g. Burstable.
    name String
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    tier String
    The tier of the particular SKU, e.g. Burstable.
    name string
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    tier string
    The tier of the particular SKU, e.g. Burstable.
    name str
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    tier str
    The tier of the particular SKU, e.g. Burstable.
    name String
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    tier String
    The tier of the particular SKU, e.g. Burstable.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native