Get-AzCosmosDBGremlinGraph

  • Reference
Module:
Az.CosmosDB

Gets the CosmosDB Gremlin Graph.

Syntax

Get-AzCosmosDBGremlinGraph
   -ResourceGroupName <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   -AccountName <String>
   -DatabaseName <String>
   [<CommonParameters>]
Get-AzCosmosDBGremlinGraph
   [-Name <String>]
   -ParentObject <PSGremlinDatabaseGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzCosmosDBGremlinGraph cmdlet gets the CosmosDB Gremlin Graph properties.

Examples

Example 1

Get-AzCosmosDBGremlinGraph -ResourceGroupName "rgName" -AccountName "accountName" -DatabaseName "dbName" -Name "graphName"

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

Resource Object contains IndexingPolicy, PartitionKey, DefaultTtl, UniqueKeyPolicy, ConflictResolutionPolicy, _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

-DatabaseName

Database name.

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

Gremlin Graph Name.

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

-ParentObject

Gremlin Database object.

Type:PSGremlinDatabaseGetResults
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

PSGremlinDatabaseGetResults

Outputs

PSGremlinGraphGetResults

PSThroughputSettingsGetResults