CosmosDBCmdlets

21.0.7930.1

lib/net20/CData.CosmosDBCmdlets.Commands.dll-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns="http://msh" schema="maml">

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Add-CosmosDB

    </command:name>

    <maml:description>

      <maml:para>Inserts Cosmos DB data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2021 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Add</command:verb>

    <command:noun>CosmosDB</command:noun>

    <dev:version>21.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Inserts Cosmos DB data. The Add-CosmosDB cmdlet allows you to use a syntax similar to SQL INSERT statements to create new Cosmos DB records.</maml:para><maml:para>Add-CosmosDB -Connection $connection -Table "[CData].[Entities].Customers" -Columns @("CompanyName") -Values @("Jon Deere")</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Add-CosmosDB [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Columns</maml:name>

          <maml:description>

            <maml:para>The columns on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>Values</maml:name>

          <maml:description>

            <maml:para>The values that will be used to update the table.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Columns</maml:name>

      <maml:description>

        <maml:para>The columns on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="false"

  position="named" >

      <maml:name>Values</maml:name>

      <maml:description>

        <maml:para>The values that will be used to update the table.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>InsertedRowId</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The unique Id of the inserted row.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The unique Id of the inserted row.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Disconnect-CosmosDB

    </command:name>

    <maml:description>

      <maml:para>Closes a connection to Cosmos DB.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2021 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Disconnect</command:verb>

    <command:noun>CosmosDB</command:noun>

    <dev:version>21.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Closes a connection to Cosmos DB. The Disconnect-CosmosDB cmdlet is used to close a connection that was opened by the Connect-CosmosDB cmdlet.</maml:para><maml:para>Disconnect-CosmosDB -Connection $connection</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Disconnect-CosmosDB [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Invoke-CosmosDB

    </command:name>

    <maml:description>

      <maml:para>Searches and updates Cosmos DB data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2021 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Invoke</command:verb>

    <command:noun>CosmosDB</command:noun>

    <dev:version>21.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Searches and updates Cosmos DB data. The Invoke-CosmosDB cmdlet allows you to use SQL statements to execute any SQL statement directly. Below is the syntax for a parameterized query:</maml:para><maml:para>$query = Invoke-CosmosDB -Connection $connection -Query 'SELECT * FROM [CData].[Entities].Customers WHERE Country=@Country' -Params @{'@Country'='US'}</maml:para><maml:para></maml:para><maml:para>This cmdlet is also useful for executing stored procedures. Use the EXEC keyword to call a stored procedure:</maml:para><maml:para></maml:para><maml:para>$query = Invoke-CosmosDB -Connection $connection -Query 'EXEC EVAL jsFunction = @jsFunction' -Params @{"function () { return db.restaurants.findOne(); }"}</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Invoke-CosmosDB [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Params</maml:name>

          <maml:description>

            <maml:para>The parameters that will be used for the query.</maml:para>

          </maml:description>

          <command:parameterValue >

            Hashtable

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>Query</maml:name>

          <maml:description>

            <maml:para>The SQL query to execute.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Params</maml:name>

      <maml:description>

        <maml:para>The parameters that will be used for the query.</maml:para>

      </maml:description>

      <command:parameterValue  >

        Hashtable

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="false"

  position="named" >

      <maml:name>Query</maml:name>

      <maml:description>

        <maml:para>The SQL query to execute.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>AffectedRowsCount</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The number of rows affected by the operation.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The number of rows affected by the operation.

      </maml:description> 

    </command:returnValue>

      <command:returnValue>

      <dev:type>

        <maml:name>InsertedRowId</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The unique Id of the inserted row.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The unique Id of the inserted row.

      </maml:description> 

    </command:returnValue>

      <command:returnValue>

      <dev:type>

        <maml:name>QueryResults</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The results of the query.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The results of the query.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Remove-CosmosDB

    </command:name>

    <maml:description>

      <maml:para>Deletes Cosmos DB data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2021 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Remove</command:verb>

    <command:noun>CosmosDB</command:noun>

    <dev:version>21.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Deletes Cosmos DB data. The Remove-CosmosDB cmdlet allows you to use a syntax similar to SQL DELETE statements to delete Cosmos DB data.</maml:para><maml:para>$conn = Connect-CosmosDB -AccountEndpoint "myAccountEndpoint" -AccountKey "myAccountKey"</maml:para><maml:para>Remove-CosmosDB -Connection $conn -Table "[CData].[Entities].Customers" -Id "22"</maml:para><maml:para></maml:para><maml:para>The Where parameter can also be used to specify the primary key:</maml:para><maml:para></maml:para><maml:para>Remove-CosmosDB -Connection $conn -Table "exTablePowershell;" -Where "_id = 22"</maml:para><maml:para></maml:para><maml:para>The primary key can also be passed to the cmdlet along the pipeline:</maml:para><maml:para></maml:para><maml:para>Select-CosmosDB -Connection $conn -Table [CData].[Entities].Customers -Where "Country = 'US'" | Remove-CosmosDB</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Remove-CosmosDB [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="true"

          position="named">

          <maml:name>Id</maml:name>

          <maml:description>

            <maml:para>The Id of the item on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Where</maml:name>

          <maml:description>

            <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="true"

  position="named" >

      <maml:name>Id</maml:name>

      <maml:description>

        <maml:para>The Id of the item on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Where</maml:name>

      <maml:description>

        <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>AffectedRowsCount</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The number of rows affected by the operation.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The number of rows affected by the operation.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Connect-CosmosDB

    </command:name>

    <maml:description>

      <maml:para>Opens a new connection to Cosmos DB</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2021 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Connect</command:verb>

    <command:noun>CosmosDB</command:noun>

    <dev:version>21.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>The Connect-CosmosDB cmdlet is used to create a persistent connection object to be used with related cmdlets. When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object. To disconnect, call Disconnect-CosmosDB.</maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>$conn = Connect-CosmosDB</maml:name>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>AccountEndpoint</maml:name>

          <maml:description>

            <maml:para>The value should be the Cosmos DB account URL from the Keys blade of the Cosmos DB account.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>AccountKey</maml:name>

          <maml:description>

            <maml:para>A master key token or a resource token for connecting to the Cosmos DB REST API.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>AutoCache</maml:name>

          <maml:description>

            <maml:para>Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>BrowsableSchemas</maml:name>

          <maml:description>

            <maml:para>This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheConnection</maml:name>

          <maml:description>

            <maml:para>The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheLocation</maml:name>

          <maml:description>

            <maml:para>Specifies the path to the cache when caching to a file.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheMetadata</maml:name>

          <maml:description>

            <maml:para>This property determines whether or not to cache the table metadata to a file store.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheProvider</maml:name>

          <maml:description>

            <maml:para>The name of the provider to be used to cache data.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CacheTolerance</maml:name>

          <maml:description>

            <maml:para>The tolerance for stale data in the cache specified in seconds when using AutoCache .</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>CalculateAggregates</maml:name>

          <maml:description>

            <maml:para>Specifies whether will return the calculated value of the aggregates or grouped by partiton range.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ConsistencyLevel</maml:name>

          <maml:description>

            <maml:para>Denotes the type of token: master or resource.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallPassword</maml:name>

          <maml:description>

            <maml:para>A password used to authenticate to a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallPort</maml:name>

          <maml:description>

            <maml:para>The TCP port for a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallServer</maml:name>

          <maml:description>

            <maml:para>The name or IP address of a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallType</maml:name>

          <maml:description>

            <maml:para>The protocol used by a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FirewallUser</maml:name>

          <maml:description>

            <maml:para>The user name to use to authenticate with a proxy-based firewall.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FlattenArrays</maml:name>

          <maml:description>

            <maml:para>By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>FlattenObjects</maml:name>

          <maml:description>

            <maml:para>Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>GenerateSchemaFiles</maml:name>

          <maml:description>

            <maml:para>Indicates the user preference as to when schemas should be generated and saved.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Location</maml:name>

          <maml:description>

            <maml:para>A path to the directory that contains the schema files defining tables, views, and stored procedures.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Logfile</maml:name>

          <maml:description>

            <maml:para>A filepath which designates the name and location of the log file.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>LogModules</maml:name>

          <maml:description>

            <maml:para>Core modules to be included in the log file.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>MaxLogFileCount</maml:name>

          <maml:description>

            <maml:para>A string specifying the maximum file count of log files.</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>MaxLogFileSize</maml:name>

          <maml:description>

            <maml:para>A string specifying the maximum size in bytes for a log file (for example, 10 MB).</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>MaxRows</maml:name>

          <maml:description>

            <maml:para>Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>MultiThreadCount</maml:name>

          <maml:description>

            <maml:para>Aggregate queries in partitioned collections will require parallel requests for different partition ranges. Set this to the number of parallel request to be issued in the same time.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Offline</maml:name>

          <maml:description>

            <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Other</maml:name>

          <maml:description>

            <maml:para>These hidden properties are used only in specific use cases.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Pagesize</maml:name>

          <maml:description>

            <maml:para>The maximum number of results to return per page from Cosmos DB.</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ProxyAuthScheme</maml:name>

          <maml:description>

            <maml:para>The authentication type to use to authenticate to the ProxyServer proxy.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ProxyAutoDetect</maml:name>

          <maml:description>

            <maml:para>This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ProxyExceptions</maml:name>

          <maml:description>

            <maml:para>A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ProxyPassword</maml:name>

          <maml:description>

            <maml:para>A password to be used to authenticate to the ProxyServer proxy.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ProxyPort</maml:name>

          <maml:description>

            <maml:para>The TCP port the ProxyServer proxy is running on.</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ProxyServer</maml:name>

          <maml:description>

            <maml:para>The hostname or IP address of a proxy to route HTTP traffic through.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ProxySSLType</maml:name>

          <maml:description>

            <maml:para>The SSL type to use when connecting to the ProxyServer proxy.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>ProxyUser</maml:name>

          <maml:description>

            <maml:para>A user name to be used to authenticate to the ProxyServer proxy.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>PseudoColumns</maml:name>

          <maml:description>

            <maml:para>This property indicates whether or not to include pseudo columns as columns to the table.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Readonly</maml:name>

          <maml:description>

            <maml:para>You can use this property to enforce read-only access to Cosmos DB from the provider.</maml:para>

          </maml:description>

          <command:parameterValue >

            SwitchParameter

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>RowScanDepth</maml:name>

          <maml:description>

            <maml:para>The maximum number of rows to scan to look for the columns available in a table.</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>RTK</maml:name>

          <maml:description>

            <maml:para>The runtime key used for licensing.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Schema</maml:name>

          <maml:description>

            <maml:para>Specify the Cosmos DB database you want to work with.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SeparatorCharacter</maml:name>

          <maml:description>

            <maml:para>The character or characters used to denote hierarchy.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SetPartitionKeyAsPK</maml:name>

          <maml:description>

            <maml:para>Whether or not to use the collection's Partition Key field as part of composite Primary Key for the corresponding exposed table.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SSLClientCert</maml:name>

          <maml:description>

            <maml:para>The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SSLClientCertPassword</maml:name>

          <maml:description>

            <maml:para>The password for the TLS/SSL client certificate.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SSLClientCertSubject</maml:name>

          <maml:description>

            <maml:para>The subject of the TLS/SSL client certificate.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SSLClientCertType</maml:name>

          <maml:description>

            <maml:para>The type of key store containing the TLS/SSL client certificate.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SSLServerCert</maml:name>

          <maml:description>

            <maml:para>The certificate to be accepted from the server when connecting using TLS/SSL.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>SupportEnhancedSQL</maml:name>

          <maml:description>

            <maml:para>This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.</maml:para>

          </maml:description>

          <command:parameterValue >

            bool

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Tables</maml:name>

          <maml:description>

            <maml:para>This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Timeout</maml:name>

          <maml:description>

            <maml:para>The value in seconds until the timeout error is thrown, canceling the operation.</maml:para>

          </maml:description>

          <command:parameterValue >

            int

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>TokenType</maml:name>

          <maml:description>

            <maml:para>Denotes the type of token: master or resource.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>TypeDetectionScheme</maml:name>

          <maml:description>

            <maml:para>Comma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Verbosity</maml:name>

          <maml:description>

            <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Views</maml:name>

          <maml:description>

            <maml:para>Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true">

      <maml:name>AccountEndpoint</maml:name>

      <maml:description>

        <maml:para>The value should be the Cosmos DB account URL from the Keys blade of the Cosmos DB account.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true">

      <maml:name>AccountKey</maml:name>

      <maml:description>

        <maml:para>A master key token or a resource token for connecting to the Cosmos DB REST API.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>AutoCache</maml:name>

      <maml:description>

        <maml:para>Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>BrowsableSchemas</maml:name>

      <maml:description>

        <maml:para>This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>CacheLocation</maml:name>

      <maml:description>

        <maml:para>Specifies the path to the cache when caching to a file.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "%APPDATA%\\CData\\CosmosDB Data Provider"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>CacheMetadata</maml:name>

      <maml:description>

        <maml:para>This property determines whether or not to cache the table metadata to a file store.</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>CacheTolerance</maml:name>

      <maml:description>

        <maml:para>The tolerance for stale data in the cache specified in seconds when using AutoCache .</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        600

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>CalculateAggregates</maml:name>

      <maml:description>

        <maml:para>Specifies whether will return the calculated value of the aggregates or grouped by partiton range.</maml:para>

      </maml:description>

      <command:parameterValue  >

        bool

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        true

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true">

      <maml:name>ConsistencyLevel</maml:name>

      <maml:description>

        <maml:para>Denotes the type of token: master or resource.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>STRONG</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>BOUNDED</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>SESSION</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>CONSISTENTPREFIX</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>EVENTUAL</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "SESSION"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallPassword</maml:name>

      <maml:description>

        <maml:para>A password used to authenticate to a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallPort</maml:name>

      <maml:description>

        <maml:para>The TCP port for a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        0

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallServer</maml:name>

      <maml:description>

        <maml:para>The name or IP address of a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallType</maml:name>

      <maml:description>

        <maml:para>The protocol used by a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>NONE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>TUNNEL</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>SOCKS4</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>SOCKS5</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "NONE"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FirewallUser</maml:name>

      <maml:description>

        <maml:para>The user name to use to authenticate with a proxy-based firewall.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FlattenArrays</maml:name>

      <maml:description>

        <maml:para>By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "0"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>FlattenObjects</maml:name>

      <maml:description>

        <maml:para>Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.</maml:para>

      </maml:description>

      <command:parameterValue  >

        bool

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        true

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>GenerateSchemaFiles</maml:name>

      <maml:description>

        <maml:para>Indicates the user preference as to when schemas should be generated and saved.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>Never</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>OnUse</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>OnStart</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>OnCreate</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "Never"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Location</maml:name>

      <maml:description>

        <maml:para>A path to the directory that contains the schema files defining tables, views, and stored procedures.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "%APPDATA%\\CData\\CosmosDB Data Provider\\Schema"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Logfile</maml:name>

      <maml:description>

        <maml:para>A filepath which designates the name and location of the log file.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>LogModules</maml:name>

      <maml:description>

        <maml:para>Core modules to be included in the log file.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>MaxLogFileCount</maml:name>

      <maml:description>

        <maml:para>A string specifying the maximum file count of log files.</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        -1

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>MaxLogFileSize</maml:name>

      <maml:description>

        <maml:para>A string specifying the maximum size in bytes for a log file (for example, 10 MB).</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "100MB"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>MaxRows</maml:name>

      <maml:description>

        <maml:para>Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        -1

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>MultiThreadCount</maml:name>

      <maml:description>

        <maml:para>Aggregate queries in partitioned collections will require parallel requests for different partition ranges. Set this to the number of parallel request to be issued in the same time.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "5"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Offline</maml:name>

      <maml:description>

        <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Other</maml:name>

      <maml:description>

        <maml:para>These hidden properties are used only in specific use cases.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Pagesize</maml:name>

      <maml:description>

        <maml:para>The maximum number of results to return per page from Cosmos DB.</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        1000

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>ProxyAuthScheme</maml:name>

      <maml:description>

        <maml:para>The authentication type to use to authenticate to the ProxyServer proxy.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>BASIC</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>DIGEST</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>NONE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>NEGOTIATE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>NTLM</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>PROPRIETARY</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "BASIC"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>ProxyAutoDetect</maml:name>

      <maml:description>

        <maml:para>This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.</maml:para>

      </maml:description>

      <command:parameterValue  >

        bool

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        true

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>ProxyExceptions</maml:name>

      <maml:description>

        <maml:para>A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>ProxyPassword</maml:name>

      <maml:description>

        <maml:para>A password to be used to authenticate to the ProxyServer proxy.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>ProxyPort</maml:name>

      <maml:description>

        <maml:para>The TCP port the ProxyServer proxy is running on.</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        80

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>ProxyServer</maml:name>

      <maml:description>

        <maml:para>The hostname or IP address of a proxy to route HTTP traffic through.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>ProxySSLType</maml:name>

      <maml:description>

        <maml:para>The SSL type to use when connecting to the ProxyServer proxy.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>AUTO</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>ALWAYS</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>NEVER</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>TUNNEL</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "AUTO"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>ProxyUser</maml:name>

      <maml:description>

        <maml:para>A user name to be used to authenticate to the ProxyServer proxy.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>PseudoColumns</maml:name>

      <maml:description>

        <maml:para>This property indicates whether or not to include pseudo columns as columns to the table.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Readonly</maml:name>

      <maml:description>

        <maml:para>You can use this property to enforce read-only access to Cosmos DB from the provider.</maml:para>

      </maml:description>

      <command:parameterValue  >

        SwitchParameter

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        false

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>RowScanDepth</maml:name>

      <maml:description>

        <maml:para>The maximum number of rows to scan to look for the columns available in a table.</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        100

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>RTK</maml:name>

      <maml:description>

        <maml:para>The runtime key used for licensing.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Schema</maml:name>

      <maml:description>

        <maml:para>Specify the Cosmos DB database you want to work with.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SeparatorCharacter</maml:name>

      <maml:description>

        <maml:para>The character or characters used to denote hierarchy.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "."

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SetPartitionKeyAsPK</maml:name>

      <maml:description>

        <maml:para>Whether or not to use the collection's Partition Key field as part of composite Primary Key for the corresponding exposed table.</maml:para>

      </maml:description>

      <command:parameterValue  >

        bool

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        true

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SSLClientCert</maml:name>

      <maml:description>

        <maml:para>The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SSLClientCertPassword</maml:name>

      <maml:description>

        <maml:para>The password for the TLS/SSL client certificate.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SSLClientCertSubject</maml:name>

      <maml:description>

        <maml:para>The subject of the TLS/SSL client certificate.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "*"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SSLClientCertType</maml:name>

      <maml:description>

        <maml:para>The type of key store containing the TLS/SSL client certificate.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>USER</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>MACHINE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>PFXFILE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>PFXBLOB</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>JKSFILE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>JKSBLOB</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>PEMKEY_FILE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>PEMKEY_BLOB</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>PUBLIC_KEY_FILE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>PUBLIC_KEY_BLOB</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>SSHPUBLIC_KEY_FILE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>SSHPUBLIC_KEY_BLOB</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>P7BFILE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>PPKFILE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>XMLFILE</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>XMLBLOB</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "USER"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SSLServerCert</maml:name>

      <maml:description>

        <maml:para>The certificate to be accepted from the server when connecting using TLS/SSL.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>SupportEnhancedSQL</maml:name>

      <maml:description>

        <maml:para>This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.</maml:para>

      </maml:description>

      <command:parameterValue  >

        bool

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        true

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Tables</maml:name>

      <maml:description>

        <maml:para>This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Timeout</maml:name>

      <maml:description>

        <maml:para>The value in seconds until the timeout error is thrown, canceling the operation.</maml:para>

      </maml:description>

      <command:parameterValue  >

        int

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        60

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true">

      <maml:name>TokenType</maml:name>

      <maml:description>

        <maml:para>Denotes the type of token: master or resource.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:possibleValues>

        <dev:possibleValue>

          <dev:value>master</dev:value>

        </dev:possibleValue>

        <dev:possibleValue>

          <dev:value>resource</dev:value>

        </dev:possibleValue>

      </dev:possibleValues>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "master"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>TypeDetectionScheme</maml:name>

      <maml:description>

        <maml:para>Comma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "RowScan,Recent"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Verbosity</maml:name>

      <maml:description>

        <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        "1"

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter >

      <maml:name>Views</maml:name>

      <maml:description>

        <maml:para>Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

    <command:returnValue>

      <dev:type>

        <maml:name>CData.CosmosDBCmdlets.Commands.CosmosDBPSConnection</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The Cosmos DB connection object.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The CosmosDBConnection object may be passed to related cmdlets to use the connection.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Select-CosmosDB

    </command:name>

    <maml:description>

      <maml:para>Searches Cosmos DB data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2021 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Select</command:verb>

    <command:noun>CosmosDB</command:noun>

    <dev:version>21.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Searches Cosmos DB data. The Select-CosmosDB cmdlet allows you to use a syntax similar to SQL SELECT statements to search Cosmos DB data.</maml:para><maml:para>$conn = Connect-CosmosDB -AccountEndpoint "myAccountEndpoint" -AccountKey "myAccountKey"</maml:para><maml:para>Select-CosmosDB -Connection $conn -Table "[CData].[Entities].Customers" -Columns @("City","CompanyName") -Where "Country='US'"</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Select-CosmosDB [parameters]</maml:name>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Columns</maml:name>

          <maml:description>

            <maml:para>The columns to return.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>GroupBy</maml:name>

          <maml:description>

            <maml:para>A comma-separated list of columns that the result set will be grouped by.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>OrderBy</maml:name>

          <maml:description>

            <maml:para>The order in which columns will be returned.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Params</maml:name>

          <maml:description>

            <maml:para>The parameters that will be used for the query.</maml:para>

          </maml:description>

          <command:parameterValue >

            Hashtable

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Where</maml:name>

          <maml:description>

            <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Columns</maml:name>

      <maml:description>

        <maml:para>The columns to return.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>GroupBy</maml:name>

      <maml:description>

        <maml:para>A comma-separated list of columns that the result set will be grouped by.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>OrderBy</maml:name>

      <maml:description>

        <maml:para>The order in which columns will be returned.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Params</maml:name>

      <maml:description>

        <maml:para>The parameters that will be used for the query.</maml:para>

      </maml:description>

      <command:parameterValue  >

        Hashtable

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Where</maml:name>

      <maml:description>

        <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>QueryResults</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The results of the query.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The results of the query.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Sync-CosmosDB

    </command:name>

    <maml:description>

      <maml:para>Syncs Cosmos DB data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2021 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Sync</command:verb>

    <command:noun>CosmosDB</command:noun>

    <dev:version>21.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Syncs Cosmos DB data. The Sync-CosmosDB cmdlet allows you to replicate a data source locally and maintain it with the full caching functionality of the provider.</maml:para><maml:para>$conn = Connect-CosmosDB -AccountEndpoint "myAccountEndpoint" -AccountKey "myAccountKey"</maml:para><maml:para>Sync-CosmosDB -Connection $conn -Table "[CData].[Entities].Customers"</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Sync-CosmosDB [parameters]</maml:name>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Columns</maml:name>

          <maml:description>

            <maml:para>The columns to sync.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="true"

          position="named">

          <maml:name>DestinationTable</maml:name>

          <maml:description>

            <maml:para>The table where the data will be placed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Params</maml:name>

          <maml:description>

            <maml:para>The parameters that will be used for the query.</maml:para>

          </maml:description>

          <command:parameterValue >

            Hashtable

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Columns</maml:name>

      <maml:description>

        <maml:para>The columns to sync.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="true"

  position="named" >

      <maml:name>DestinationTable</maml:name>

      <maml:description>

        <maml:para>The table where the data will be placed.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Params</maml:name>

      <maml:description>

        <maml:para>The parameters that will be used for the query.</maml:para>

      </maml:description>

      <command:parameterValue  >

        Hashtable

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>AffectedRowsCount</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The number of rows affected by the operation.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The number of rows affected by the operation.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

  <command:details>

    <command:name>

      Update-CosmosDB

    </command:name>

    <maml:description>

      <maml:para>Updates Cosmos DB data.</maml:para>

    </maml:description>

    <maml:copyright>

      <maml:para>Copyright (c) 2021 CData Software, Inc. - All rights reserved.</maml:para>

    </maml:copyright>

    <command:verb>Update</command:verb>

    <command:noun>CosmosDB</command:noun>

    <dev:version>21.0</dev:version>

  </command:details>

  <maml:description>

    <maml:para>Updates Cosmos DB data. The Update-CosmosDB cmdlet allows you to use a syntax similar to SQL UPDATE statements to update Cosmos DB data.</maml:para><maml:para>$conn = Connect-CosmosDB -AccountEndpoint "myAccountEndpoint" -AccountKey "myAccountKey"</maml:para><maml:para>Update-CosmosDB -Connection $conn -Table "[CData].[Entities].Customers" -Columns @("CompanyName") -Values @("Jon Deere") -Id "22"</maml:para><maml:para></maml:para><maml:para>The Where parameter can also be used to specify the primary key of the table:</maml:para><maml:para></maml:para><maml:para>Update-CosmosDB -Connection $conn -Table "[CData].[Entities].Customers" -Columns @("CompanyName") -Values @("Jon Deere") -Where "_id = '22'"</maml:para><maml:para></maml:para><maml:para>The primary key can also be passed to the cmdlet along the pipeline:</maml:para><maml:para></maml:para><maml:para>Select-CosmosDB -Connection $conn -Table [CData].[Entities].Customers -Where "Country = 'US'" | Update-CosmosDB -Columns @("Country") -Values @("US 2")</maml:para><maml:para></maml:para><maml:para></maml:para>

  </maml:description>

  <!-- Cmdlet syntax section-->    

  <command:syntax>

      <command:syntaxItem>

        <maml:name>Update-CosmosDB [parameters]</maml:name>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Columns</maml:name>

          <maml:description>

            <maml:para>The columns on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="0">

          <maml:name>Connection</maml:name>

          <maml:description>

            <maml:para>The connection object.</maml:para>

          </maml:description>

          <command:parameterValue >

            DataConnection

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="true"

          position="named">

          <maml:name>Id</maml:name>

          <maml:description>

            <maml:para>The Id of the item on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="true"

          position="named">

          <maml:name>Table</maml:name>

          <maml:description>

            <maml:para>The table on which the operation will be performed.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="true"

          pipelineInput="false"

          position="named">

          <maml:name>Values</maml:name>

          <maml:description>

            <maml:para>The values that will be used to update the table.</maml:para>

          </maml:description>

          <command:parameterValue >

            string[]

          </command:parameterValue>

        </command:parameter>

        <command:parameter required="false"

          pipelineInput="false"

          position="named">

          <maml:name>Where</maml:name>

          <maml:description>

            <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

          </maml:description>

          <command:parameterValue >

            string

          </command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

  <!-- Cmdlet parameter section  --> 

    <command:parameters>

  <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Columns</maml:name>

      <maml:description>

        <maml:para>The columns on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position=0 >

      <maml:name>Connection</maml:name>

      <maml:description>

        <maml:para>The connection object.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        DataConnection

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="true"

  position="named" >

      <maml:name>Id</maml:name>

      <maml:description>

        <maml:para>The Id of the item on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="true"

  position="named" >

      <maml:name>Table</maml:name>

      <maml:description>

        <maml:para>The table on which the operation will be performed.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter required="true"

  pipelineInput="false"

  position="named" >

      <maml:name>Values</maml:name>

      <maml:description>

        <maml:para>The values that will be used to update the table.</maml:para>

      </maml:description>

      <command:parameterValue required="true" >

        string[]

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        null

      </dev:defaultValue>

    </command:parameter>    

      <command:parameter 

  pipelineInput="false"

  position="named" >

      <maml:name>Where</maml:name>

      <maml:description>

        <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para>

      </maml:description>

      <command:parameterValue  >

        string

      </command:parameterValue>

      <dev:type>

        <maml:name>System.String</maml:name>

        <maml:uri/>

      </dev:type>

      <dev:defaultValue>

        ""

      </dev:defaultValue>

    </command:parameter>    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>

      <command:returnValue>

      <dev:type>

        <maml:name>AffectedRowsCount</maml:name>

        <maml:uri />

        <maml:description>

          <maml:para>

            The number of rows affected by the operation.

          </maml:para>

        </maml:description>

      </dev:type>   

      <maml:description>

        The number of rows affected by the operation.

      </maml:description> 

    </command:returnValue>

  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>

    <maml:navigationLink>

      <maml:linkText></maml:linkText>

      <maml:uri/>

    </maml:navigationLink>

  </maml:relatedLinks>

</command:command>

</helpItems>