Get-AzCosmosDBMongoDBUserDefinition.md

external help file	Module Name	online version	schema
Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml	Az.CosmosDB	https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbuserdefinition	2.0.0

Get-AzCosmosDBMongoDBUserDefinition

SYNOPSIS

Gets the CosmosDB MongoDB User Definition.

SYNTAX

ByNameParameterSet (Default)

Get-AzCosmosDBMongoDBUserDefinition -ResourceGroupName <String> -AccountName <String> [-Id <String>]
 [-DatabaseName <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

ByParentObjectParameterSet

Get-AzCosmosDBMongoDBUserDefinition [-Id <String>] [-DatabaseName <String>]
 -DatabaseAccountObject <PSDatabaseAccountGetResults> [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

DESCRIPTION

The Get-AzCosmosDBMongoDBUserDefinition cmdlet gets the list of all existing CosmosDB MongoDB API User Definitions for a given ResourceGroupName, AccountName and gets a single CosmosDB Mongo API Database for a given ResourceGroupName, AccountName, and Id. Id can be either fully qualified or just the id string.

EXAMPLES

Example 1

Get-AzCosmosDBMongoDBUserDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id

Id           : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbUserDefinitions/id
UserName     : test_user_name
Password     :
Mechanisms   : SCRAM-SHA-256
DatabaseName : test
CustomData   :
Roles        : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role}

Get Mongo User Definition for the given Resource Group and Account and User id.

PARAMETERS

-AccountName

Name of the Cosmos DB database account.

Type: System.String
Parameter Sets: ByNameParameterSet
Aliases:

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

-DatabaseAccountObject

CosmosDB Account object

Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults
Parameter Sets: ByParentObjectParameterSet
Aliases:

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

-DatabaseName

Database Name for the MongoDB Role Definition.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-Id

User Definition Id.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-ResourceGroupName

Name of resource group.

Type: System.String
Parameter Sets: ByNameParameterSet
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.

INPUTS

None

OUTPUTS

Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults

NOTES

RELATED LINKS

New-AzCosmosDBMongoDBRoleDefinition

Update-AzCosmosDBMongoDBRoleDefinition

Remove-AzCosmosDBMongoDBRoleDefinition