database_migrations_mongo_to_cosmos_db_ru_mongo

Creates, updates, deletes, gets or lists a database_migrations_mongo_to_cosmos_db_ru_mongo resource.

Overview

Name	database_migrations_mongo_to_cosmos_db_ru_mongo
Type	Resource
Id	azure.data_migration.database_migrations_mongo_to_cosmos_db_ru_mongo

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string
name	string
properties	object	Database Migration Resource properties for CosmosDb for Mongo. (x-ms-discriminator-value: MongoToCosmosDbMongo)
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, targetResourceName, migrationName, subscriptionId		Get Database Migration resource.
create	insert	resourceGroupName, targetResourceName, migrationName, subscriptionId		Create or Update Database Migration resource.
delete	delete	resourceGroupName, targetResourceName, migrationName, subscriptionId	force	Delete Database Migration resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
migrationName	string	Name of the migration.
resourceGroupName	string	Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	string	Subscription ID that identifies an Azure subscription.
targetResourceName	string	The name of the target resource/account.
force	boolean	Optional force delete boolean. If this is provided as true, migration will be deleted even if active.

SELECT examples

get

Get Database Migration resource.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_migration.database_migrations_mongo_to_cosmos_db_ru_mongo
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND targetResourceName = '{{ targetResourceName }}' -- required
AND migrationName = '{{ migrationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Create or Update Database Migration resource.

INSERT INTO azure.data_migration.database_migrations_mongo_to_cosmos_db_ru_mongo (
data__properties,
resourceGroupName,
targetResourceName,
migrationName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ targetResourceName }}',
'{{ migrationName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: database_migrations_mongo_to_cosmos_db_ru_mongo
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the database_migrations_mongo_to_cosmos_db_ru_mongo resource.
    - name: targetResourceName
      value: string
      description: Required parameter for the database_migrations_mongo_to_cosmos_db_ru_mongo resource.
    - name: migrationName
      value: string
      description: Required parameter for the database_migrations_mongo_to_cosmos_db_ru_mongo resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the database_migrations_mongo_to_cosmos_db_ru_mongo resource.
    - name: properties
      value: object
      description: |
        Database Migration Resource properties for CosmosDb for Mongo.

DELETE examples

delete

Delete Database Migration resource.

DELETE FROM azure.data_migration.database_migrations_mongo_to_cosmos_db_ru_mongo
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND targetResourceName = '{{ targetResourceName }}' --required
AND migrationName = '{{ migrationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND force = '{{ force }}'
;