New-AzCosmosDBSqlIncludedPath

Reference

Module:: Az.CosmosDB

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

Syntax

New-AzCosmosDBSqlIncludedPath
   [-Path <String>]
   [-Index <PSIndexes[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Object corresponding to Sql API's IncludedPath.

Examples

Example 1

$index1 = New-AzCosmosDBSqlIncludedPathIndex -DataType String -Precision -1 -Kind Hash
$index2 = New-AzCosmosDBSqlIncludedPathIndex -DataType String -Precision -1 -Kind Hash

New-AzCosmosDBSqlIncludedPath -Path "/*" -Index $index1,$index2

Path Indexes
---- -------
/*   {Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes,Microsoft.Azure.Commands.CosmosDB.Models.PSIndexes}

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

-Index

List of indexes for this path

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

-Path

The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

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

Inputs

None

Outputs

PSIncludedPath

Share via