New-AzCosmosDBSqlIncludedPathIndex

  • Reference
Module:
Az.CosmosDB

Creates a new object of type PSIndexes. It can be passed as a parameter value for Set-AzCosmosDBSqlIncludedPath.

Syntax

New-AzCosmosDBSqlIncludedPathIndex
   -DataType <String>
   [-Precision <Int32>]
   -Kind <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Object corresponding to Sql API's IncludedPath's Indexes.

Examples

Example 1

New-AzCosmosDBSqlIncludedPathIndex -DataType String -Precision -1 -Kind Hash

DataType Precision Kind
-------- --------- ----
String          -1 Hash

Parameters

-DataType

Datatype for which the indexing behavior is applied to. Possible values include: 'String', 'Number', 'Point', 'Polygon', 'LineString', 'MultiPolygon'

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Kind

Indicates the type of index. Possible values include: 'Hash', 'Range', 'Spatial'

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Precision

The precision of the index. -1 is maximum precision.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

PSIndexes