Skip to content

Get CosmosDbUserDefinedFunction

Daniel Scott-Raynsford edited this page Dec 23, 2018 · 4 revisions

external help file: CosmosDB-help.xml Module Name: CosmosDB online version: schema: 2.0.0

Get-CosmosDbUserDefinedFunction

SYNOPSIS

Return the user defined functions for a Cosmos DB database collection.

SYNTAX

Context (Default)

Get-CosmosDbUserDefinedFunction -Context <Context> [-Key <SecureString>] [-KeyType <String>]
 [-Database <String>] -CollectionId <String> [-Id <String>] [<CommonParameters>]

Account

Get-CosmosDbUserDefinedFunction -Account <String> [-Key <SecureString>] [-KeyType <String>]
 [-Database <String>] -CollectionId <String> [-Id <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet will return the user defined functions for a specified collection in a Cosmos DB database. If an Id is specified then only the specified user defined functions will be returned.

EXAMPLES

Example 1

PS C:\> Get-CosmosDbUserDefinedFunction -Context $cosmosDbContext -CollectionId 'MyNewCollection'

Get a list of user defined functions for a collection in the database.

Example 2

PS C:\> Get-CosmosDbUserDefinedFunction -Context $cosmosDbContext -CollectionId 'MyNewCollection' -Id 'myudf'

Get the 'myudf' user defined function from a collection in the database.

PARAMETERS

-Account

The account name of the Cosmos DB to access.

Type: String
Parameter Sets: Account
Aliases:

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

-CollectionId

This is the id of the collection to get the user defined function for.

Type: String
Parameter Sets: (All)
Aliases:

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

-Context

This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by `New-CosmosDbContext`.

Type: Context
Parameter Sets: Context
Aliases: Connection

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

-Database

The name of the database to access in the Cosmos DB account.

Type: String
Parameter Sets: (All)
Aliases:

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

-Id

This is the id of the user defined functions to return.

Type: String
Parameter Sets: (All)
Aliases:

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

-Key

The key to be used to access this Cosmos DB.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-KeyType

The type of key that will be used to access ths Cosmos DB.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: master, resource

Required: False
Position: Named
Default value: Master
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

System.Object

NOTES

RELATED LINKS

CosmosDB Cmdlets

Clone this wiki locally