Skip to content

Get CosmosDbPermission

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-CosmosDbPermission

SYNOPSIS

Return the permissions for a Cosmos DB database user.

SYNTAX

Context (Default)

Get-CosmosDbPermission -Context <Context> [-Key <SecureString>] [-KeyType <String>] [-Database <String>]
 -UserId <String> [-Id <String>] [-TokenExpiry <Int32>] [<CommonParameters>]

Account

Get-CosmosDbPermission -Account <String> [-Key <SecureString>] [-KeyType <String>] [-Database <String>]
 -UserId <String> [-Id <String>] [-TokenExpiry <Int32>] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

Example 1

PS C:\> Get-CosmosDbPermission -Context $cosmosDbContext -UserId 'MyApplication'

Get a list of permissions for a user 'MyApplication' in the database.

Example 2

PS C:\> Get-CosmosDbPermission -Context $cosmosDbContext -UserId 'MyApplication' -Id 'read'

Get the 'read' permission for a user 'MyApplication' 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

This is the id of the permission 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

-TokenExpiry

This is the number of seconds that the resource token for each permission will expire in. If not specified the default value of 3600 seconds (1 hour) is used.

The minimum token expiry is 600 seconds and the maximum token expiry is 18000 seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-UserId

This is the id of the user to get the permissions for.

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