New-AzCosmosDBSqlCompositePath

Module:

Az.CosmosDB

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

Syntax

New-AzCosmosDBSqlCompositePath
   [-Path <String>]
   [-Order <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Object corresponding to Sql API's CompositePath.

Examples

Example 1

New-AzCosmosDBSqlCompositePath -Path "/abc" -Order Ascending

Path Order
---- -----
/abc Ascending

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

-Order

Gets or sets sort order for composite paths. Possible values include: 'Ascending', 'Descending'

Type:	String
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

PSCompositePath