CosmosPrimitiveCollectionBuilderExtensions.ToJsonProperty Method

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.Cosmos.dll

Package:

Microsoft.EntityFrameworkCore.Cosmos v8.0.0

Overloads

ToJsonProperty(PrimitiveCollectionBuilder, String)	Configures the property name that the property is mapped to when targeting Azure Cosmos.
ToJsonProperty<TProperty>(PrimitiveCollectionBuilder<TProperty>, String)	Configures the property name that the property is mapped to when targeting Azure Cosmos.

ToJsonProperty(PrimitiveCollectionBuilder, String)

Configures the property name that the property is mapped to when targeting Azure Cosmos.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder ToJsonProperty (this Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder primitiveCollectionBuilder, string name);

static member ToJsonProperty : Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder * string -> Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder

<Extension()>
Public Function ToJsonProperty (primitiveCollectionBuilder As PrimitiveCollectionBuilder, name As String) As PrimitiveCollectionBuilder

Parameters

primitiveCollectionBuilder

PrimitiveCollectionBuilder

The builder for the property being configured.

name

String

The name of the property.

Returns

PrimitiveCollectionBuilder

The same builder instance so that multiple calls can be chained.

Remarks

If an empty string is supplied, the property will not be persisted.

See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.

ToJsonProperty<TProperty>(PrimitiveCollectionBuilder<TProperty>, String)

Configures the property name that the property is mapped to when targeting Azure Cosmos.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder<TProperty> ToJsonProperty<TProperty> (this Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder<TProperty> primitiveCollectionBuilder, string name);

static member ToJsonProperty : Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder<'Property> * string -> Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder<'Property>

<Extension()>
Public Function ToJsonProperty(Of TProperty) (primitiveCollectionBuilder As PrimitiveCollectionBuilder(Of TProperty), name As String) As PrimitiveCollectionBuilder(Of TProperty)

Type Parameters

TProperty

The type of the property being configured.

Parameters

primitiveCollectionBuilder

PrimitiveCollectionBuilder<TProperty>

The builder for the property being configured.

name

String

The name of the property.

Returns

PrimitiveCollectionBuilder<TProperty>

The same builder instance so that multiple calls can be chained.

Remarks

See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.