Get-AzCosmosDBGremlinDatabase

  • Reference
Module:
Az.CosmosDB

Gets the CosmosDB Gremlin Database.

Syntax

Get-AzCosmosDBGremlinDatabase
   -ResourceGroupName <String>
   -AccountName <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzCosmosDBGremlinDatabase
   [-Name <String>]
   -ParentObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzCosmosDBGremlinDatabase cmdlet gets the CosmosDB Gremlin Database.

Examples

Example 1

Get-AzCosmosDBGremlinDatabase -ResourceGroupName "rgName" -AccountName "accountName" -Name "databaseName"

Name    Id   Resource
{name}  {id} Microsoft.Azure.Commands.CosmosDB.Models.PSGremlinDatabaseGetPropertiesResource

Resource Object contains _rid, _ts, _etag.

Parameters

-AccountName

Name of the Cosmos DB database account.

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

-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

-Name

Database name.

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

-ParentObject

CosmosDB Account object

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

-ResourceGroupName

Name of resource group.

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

Inputs

Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount

Outputs

PSGremlinDatabaseGetResults

PSThroughputSettingsGetResults