Share via

DatabaseMigrationCosmosDbMongo interface

Package:
@azure/arm-datamigration

Database Migration Resource for Mongo to CosmosDb.

Extends
ProxyResource

Properties

collectionList

List of Mongo Collections to be migrated.
endedOn

Database migration end time. NOTE: This property will not be serialized. It can only be populated by the server.
kind
migrationFailureError

Error details in case of migration failure. NOTE: This property will not be serialized. It can only be populated by the server.
migrationOperationId

ID for current migration operation.
migrationService

Resource Id of the Migration Service.
migrationStatus

Migration status. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningError

Error message for migration provisioning failure, if any.
provisioningState

Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. NOTE: This property will not be serialized. It can only be populated by the server.
scope

Resource Id of the target resource.
sourceMongoConnection

Source Mongo connection details.
startedOn

Database migration start time. NOTE: This property will not be serialized. It can only be populated by the server.
targetMongoConnection

Target Cosmos DB Mongo connection details.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

collectionList

List of Mongo Collections to be migrated.

collectionList?: MongoMigrationCollection[]

Property Value

MongoMigrationCollection[]

endedOn

Database migration end time. NOTE: This property will not be serialized. It can only be populated by the server.

endedOn?: Date

Property Value

Date

kind 

kind?: string

Property Value

string

migrationFailureError

Error details in case of migration failure. NOTE: This property will not be serialized. It can only be populated by the server.

migrationFailureError?: ErrorInfo

Property Value

ErrorInfo

migrationOperationId

ID for current migration operation.

migrationOperationId?: string

Property Value

string

migrationService

Resource Id of the Migration Service.

migrationService?: string

Property Value

string

migrationStatus

Migration status. NOTE: This property will not be serialized. It can only be populated by the server.

migrationStatus?: string

Property Value

string

provisioningError

Error message for migration provisioning failure, if any.

provisioningError?: string

Property Value

string

provisioningState

Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

scope

Resource Id of the target resource.

scope?: string

Property Value

string

sourceMongoConnection

Source Mongo connection details.

sourceMongoConnection?: MongoConnectionInformation

Property Value

MongoConnectionInformation

startedOn

Database migration start time. NOTE: This property will not be serialized. It can only be populated by the server.

startedOn?: Date

Property Value

Date

targetMongoConnection

Target Cosmos DB Mongo connection details.

targetMongoConnection?: MongoConnectionInformation

Property Value

MongoConnectionInformation

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type