Cmdlets for Azure Cosmos DB

Build 24.0.9060

Invoke-CosmosDB Cmdlet

Parameters   Output Objects  

Searches and updates Azure Cosmos DB data.

Syntax

Invoke-CosmosDB [parameters]

Remarks

The Invoke-CosmosDB cmdlet allows you to use SQL statements to execute any SQL statement directly. Below is the syntax for a parameterized query:

$query = Invoke-CosmosDB -Connection $connection -Query 'SELECT * FROM [CData].[Entities].Customers WHERE Country=@Country' -Params @{'@Country'='US'}
This cmdlet is also useful for executing stored procedures. Use the EXEC keyword to call a stored procedure:
$query = Invoke-CosmosDB -Connection $connection -Query 'EXEC EVAL jsFunction = @jsFunction' -Params @{"function () { return db.restaurants.findOne(); }"}
To pass multiple Params parameters, use a semicolon (;) as a delimiter. The code below outlines the structure of an EXEC command with two parameters (param1 and param2):
$query = Invoke-CosmosDB -Connection $connection -Query 'EXEC MyStoredProc Input1=@param1, Input2=@param2' -Params @{'@param1' = 'value1'; '@param2' = 'value2'}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060