QueryDefinition.WithParameter(String, Object) Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: QueryDefinition.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Add parameters to the SQL query

public Microsoft.Azure.Cosmos.QueryDefinition WithParameter (string name, object value);

member this.WithParameter : string * obj -> Microsoft.Azure.Cosmos.QueryDefinition

Public Function WithParameter (name As String, value As Object) As QueryDefinition

Parameters

name: String

The name of the parameter.

value: Object

The value for the parameter.

Returns

QueryDefinition

An instance of QueryDefinition.

Examples

QueryDefinition query = new QueryDefinition(
    "select * from t where t.Account = @account")
    .WithParameter("@account", "12345");

Remarks

If the same name is added again it will replace the original value

Applies to