Edit

Share via

New-AzCosmosDBGremlinSpatialSpec

  • Reference
Module:
Az.CosmosDB

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

Syntax

New-AzCosmosDBGremlinSpatialSpec
   -Path <String>
   -Type <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Creates Object corresponding to Gremlin API's SpatialSpec.

Examples

Example 1

New-AzCosmosDBGremlinSpatialSpec -Path "/abc" -Type String

Path Types
---- -----
/abc {String}

Parameters

-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

-Path

Path in JSON document to index.

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

-Type

Array of strings with acceptable values: Point, LineString, Polygon, MultiPolygon. Represent's paths spatial type.

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

Inputs

None

Outputs

PSSpatialSpec