New-AzCosmosDBGremlinIndexingPolicy
Creates a new CosmosDB IndexingPolicy object.
Syntax
New-AzCosmosDBGremlinIndexingPolicy
[-IncludedPath <PSIncludedPath[]>]
[-SpatialSpec <PSSpatialSpec[]>]
[-CompositePath <PSCompositePath[][]>]
[-ExcludedPath <String[]>]
[-Automatic <Boolean>]
[-IndexingMode <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The New-AzCosmosDBGremlinIndexingPolicy cmdlet creates a new object of type PSIndexingPolicy.
Examples
Example 1
$ipath1 = New-AzCosmosDBGremlinIncludedPathIndex -DataType String -Precision -1 -Kind Hash
$ipath2 = New-AzCosmosDBGremlinIncludedPathIndex -DataType String -Precision -1 -Kind Hash
$IncludedPath = New-AzCosmosDBGremlinIncludedPath -Path "/*" -Index $ipath1, $ipath2
$SpatialSpec = New-AzCosmosDBGremlinSpatialSpec -Path "/mySpatialPath/*" -Type "Point", "LineString", "Polygon", "MultiPolygon"
$cp1 = New-AzCosmosDBGremlinCompositePath -Path "/abc" -Order Ascending
$cp2 = New-AzCosmosDBGremlinCompositePath -Path "/aberc" -Order Descending
$compositePath = (($cp1, $cp2), ($cp2, $cp1))
New-AzCosmosDBGremlinIndexingPolicy -IncludedPath $IncludedPath -SpatialSpec $SpatialSpec -CompositePath $compositePath -ExcludedPath "/myPathToNotIndex/*" -Automatic 1 -IndexingMode Consistent
Automatic : True
IndexingMode : Consistent
IncludedPaths : {Microsoft.Azure.Commands.CosmosDB.Models.PSIncludedPath}
ExcludedPaths : {Microsoft.Azure.Commands.CosmosDB.Models.PSExcludedPath}
CompositeIndexes : {Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath,
Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath Microsoft.Azure.Commands.CosmosDB.Models.PSCompositePath}
SpatialIndexes : {Microsoft.Azure.Commands.CosmosDB.Models.PSSpatialSpec}Parameters
-Automatic
Bool to indicate if the indexing policy is automatic
| Type: | Nullable<T>[Boolean] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CompositePath
Array of array of objects of type Microsoft.Azure.Commands.CosmosDB.PSCompositePath
| Type: | PSCompositePath[][] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-ExcludedPath
Array of strings containing excludedPath(Specifies a path within a JSON document to be excluded in the Azure Cosmos DB service.) elements.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludedPath
Array of strings containing includedPath (Specifies a path within a JSON document to be included in the Azure Cosmos DB service.) elements.
| Type: | PSIncludedPath[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IndexingMode
Indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SpatialSpec
Array of objects of type Microsoft.Azure.Commands.CosmosDB.PSSpatialSpec
| Type: | PSSpatialSpec[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
