{ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2024-08-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "description": "Microsoft Entra OAuth2 Flow", "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}": { "put": { "tags": [ "Migrations" ], "operationId": "Migrations_Create", "x-ms-examples": { "Create a migration.": { "$ref": "./examples/Migrations_Create.json" }, "Create a migration specifying user names.": { "$ref": "./examples/Migrations_Create_With_Other_Users.json" }, "Create a migration with roles.": { "$ref": "./examples/Migrations_Create_With_Roles.json" }, "Create a migration with private endpoint.": { "$ref": "./examples/Migrations_Create_With_PrivateEndpoint_Servers.json" }, "Create a migration with other source type for validating and migrating.": { "$ref": "./examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json" }, "Create a migration for validating only.": { "$ref": "./examples/Migrations_Create_Validate_Only.json" } }, "description": "Creates a new migration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" }, { "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" }, { "$ref": "#/parameters/TargetDbServerNameParameter" }, { "$ref": "#/parameters/MigrationNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MigrationResource" }, "description": "Parameters required for creating a migration." } ], "responses": { "200": { "description": "Successfully set or update the Migration for a server.", "schema": { "$ref": "#/definitions/MigrationResource" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/MigrationResource" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "Migrations" ], "operationId": "Migrations_Get", "x-ms-examples": { "Get information about a migration.": { "$ref": "./examples/Migrations_Get.json" }, "Get information about a migration with validation failures.": { "$ref": "./examples/Migrations_GetMigrationWithValidationFailures.json" }, "Get information about a migration with successful validation only.": { "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json" }, "Get information about a migration with successful validation but failed migration.": { "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json" }, "Get information about a migration with successful validation and successful migration.": { "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json" } }, "description": "Gets information about a migration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" }, { "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" }, { "$ref": "#/parameters/TargetDbServerNameParameter" }, { "$ref": "#/parameters/MigrationNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MigrationResource" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Migrations" ], "operationId": "Migrations_Update", "x-ms-examples": { "Update an existing migration.": { "$ref": "./examples/Migrations_Update.json" }, "Cancel an existing migration.": { "$ref": "./examples/Migrations_Cancel.json" } }, "description": "Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" }, { "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" }, { "$ref": "#/parameters/TargetDbServerNameParameter" }, { "$ref": "#/parameters/MigrationNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MigrationResourceForPatch" }, "description": "Parameters required to update an existing migration." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MigrationResource" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Migrations" ], "operationId": "Migrations_Delete", "x-ms-examples": { "Delete an existing migration.": { "$ref": "./examples/Migrations_Delete.json" } }, "description": "Deletes an existing migration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" }, { "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" }, { "$ref": "#/parameters/TargetDbServerNameParameter" }, { "$ref": "#/parameters/MigrationNameParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "NoContent" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations": { "get": { "tags": [ "Migrations" ], "operationId": "Migrations_ListByTargetServer", "x-ms-examples": { "List all migrations of a target flexible server.": { "$ref": "./examples/Migrations_ListByTargetServer.json" } }, "description": "Lists all migrations of a target flexible server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" }, { "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" }, { "$ref": "#/parameters/TargetDbServerNameParameter" }, { "$ref": "#/parameters/MigrationListFilter" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/MigrationResourceListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/checkMigrationNameAvailability": { "post": { "summary": "Check the validity and availability of the given name, to assign it to a new migration.", "description": "Checks if a proposed migration name is valid and available.", "tags": [ "Custom operation", "POST" ], "operationId": "CheckMigrationNameAvailability", "x-ms-examples": { "Check the validity and availability of the given name, to assign it to a new migration.": { "$ref": "./examples/CheckMigrationNameAvailability.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" }, { "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" }, { "$ref": "#/parameters/TargetDbServerNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MigrationNameAvailabilityResource" }, "description": "Parameters required to check if a migration name is valid and available." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MigrationNameAvailabilityResource" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } } } }, "definitions": { "MigrationResource": { "type": "object", "properties": { "properties": { "$ref": "#/definitions/MigrationResourceProperties", "description": "Migration properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "description": "Migration." }, "MigrationResourceProperties": { "type": "object", "properties": { "migrationId": { "type": "string", "readOnly": true, "description": "Identifier of a migration." }, "currentStatus": { "$ref": "#/definitions/MigrationStatus", "readOnly": true, "description": "Current status of a migration." }, "migrationInstanceResourceId": { "type": "string", "format": "arm-id", "description": "Identifier of the private endpoint migration instance." }, "migrationMode": { "$ref": "#/definitions/MigrationMode", "description": "Mode used to perform the migration: Online or Offline." }, "migrationOption": { "$ref": "#/definitions/MigrationOption", "description": "Supported option for a migration." }, "sourceType": { "$ref": "#/definitions/SourceType", "description": "Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL" }, "sslMode": { "$ref": "#/definitions/SslMode", "description": "SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'." }, "sourceDbServerMetadata": { "$ref": "#/definitions/DbServerMetadata", "readOnly": true, "description": "Metadata of source database server." }, "targetDbServerMetadata": { "$ref": "#/definitions/DbServerMetadata", "readOnly": true, "description": "Metadata of target database server." }, "sourceDbServerResourceId": { "type": "string", "description": "Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username." }, "sourceDbServerFullyQualifiedDomainName": { "type": "string", "description": "Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server." }, "targetDbServerResourceId": { "type": "string", "readOnly": true, "description": "Identifier of the target database server resource." }, "targetDbServerFullyQualifiedDomainName": { "type": "string", "description": "Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server." }, "secretParameters": { "$ref": "#/definitions/MigrationSecretParameters", "description": "Migration secret parameters." }, "dbsToMigrate": { "maxItems": 50, "type": "array", "items": { "type": "string" }, "description": "Names of databases to migrate.", "x-ms-identifiers": [] }, "setupLogicalReplicationOnSourceDbIfNeeded": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "LogicalReplicationOnSourceDbEnum", "modelAsString": true }, "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed." }, "overwriteDbsInTarget": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "OverwriteDbsInTargetEnum", "modelAsString": true }, "description": "Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation." }, "migrationWindowStartTimeInUtc": { "format": "date-time", "type": "string", "description": "Start time (UTC) for migration window." }, "migrationWindowEndTimeInUtc": { "format": "date-time", "type": "string", "description": "End time (UTC) for migration window." }, "migrateRoles": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "MigrateRolesEnum", "modelAsString": true }, "description": "Indicates if roles and permissions must be migrated." }, "startDataMigration": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "StartDataMigrationEnum", "modelAsString": true }, "description": "Indicates if data migration must start right away." }, "triggerCutover": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "TriggerCutoverEnum", "modelAsString": true }, "description": "Indicates if cutover must be triggered for the entire migration." }, "dbsToTriggerCutoverOn": { "type": "array", "items": { "type": "string" }, "description": "When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.", "x-ms-identifiers": [] }, "cancel": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "CancelEnum", "modelAsString": true }, "description": "Indicates if cancel must be triggered for the entire migration." }, "dbsToCancelMigrationOn": { "type": "array", "items": { "type": "string" }, "description": "When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.", "x-ms-identifiers": [] } }, "description": "Migration." }, "MigrationResourceListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/MigrationResource" }, "readOnly": true, "description": "List of migrations.", "x-ms-identifiers": [] }, "nextLink": { "description": "Link used to get the next page of results.", "type": "string", "readOnly": true } }, "description": "List of migrations." }, "MigrationResourceForPatch": { "type": "object", "properties": { "properties": { "$ref": "#/definitions/MigrationResourcePropertiesForPatch", "description": "Migration properties.", "x-ms-client-flatten": true }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Application-specific metadata in the form of key-value pairs." } }, "description": "Migration." }, "MigrationResourcePropertiesForPatch": { "type": "object", "properties": { "sourceDbServerResourceId": { "type": "string", "description": "Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username." }, "sourceDbServerFullyQualifiedDomainName": { "type": "string", "description": "Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server." }, "targetDbServerFullyQualifiedDomainName": { "type": "string", "description": "Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server." }, "secretParameters": { "$ref": "#/definitions/MigrationSecretParameters", "description": "Migration secret parameters." }, "dbsToMigrate": { "maxItems": 50, "type": "array", "items": { "type": "string" }, "description": "Names of databases to migrate.", "x-ms-identifiers": [] }, "setupLogicalReplicationOnSourceDbIfNeeded": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "LogicalReplicationOnSourceDbEnum", "modelAsString": true }, "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed." }, "overwriteDbsInTarget": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "OverwriteDbsInTargetEnum", "modelAsString": true }, "description": "Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation." }, "migrationWindowStartTimeInUtc": { "format": "date-time", "type": "string", "description": "Start time (UTC) for migration window." }, "migrateRoles": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "MigrateRolesEnum", "modelAsString": true }, "description": "Indicates if roles and permissions must be migrated." }, "startDataMigration": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "StartDataMigrationEnum", "modelAsString": true }, "description": "Indicates if data migration must start right away." }, "triggerCutover": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "TriggerCutoverEnum", "modelAsString": true }, "description": "Indicates if cutover must be triggered for the entire migration." }, "dbsToTriggerCutoverOn": { "type": "array", "items": { "type": "string" }, "description": "When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.", "x-ms-identifiers": [] }, "cancel": { "type": "string", "enum": [ "True", "False" ], "x-ms-enum": { "name": "CancelEnum", "modelAsString": true }, "description": "Indicates if cancel must be triggered for the entire migration." }, "dbsToCancelMigrationOn": { "type": "array", "items": { "type": "string" }, "description": "When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.", "x-ms-identifiers": [] }, "migrationMode": { "$ref": "#/definitions/MigrationMode", "description": "Mode used to perform the migration: Online or Offline." } }, "description": "Migration properties." }, "MigrationSecretParameters": { "required": [ "adminCredentials" ], "type": "object", "properties": { "adminCredentials": { "x-ms-secret": true, "x-ms-external": true, "$ref": "#/definitions/AdminCredentials", "description": "Credentials of administrator users for source and target servers." }, "sourceServerUsername": { "type": "string", "x-ms-mutability": [ "create", "update" ], "description": "Gets or sets the name of the user for the source server. This user doesn't need to be an administrator." }, "targetServerUsername": { "type": "string", "x-ms-mutability": [ "create", "update" ], "description": "Gets or sets the name of the user for the target server. This user doesn't need to be an administrator." } }, "description": "Migration secret parameters." }, "AdminCredentials": { "type": "object", "required": [ "sourceServerPassword", "targetServerPassword" ], "properties": { "sourceServerPassword": { "type": "string", "x-ms-secret": true, "x-ms-external": true, "x-ms-mutability": [ "create", "update" ], "description": "Password for the user of the source server." }, "targetServerPassword": { "type": "string", "x-ms-secret": true, "x-ms-external": true, "x-ms-mutability": [ "create", "update" ], "description": "Password for the user of the target server." } }, "description": "Credentials of administrator users for source and target servers." }, "DbServerMetadata": { "type": "object", "properties": { "location": { "type": "string", "description": "Location of database server.", "x-ms-mutability": [ "read" ], "readOnly": true }, "version": { "type": "string", "description": "Major version of PostgreSQL database engine." }, "storageMb": { "format": "int32", "type": "integer", "description": "Storage size (in MB) for database server." }, "sku": { "$ref": "#/definitions/ServerSku", "description": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server." } }, "description": "Database server metadata." }, "MigrationDetailsLevel": { "enum": [ "Default", "Summary", "Full" ], "type": "string", "description": "Level of details of a migration.", "x-ms-enum": { "name": "MigrationDetailsLevel", "modelAsString": true } }, "MigrationMode": { "enum": [ "Offline", "Online" ], "type": "string", "description": "Mode used to perform the migration: Online or Offline.", "x-ms-enum": { "name": "MigrationMode", "modelAsString": true } }, "MigrationOption": { "enum": [ "Validate", "Migrate", "ValidateAndMigrate" ], "type": "string", "description": "Supported option for a migration", "x-ms-enum": { "name": "MigrationOption", "modelAsString": true } }, "MigrationState": { "enum": [ "InProgress", "WaitingForUserAction", "Canceled", "Failed", "Succeeded", "ValidationFailed", "CleaningUp" ], "type": "string", "description": "State of migration.", "x-ms-enum": { "name": "MigrationState", "modelAsString": true } }, "MigrationStatus": { "type": "object", "properties": { "state": { "$ref": "#/definitions/MigrationState", "readOnly": true, "description": "State of migration." }, "error": { "type": "string", "readOnly": true, "description": "Error message, if any, for the migration state." }, "currentSubStateDetails": { "$ref": "#/definitions/MigrationSubStateDetails", "readOnly": true, "description": "Current migration sub state details." } }, "description": "State of migration." }, "MigrationSubState": { "enum": [ "PerformingPreRequisiteSteps", "WaitingForLogicalReplicationSetupRequestOnSourceDB", "WaitingForDBsToMigrateSpecification", "WaitingForTargetDBOverwriteConfirmation", "WaitingForDataMigrationScheduling", "WaitingForDataMigrationWindow", "MigratingData", "WaitingForCutoverTrigger", "CompletingMigration", "Completed", "CancelingRequestedDBMigrations", "ValidationInProgress" ], "type": "string", "description": "Substate of migration.", "x-ms-enum": { "name": "MigrationSubState", "modelAsString": true } }, "MigrationSubStateDetails": { "type": "object", "properties": { "currentSubState": { "$ref": "#/definitions/MigrationSubState", "readOnly": true }, "dbDetails": { "type": "object", "additionalProperties": { "$ref": "#/definitions/DbMigrationStatus" } }, "validationDetails": { "$ref": "#/definitions/ValidationDetails" } }, "description": "Details of migration substate." }, "DbMigrationStatus": { "type": "object", "description": "Migration status of a database.", "properties": { "databaseName": { "type": "string", "description": "Name of database." }, "migrationState": { "type": "string", "description": "Migration state of a database.", "enum": [ "InProgress", "WaitingForCutoverTrigger", "Failed", "Canceled", "Succeeded", "Canceling" ], "x-ms-enum": { "name": "MigrationDbState", "modelAsString": true } }, "migrationOperation": { "type": "string", "description": "Migration operation of a database." }, "startedOn": { "type": "string", "format": "date-time", "description": "Start time of a migration state." }, "endedOn": { "type": "string", "format": "date-time", "description": "End time of a migration state." }, "fullLoadQueuedTables": { "format": "int32", "type": "integer", "description": "Number of tables queued for the migration of a database." }, "fullLoadErroredTables": { "format": "int32", "type": "integer", "description": "Number of tables encountering errors during the migration of a database." }, "fullLoadLoadingTables": { "format": "int32", "type": "integer", "description": "Number of tables loading during the migration of a database." }, "fullLoadCompletedTables": { "format": "int32", "type": "integer", "description": "Number of tables loaded during the migration of a database." }, "cdcUpdateCounter": { "format": "int32", "type": "integer", "description": "Change Data Capture update counter." }, "cdcDeleteCounter": { "format": "int32", "type": "integer", "description": "Change Data Capture delete counter." }, "cdcInsertCounter": { "format": "int32", "type": "integer", "description": "Change Data Capture insert counter." }, "appliedChanges": { "format": "int32", "type": "integer", "description": "Change Data Capture applied changes counter." }, "incomingChanges": { "format": "int32", "type": "integer", "description": "Change Data Capture incoming changes counter." }, "latency": { "format": "int32", "type": "integer", "description": "Lag in seconds between source and target during online phase." }, "message": { "type": "string", "description": "Error message, if any, for the migration state." } } }, "ValidationDetails": { "type": "object", "description": "Details for the validation for migration.", "properties": { "status": { "$ref": "#/definitions/ValidationState" }, "validationStartTimeInUtc": { "type": "string", "format": "date-time", "description": "Start time (UTC) for validation." }, "validationEndTimeInUtc": { "type": "string", "format": "date-time", "description": "End time (UTC) for validation." }, "serverLevelValidationDetails": { "type": "array", "items": { "$ref": "#/definitions/ValidationSummaryItem" }, "description": "Details of server level validations.", "x-ms-identifiers": [] }, "dbLevelValidationDetails": { "type": "array", "items": { "$ref": "#/definitions/DbLevelValidationStatus" }, "description": "Details of server level validations.", "x-ms-identifiers": [ "databaseName" ] } } }, "DbLevelValidationStatus": { "type": "object", "description": "Validation status summary for a database.", "properties": { "databaseName": { "type": "string", "description": "Name of database." }, "startedOn": { "type": "string", "format": "date-time", "description": "Start time of a database level validation." }, "endedOn": { "type": "string", "format": "date-time", "description": "End time of a database level validation." }, "summary": { "type": "array", "items": { "$ref": "#/definitions/ValidationSummaryItem" }, "description": "Summary of database level validations.", "x-ms-identifiers": [] } } }, "ValidationSummaryItem": { "type": "object", "description": "Validation summary object.", "properties": { "type": { "type": "string", "description": "Validation type." }, "state": { "$ref": "#/definitions/ValidationState" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/ValidationMessage" }, "description": "Validation messages.", "x-ms-identifiers": [] } } }, "ValidationMessage": { "type": "object", "description": "Validation message object.", "properties": { "state": { "$ref": "#/definitions/ValidationState", "description": "Severity of validation message." }, "message": { "type": "string", "description": "Validation message string." } } }, "ValidationState": { "type": "string", "description": "Validation status for migration.", "enum": [ "Failed", "Succeeded", "Warning" ], "x-ms-enum": { "name": "ValidationState", "modelAsString": true } }, "SourceType": { "enum": [ "OnPremises", "AWS", "GCP", "AzureVM", "PostgreSQLSingleServer", "AWS_RDS", "AWS_AURORA", "AWS_EC2", "GCP_CloudSQL", "GCP_AlloyDB", "GCP_Compute", "EDB" ], "type": "string", "description": "Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL", "x-ms-enum": { "name": "SourceType", "modelAsString": true } }, "SslMode": { "enum": [ "Prefer", "Require", "VerifyCA", "VerifyFull" ], "type": "string", "description": "SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.", "x-ms-enum": { "name": "SslMode", "modelAsString": true } }, "ServerSku": { "type": "object", "properties": { "name": { "type": "string", "description": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server." }, "tier": { "type": "string", "description": "Tier of the compute assigned to a flexible server.", "enum": [ "Burstable", "GeneralPurpose", "MemoryOptimized" ], "x-ms-enum": { "name": "SkuTier", "modelAsString": true } } }, "description": "Compute information of a flexible server." }, "MigrationNameAvailabilityReason": { "enum": [ "Invalid", "AlreadyExists" ], "type": "string", "description": "Migration name availability reason.", "x-ms-enum": { "name": "MigrationNameAvailabilityReason", "modelAsString": true } }, "MigrationNameAvailabilityResource": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the migration to check for validity and availability." }, "type": { "type": "string", "description": "Type of resource." }, "nameAvailable": { "type": "boolean", "description": "Indicates if the migration name is available.", "readOnly": true }, "reason": { "$ref": "#/definitions/MigrationNameAvailabilityReason", "description": "Migration name availability reason.", "readOnly": true }, "message": { "type": "string", "description": "Migration name availability message.", "readOnly": true } }, "description": "Availability of a migration name." } }, "parameters": { "TargetDbServerSubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "Identifier of subscription of target database server.", "pattern": "([a-z0-9]){8,8}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){12,12}", "x-ms-parameter-location": "method" }, "TargetDbServerResourceGroupNameParameter": { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "Name of resource group of target database server.", "pattern": "^[-a-z0-9A-Z._()]+[^.]$", "x-ms-parameter-location": "method" }, "TargetDbServerNameParameter": { "name": "targetDbServerName", "in": "path", "required": true, "type": "string", "description": "Name of target database server.", "pattern": "([-a-z0-9]){3,63}", "x-ms-parameter-location": "method" }, "MigrationNameParameter": { "name": "migrationName", "in": "path", "required": true, "type": "string", "description": "Name of migration.", "pattern": "^[a-z][a-z0-9]*$", "x-ms-parameter-location": "method" }, "MigrationListFilter": { "name": "migrationListFilter", "in": "query", "required": false, "enum": [ "Active", "All" ], "type": "string", "description": "Migration list filter. Retrieves either active migrations or all migrations.", "x-ms-enum": { "name": "MigrationListFilter", "modelAsString": true }, "x-ms-parameter-location": "method" } } }