Skip to content

Set CosmosDbUser

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

Set-CosmosDbUser

SYNOPSIS

Set the user Id of an existing user in a Cosmos DB database.

SYNTAX

Context (Default)

Set-CosmosDbUser -Context <Context> [-Database <String>] [-Key <SecureString>] -Id <String> -NewId <String>
 [<CommonParameters>]

Account

Set-CosmosDbUser -Account <String> [-Database <String>] [-Key <SecureString>] [-KeyType <String>] -Id <String>
 -NewId <String> [<CommonParameters>]

DESCRIPTION

This cmdlet will set the user Id of an existing user in a Cosmos DB.

EXAMPLES

Example 1

PS C:\> Set-CosmosDbUser -Context $cosmosDbContext -Id 'Mary' -NewId 'Sam'

Rename the user 'Mary' to 'Sam' 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

-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

The user Id of the user to set.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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: Account
Aliases:
Accepted values: master, resource

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

-NewId

This is the new Id of rhe user.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
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