Cosmos DB Connector for Azure Data Factory (SSIS) : Delete a document by ID

Prerequisites

Before we begin, make sure the following prerequisites are met:

1. SQL Server Data Tools (SSDT) designer installed for Visual Studio.
2. SQL Server Integration Services Projects 2022+ Visual Studio extension installed.
3. SSIS PowerPack is installed.

Delete a document by ID in SSIS

1. Open Visual Studio and click Create a new project.

2. Select Integration Services Project. Enter a name and location for your project, then click OK.

3. From the SSIS Toolbox, drag and drop a Data Flow Task onto the Control Flow surface, and double-click it:

   

4. Make sure you are in the Data Flow Task designer:

   

5. Read the data from the source, using any desired source component. You can even make an API call using the ZappySys JSON/XML/API Source and read data from there. In this example, we will use an OLE DB Source component to read real-time data from a SQL Server database.

6. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
   

7. Select New Connection to create a new connection:
   

   API Destination - Cosmos DB

   Read and write Azure Cosmos DB data effortlessly. Query, integrate, and manage databases, containers, documents, and users — almost no coding required.

   

8. To configure the Cosmos DB connector, choose one of the following methods:

   • Choose from Popular Connector List: Select a pre-installed service directly from the dropdown menu.
   • Search Online: Use this to find and download a new connector file to your computer.
   • Use Saved/Downloaded File: Once the file is downloaded, browse your local drive to load it into the configuration.

   After that, just click Continue >>:

   Cosmos DB

   

9. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

   API Key

   Cosmos DB authentication

   Connecting to your Azure Cosmos DB data requires you to authenticate your REST API access. Follow the instructions below:

   1. Go to your Azure portal homepage: https://portal.azure.com/.
   2. In the search bar at the top of the homepage, enter Azure Cosmos DB. In the dropdown that appears, select Azure Cosmos DB.
   3. Click on the name of the database account you want to connect to (also copy and paste the name of the database account for later use).
   4. On the next page where you can see all of the database account information, look along the left side and select Keys:
   5. On the Keys page, you will have two tabs: Read-write Keys and Read-only Keys. If you are going to write data to your database, you need to remain on the Read-write Keys tab. If you are only going to read data from your database, you should select the Read-only Keys tab.
   6. On the Keys page, copy the PRIMARY KEY value and paste it somewhere for later use (the SECONDARY KEY value may also be copied and used).
   7. Now go to SSIS package or ODBC data source and use this PRIMARY KEY in API Key authentication configuration.
   8. Enter the primary or secondary key you recorded in step 6 into the Primary or Secondary Key field.
   9. Then enter the database account you recorded in step 3 into the Database Account field.
   10. Next, enter or select the default database you want to connect to using the Default Database field.
   11. Continue by entering or selecting the default table (i.e. container/collection) you want to connect to using the Default Table (Container/Collection) field.
   12. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure Cosmos DB account.
   13. If the connection test succeeds, select OK.
   14. Done! Now you are ready to use Cosmos DB Connector!

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to API Key [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   Cosmos DB

   API Key [Http]

   https://[$Account$].documents.azure.com

   Required Parameters
   Primary or Secondary Key	Fill-in the parameter...
   Account Name (Case-Sensitive)	Fill-in the parameter...
   Database Name (keep blank to use default) Case-Sensitive	Fill-in the parameter...
   API Version	Fill-in the parameter...
   Optional Parameters
   Default Table (needed to invoke #DirectSQL)

   

   Find full details in the Cosmos DB Connector authentication reference.

10. Select [Dynamic Table] table from the dropdown, then select Delete as operation, and hit Preview Data:

    

    API Destination - Cosmos DB

    Read and write Azure Cosmos DB data effortlessly. Query, integrate, and manage databases, containers, documents, and users — almost no coding required.

    Cosmos DB

    [Dynamic Table]

    Delete

    Required Parameters
    Document Id	Fill-in the parameter...
    Table Name (Case-Sensitive)	Fill-in the parameter...
    Optional Parameters
    Database Name (keep blank to use default) Case-Sensitive
    EnableCrossPartition	true
    Partition Key Value (default is supplied Id)	.
    RawOutputDataRowTemplate	{}
    EnableRawOutputModeSingleRow	True
    ContineOnErrorForStatusCode	True
    ErrorStatusCodeToMatchRegex	404|405

    

11. Finally, map the desired columns:

    API Destination - Cosmos DB

    Read and write Azure Cosmos DB data effortlessly. Query, integrate, and manage databases, containers, documents, and users — almost no coding required.

    

12. That's it; we successfully configured the POST API Call. In a few clicks we configured the Cosmos DB API call using ZappySys Cosmos DB Connector

    

Deploy SSIS package to Azure Data Factory (ADF)

Once your SSIS package is complete, deploy it to the Azure-SSIS runtime within Azure Data Factory. The setup process requires you to upload the SSIS PowerPack installer to Azure Blob Storage and then customize the runtime configuration using the main.cmd file. For a complete walkthrough of these steps, see our detailed guide on the Azure Data Factory (SSIS) and Cosmos DB integration.

Cosmos DB Connector actions

Need another use case? Pick the next Cosmos DB action in Azure Data Factory (SSIS) below.

• Create a document in the container
• Create Permission Token for a User (One Table)
• Create User for Database
• Get All Documents for a Table
• Get All Users for a Database
• Get Database Information by Id or Name
• Get Document by Id
• Get List of Databases
• Get List of Tables
• Get table information by Id or Name
• Get table partition key ranges
• Get User by Id or Name
• Query documents using Cosmos DB SQL query language
• Update Document in the Container
• Upsert a document in the container
• Make Generic REST API Request
• Make Generic REST API Request (Bulk Write)

Conclusion

You now know how to delete a document by ID in Azure Data Factory (SSIS) without writing complex code. SSIS Cosmos DB Connector handled pagination and authentication automatically.

Ready to get started? Download the trial or ping us via chat if you need help: