# PostgreSqlMigrationProxy

- Module: [Aspire.Hosting.Azure.Provisioning.PostgreSql](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql.md)
- Version: `13.6.0-preview.1.26478.8`
- Kind: `handle`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62)

Represents the PostgreSqlMigration Azure Provisioning model.

## Definition

```typescript
interface PostgreSqlMigrationProxy {
  cancel: BicepValueProxy | PostgreSqlMigrationCancel;
  readonly currentStatus: PostgreSqlMigrationStatusProxy;
  dbsToCancelMigrationOn: Aspire_Hosting_Azure_Provisioning_PostgreSql_Generated_ListOfStringProxy;
  dbsToMigrate: Aspire_Hosting_Azure_Provisioning_PostgreSql_Generated_ListOfStringProxy;
  dbsToTriggerCutoverOn: Aspire_Hosting_Azure_Provisioning_PostgreSql_Generated_ListOfStringProxy;
  readonly id: BicepValueProxy;
  location: BicepValueProxy;
  migrateRoles: BicepValueProxy | MigrateRolesEnum;
  readonly migrationId: BicepValueProxy | string;
  migrationInstanceResourceId: BicepValueProxy;
  migrationMode: BicepValueProxy | PostgreSqlMigrationMode;
  migrationOption: BicepValueProxy | MigrationOption;
  migrationWindowEndTimeInUtc: BicepValueProxy | datetimeoffset;
  migrationWindowStartTimeInUtc: BicepValueProxy | datetimeoffset;
  name: BicepValueProxy | string;
  overwriteDbsInTarget: BicepValueProxy | PostgreSqlMigrationOverwriteDbsInTarget;
  parent: PostgreSqlFlexibleServerProxy;
  secretParameters: PostgreSqlMigrationSecretParametersProxy;
  setupLogicalReplicationOnSourceDbIfNeeded: BicepValueProxy | PostgreSqlMigrationLogicalReplicationOnSourceDb;
  sourceDbServerFullyQualifiedDomainName: BicepValueProxy | string;
  readonly sourceDbServerMetadata: PostgreSqlServerMetadataProxy;
  sourceDbServerResourceId: BicepValueProxy;
  sourceType: BicepValueProxy | PostgreSqlFlexibleServersSourceType;
  sslMode: BicepValueProxy | PostgreSqlFlexibleServersSslMode;
  startDataMigration: BicepValueProxy | PostgreSqlMigrationStartDataMigration;
  readonly systemData: PostgreSqlSystemDataProxy;
  tags: Aspire_Hosting_Azure_Provisioning_PostgreSql_Generated_DictionaryOfStringProxy;
  targetDbServerFullyQualifiedDomainName: BicepValueProxy | string;
  readonly targetDbServerMetadata: PostgreSqlServerMetadataProxy;
  readonly targetDbServerResourceId: BicepValueProxy;
  triggerCutover: BicepValueProxy | PostgreSqlMigrationTriggerCutover;
  addTo(infrastructure: AzureResourceInfrastructure): void;
  clearCancel(): void;
  clearLocation(): void;
  clearMigrateRoles(): void;
  clearMigrationInstanceResourceId(): void;
  clearMigrationMode(): void;
  clearMigrationOption(): void;
  clearMigrationWindowEndTimeInUtc(): void;
  clearMigrationWindowStartTimeInUtc(): void;
  clearName(): void;
  clearOverwriteDbsInTarget(): void;
  clearSetupLogicalReplicationOnSourceDbIfNeeded(): void;
  clearSourceDbServerFullyQualifiedDomainName(): void;
  clearSourceDbServerResourceId(): void;
  clearSourceType(): void;
  clearSslMode(): void;
  clearStartDataMigration(): void;
  clearTargetDbServerFullyQualifiedDomainName(): void;
  clearTriggerCutover(): void;
}
```

## Properties

- `cancel`: `BicepValueProxy | PostgreSqlMigrationCancel` `get - set` -- Gets or sets the Cancel provisioning property.
- `currentStatus`: [PostgreSqlMigrationStatusProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationstatusproxy.md) `get` -- Gets the CurrentStatus provisioning property.
- `dbsToCancelMigrationOn`: [Aspire_Hosting_Azure_Provisioning_PostgreSql_Generated_ListOfStringProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/aspire-hosting-azure-provisioning-postgresql-generated-listofstringproxy.md) `get - set` -- Gets or sets the DbsToCancelMigrationOn provisioning property.
- `dbsToMigrate`: [Aspire_Hosting_Azure_Provisioning_PostgreSql_Generated_ListOfStringProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/aspire-hosting-azure-provisioning-postgresql-generated-listofstringproxy.md) `get - set` -- Gets or sets the DbsToMigrate provisioning property.
- `dbsToTriggerCutoverOn`: [Aspire_Hosting_Azure_Provisioning_PostgreSql_Generated_ListOfStringProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/aspire-hosting-azure-provisioning-postgresql-generated-listofstringproxy.md) `get - set` -- Gets or sets the DbsToTriggerCutoverOn provisioning property.
- `id`: `BicepValueProxy` `get` -- Gets the Id provisioning property.
- `location`: `BicepValueProxy` `get - set` -- Gets or sets the Location provisioning property.
- `migrateRoles`: `BicepValueProxy | MigrateRolesEnum` `get - set` -- Gets or sets the MigrateRoles provisioning property.
- `migrationId`: `BicepValueProxy | string` `get` -- Gets the MigrationId provisioning property.
- `migrationInstanceResourceId`: `BicepValueProxy` `get - set` -- Gets or sets the MigrationInstanceResourceId provisioning property.
- `migrationMode`: `BicepValueProxy | PostgreSqlMigrationMode` `get - set` -- Gets or sets the MigrationMode provisioning property.
- `migrationOption`: `BicepValueProxy | MigrationOption` `get - set` -- Gets or sets the MigrationOption provisioning property.
- `migrationWindowEndTimeInUtc`: `BicepValueProxy | datetimeoffset` `get - set` -- Gets or sets the MigrationWindowEndTimeInUtc provisioning property.
- `migrationWindowStartTimeInUtc`: `BicepValueProxy | datetimeoffset` `get - set` -- Gets or sets the MigrationWindowStartTimeInUtc provisioning property.
- `name`: `BicepValueProxy | string` `get - set` -- Gets or sets the Name provisioning property.
- `overwriteDbsInTarget`: `BicepValueProxy | PostgreSqlMigrationOverwriteDbsInTarget` `get - set` -- Gets or sets the OverwriteDbsInTarget provisioning property.
- `parent`: [PostgreSqlFlexibleServerProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlflexibleserverproxy.md) `get - set` -- Gets or sets the Parent provisioning property.
- `secretParameters`: [PostgreSqlMigrationSecretParametersProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationsecretparametersproxy.md) `get - set` -- Gets or sets the SecretParameters provisioning property.
- `setupLogicalReplicationOnSourceDbIfNeeded`: `BicepValueProxy | PostgreSqlMigrationLogicalReplicationOnSourceDb` `get - set` -- Gets or sets the SetupLogicalReplicationOnSourceDbIfNeeded provisioning property.
- `sourceDbServerFullyQualifiedDomainName`: `BicepValueProxy | string` `get - set` -- Gets or sets the SourceDbServerFullyQualifiedDomainName provisioning property.
- `sourceDbServerMetadata`: [PostgreSqlServerMetadataProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlservermetadataproxy.md) `get` -- Gets the SourceDbServerMetadata provisioning property.
- `sourceDbServerResourceId`: `BicepValueProxy` `get - set` -- Gets or sets the SourceDbServerResourceId provisioning property.
- `sourceType`: `BicepValueProxy | PostgreSqlFlexibleServersSourceType` `get - set` -- Gets or sets the SourceType provisioning property.
- `sslMode`: `BicepValueProxy | PostgreSqlFlexibleServersSslMode` `get - set` -- Gets or sets the SslMode provisioning property.
- `startDataMigration`: `BicepValueProxy | PostgreSqlMigrationStartDataMigration` `get - set` -- Gets or sets the StartDataMigration provisioning property.
- `systemData`: [PostgreSqlSystemDataProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlsystemdataproxy.md) `get` -- Gets the SystemData provisioning property.
- `tags`: [Aspire_Hosting_Azure_Provisioning_PostgreSql_Generated_DictionaryOfStringProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/aspire-hosting-azure-provisioning-postgresql-generated-dictionaryofstringproxy.md) `get - set` -- Gets or sets the Tags provisioning property.
- `targetDbServerFullyQualifiedDomainName`: `BicepValueProxy | string` `get - set` -- Gets or sets the TargetDbServerFullyQualifiedDomainName provisioning property.
- `targetDbServerMetadata`: [PostgreSqlServerMetadataProxy](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlservermetadataproxy.md) `get` -- Gets the TargetDbServerMetadata provisioning property.
- `targetDbServerResourceId`: `BicepValueProxy` `get` -- Gets the TargetDbServerResourceId provisioning property.
- `triggerCutover`: `BicepValueProxy | PostgreSqlMigrationTriggerCutover` `get - set` -- Gets or sets the TriggerCutover provisioning property.

## Methods

- [addTo](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/addto.md) -- `method` -- Adds this provisioning resource to the Azure resource infrastructure.
    ```typescript
  addTo(infrastructure: AzureResourceInfrastructure): void
  ```
- [clearCancel](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearcancel.md) -- `method` -- Clears the Cancel provisioning property.
    ```typescript
  clearCancel(): void
  ```
- [clearLocation](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearlocation.md) -- `method` -- Clears the Location provisioning property.
    ```typescript
  clearLocation(): void
  ```
- [clearMigrateRoles](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearmigrateroles.md) -- `method` -- Clears the MigrateRoles provisioning property.
    ```typescript
  clearMigrateRoles(): void
  ```
- [clearMigrationInstanceResourceId](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearmigrationinstanceresourceid.md) -- `method` -- Clears the MigrationInstanceResourceId provisioning property.
    ```typescript
  clearMigrationInstanceResourceId(): void
  ```
- [clearMigrationMode](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearmigrationmode.md) -- `method` -- Clears the MigrationMode provisioning property.
    ```typescript
  clearMigrationMode(): void
  ```
- [clearMigrationOption](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearmigrationoption.md) -- `method` -- Clears the MigrationOption provisioning property.
    ```typescript
  clearMigrationOption(): void
  ```
- [clearMigrationWindowEndTimeInUtc](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearmigrationwindowendtimeinutc.md) -- `method` -- Clears the MigrationWindowEndTimeInUtc provisioning property.
    ```typescript
  clearMigrationWindowEndTimeInUtc(): void
  ```
- [clearMigrationWindowStartTimeInUtc](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearmigrationwindowstarttimeinutc.md) -- `method` -- Clears the MigrationWindowStartTimeInUtc provisioning property.
    ```typescript
  clearMigrationWindowStartTimeInUtc(): void
  ```
- [clearName](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearname.md) -- `method` -- Clears the Name provisioning property.
    ```typescript
  clearName(): void
  ```
- [clearOverwriteDbsInTarget](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearoverwritedbsintarget.md) -- `method` -- Clears the OverwriteDbsInTarget provisioning property.
    ```typescript
  clearOverwriteDbsInTarget(): void
  ```
- [clearSetupLogicalReplicationOnSourceDbIfNeeded](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearsetuplogicalreplicationonsourcedbifneeded.md) -- `method` -- Clears the SetupLogicalReplicationOnSourceDbIfNeeded provisioning property.
    ```typescript
  clearSetupLogicalReplicationOnSourceDbIfNeeded(): void
  ```
- [clearSourceDbServerFullyQualifiedDomainName](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearsourcedbserverfullyqualifieddomainname.md) -- `method` -- Clears the SourceDbServerFullyQualifiedDomainName provisioning property.
    ```typescript
  clearSourceDbServerFullyQualifiedDomainName(): void
  ```
- [clearSourceDbServerResourceId](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearsourcedbserverresourceid.md) -- `method` -- Clears the SourceDbServerResourceId provisioning property.
    ```typescript
  clearSourceDbServerResourceId(): void
  ```
- [clearSourceType](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearsourcetype.md) -- `method` -- Clears the SourceType provisioning property.
    ```typescript
  clearSourceType(): void
  ```
- [clearSslMode](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearsslmode.md) -- `method` -- Clears the SslMode provisioning property.
    ```typescript
  clearSslMode(): void
  ```
- [clearStartDataMigration](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/clearstartdatamigration.md) -- `method` -- Clears the StartDataMigration provisioning property.
    ```typescript
  clearStartDataMigration(): void
  ```
- [clearTargetDbServerFullyQualifiedDomainName](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/cleartargetdbserverfullyqualifieddomainname.md) -- `method` -- Clears the TargetDbServerFullyQualifiedDomainName provisioning property.
    ```typescript
  clearTargetDbServerFullyQualifiedDomainName(): void
  ```
- [clearTriggerCutover](/reference/api/typescript/aspire.hosting.azure.provisioning.postgresql/postgresqlmigrationproxy/cleartriggercutover.md) -- `method` -- Clears the TriggerCutover provisioning property.
    ```typescript
  clearTriggerCutover(): void
  ```