1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getDatabaseAccountGremlinGraph
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.cosmosdb.getDatabaseAccountGremlinGraph

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Gets the Gremlin graph under an existing Azure Cosmos DB database account.

    Uses Azure REST API version 2016-03-31.

    Other available API versions: 2015-04-01, 2015-04-08, 2015-11-06, 2016-03-19. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

    Using getDatabaseAccountGremlinGraph

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDatabaseAccountGremlinGraph(args: GetDatabaseAccountGremlinGraphArgs, opts?: InvokeOptions): Promise<GetDatabaseAccountGremlinGraphResult>
function getDatabaseAccountGremlinGraphOutput(args: GetDatabaseAccountGremlinGraphOutputArgs, opts?: InvokeOptions): Output<GetDatabaseAccountGremlinGraphResult>
    def get_database_account_gremlin_graph(account_name: Optional[str] = None,
                                       database_name: Optional[str] = None,
                                       graph_name: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetDatabaseAccountGremlinGraphResult
def get_database_account_gremlin_graph_output(account_name: Optional[pulumi.Input[str]] = None,
                                       database_name: Optional[pulumi.Input[str]] = None,
                                       graph_name: Optional[pulumi.Input[str]] = None,
                                       resource_group_name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseAccountGremlinGraphResult]
    func LookupDatabaseAccountGremlinGraph(ctx *Context, args *LookupDatabaseAccountGremlinGraphArgs, opts ...InvokeOption) (*LookupDatabaseAccountGremlinGraphResult, error)
func LookupDatabaseAccountGremlinGraphOutput(ctx *Context, args *LookupDatabaseAccountGremlinGraphOutputArgs, opts ...InvokeOption) LookupDatabaseAccountGremlinGraphResultOutput

    > Note: This function is named LookupDatabaseAccountGremlinGraph in the Go SDK.

    public static class GetDatabaseAccountGremlinGraph 
{
    public static Task<GetDatabaseAccountGremlinGraphResult> InvokeAsync(GetDatabaseAccountGremlinGraphArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseAccountGremlinGraphResult> Invoke(GetDatabaseAccountGremlinGraphInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseAccountGremlinGraphResult> getDatabaseAccountGremlinGraph(GetDatabaseAccountGremlinGraphArgs args, InvokeOptions options)
public static Output<GetDatabaseAccountGremlinGraphResult> getDatabaseAccountGremlinGraph(GetDatabaseAccountGremlinGraphArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:cosmosdb:getDatabaseAccountGremlinGraph
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    DatabaseName string
    Cosmos DB database name.
    GraphName string
    Cosmos DB graph name.
    ResourceGroupName string
    Name of an Azure resource group.
    AccountName string
    Cosmos DB database account name.
    DatabaseName string
    Cosmos DB database name.
    GraphName string
    Cosmos DB graph name.
    ResourceGroupName string
    Name of an Azure resource group.
    accountName String
    Cosmos DB database account name.
    databaseName String
    Cosmos DB database name.
    graphName String
    Cosmos DB graph name.
    resourceGroupName String
    Name of an Azure resource group.
    accountName string
    Cosmos DB database account name.
    databaseName string
    Cosmos DB database name.
    graphName string
    Cosmos DB graph name.
    resourceGroupName string
    Name of an Azure resource group.
    account_name str
    Cosmos DB database account name.
    database_name str
    Cosmos DB database name.
    graph_name str
    Cosmos DB graph name.
    resource_group_name str
    Name of an Azure resource group.
    accountName String
    Cosmos DB database account name.
    databaseName String
    Cosmos DB database name.
    graphName String
    Cosmos DB graph name.
    resourceGroupName String
    Name of an Azure resource group.

    getDatabaseAccountGremlinGraph Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    ConflictResolutionPolicy Pulumi.AzureNative.CosmosDB.Outputs.ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    DefaultTtl int
    Default time to live
    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    IndexingPolicy Pulumi.AzureNative.CosmosDB.Outputs.IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
    Location string
    The location of the resource group to which the resource belongs.
    PartitionKey Pulumi.AzureNative.CosmosDB.Outputs.ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    Rid string
    A system generated property. A unique identifier.
    Tags Dictionary<string, string>
    Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
    Ts object
    A system generated property that denotes the last updated timestamp of the resource.
    UniqueKeyPolicy Pulumi.AzureNative.CosmosDB.Outputs.UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    ConflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    DefaultTtl int
    Default time to live
    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    IndexingPolicy IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
    Location string
    The location of the resource group to which the resource belongs.
    PartitionKey ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    Rid string
    A system generated property. A unique identifier.
    Tags map[string]string
    Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
    Ts interface{}
    A system generated property that denotes the last updated timestamp of the resource.
    UniqueKeyPolicy UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The unique resource identifier of the database account.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    conflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    defaultTtl Integer
    Default time to live
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    indexingPolicy IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
    location String
    The location of the resource group to which the resource belongs.
    partitionKey ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    rid String
    A system generated property. A unique identifier.
    tags Map<String,String>
    Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
    ts Object
    A system generated property that denotes the last updated timestamp of the resource.
    uniqueKeyPolicy UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The unique resource identifier of the database account.
    name string
    The name of the database account.
    type string
    The type of Azure resource.
    conflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    defaultTtl number
    Default time to live
    etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    indexingPolicy IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
    location string
    The location of the resource group to which the resource belongs.
    partitionKey ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    rid string
    A system generated property. A unique identifier.
    tags {[key: string]: string}
    Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
    ts any
    A system generated property that denotes the last updated timestamp of the resource.
    uniqueKeyPolicy UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The unique resource identifier of the database account.
    name str
    The name of the database account.
    type str
    The type of Azure resource.
    conflict_resolution_policy ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    default_ttl int
    Default time to live
    etag str
    A system generated property representing the resource etag required for optimistic concurrency control.
    indexing_policy IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
    location str
    The location of the resource group to which the resource belongs.
    partition_key ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    rid str
    A system generated property. A unique identifier.
    tags Mapping[str, str]
    Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
    ts Any
    A system generated property that denotes the last updated timestamp of the resource.
    unique_key_policy UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The unique resource identifier of the database account.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    conflictResolutionPolicy Property Map
    The conflict resolution policy for the graph.
    defaultTtl Number
    Default time to live
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    indexingPolicy Property Map
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
    location String
    The location of the resource group to which the resource belongs.
    partitionKey Property Map
    The configuration of the partition key to be used for partitioning data into multiple partitions
    rid String
    A system generated property. A unique identifier.
    tags Map<String>
    Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
    ts Any
    A system generated property that denotes the last updated timestamp of the resource.
    uniqueKeyPolicy Property Map
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

    Supporting Types

    ConflictResolutionPolicyResponse

    ConflictResolutionPath string
    The conflict resolution path in the case of LastWriterWins mode.
    ConflictResolutionProcedure string
    The procedure to resolve conflicts in the case of custom mode.
    Mode string
    Indicates the conflict resolution mode.
    ConflictResolutionPath string
    The conflict resolution path in the case of LastWriterWins mode.
    ConflictResolutionProcedure string
    The procedure to resolve conflicts in the case of custom mode.
    Mode string
    Indicates the conflict resolution mode.
    conflictResolutionPath String
    The conflict resolution path in the case of LastWriterWins mode.
    conflictResolutionProcedure String
    The procedure to resolve conflicts in the case of custom mode.
    mode String
    Indicates the conflict resolution mode.
    conflictResolutionPath string
    The conflict resolution path in the case of LastWriterWins mode.
    conflictResolutionProcedure string
    The procedure to resolve conflicts in the case of custom mode.
    mode string
    Indicates the conflict resolution mode.
    conflict_resolution_path str
    The conflict resolution path in the case of LastWriterWins mode.
    conflict_resolution_procedure str
    The procedure to resolve conflicts in the case of custom mode.
    mode str
    Indicates the conflict resolution mode.
    conflictResolutionPath String
    The conflict resolution path in the case of LastWriterWins mode.
    conflictResolutionProcedure String
    The procedure to resolve conflicts in the case of custom mode.
    mode String
    Indicates the conflict resolution mode.

    ContainerPartitionKeyResponse

    Kind string
    Indicates the kind of algorithm used for partitioning
    Paths List<string>
    List of paths using which data within the container can be partitioned
    Kind string
    Indicates the kind of algorithm used for partitioning
    Paths []string
    List of paths using which data within the container can be partitioned
    kind String
    Indicates the kind of algorithm used for partitioning
    paths List<String>
    List of paths using which data within the container can be partitioned
    kind string
    Indicates the kind of algorithm used for partitioning
    paths string[]
    List of paths using which data within the container can be partitioned
    kind str
    Indicates the kind of algorithm used for partitioning
    paths Sequence[str]
    List of paths using which data within the container can be partitioned
    kind String
    Indicates the kind of algorithm used for partitioning
    paths List<String>
    List of paths using which data within the container can be partitioned

    ExcludedPathResponse

    Path string
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    Path string
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    path String
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    path string
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    path str
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    path String
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

    IncludedPathResponse

    Indexes List<Pulumi.AzureNative.CosmosDB.Inputs.IndexesResponse>
    List of indexes for this path
    Path string
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    Indexes []IndexesResponse
    List of indexes for this path
    Path string
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    indexes List<IndexesResponse>
    List of indexes for this path
    path String
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    indexes IndexesResponse[]
    List of indexes for this path
    path string
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    indexes Sequence[IndexesResponse]
    List of indexes for this path
    path str
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
    indexes List<Property Map>
    List of indexes for this path
    path String
    The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)

    IndexesResponse

    DataType string
    The datatype for which the indexing behavior is applied to.
    Kind string
    Indicates the type of index.
    Precision int
    The precision of the index. -1 is maximum precision.
    DataType string
    The datatype for which the indexing behavior is applied to.
    Kind string
    Indicates the type of index.
    Precision int
    The precision of the index. -1 is maximum precision.
    dataType String
    The datatype for which the indexing behavior is applied to.
    kind String
    Indicates the type of index.
    precision Integer
    The precision of the index. -1 is maximum precision.
    dataType string
    The datatype for which the indexing behavior is applied to.
    kind string
    Indicates the type of index.
    precision number
    The precision of the index. -1 is maximum precision.
    data_type str
    The datatype for which the indexing behavior is applied to.
    kind str
    Indicates the type of index.
    precision int
    The precision of the index. -1 is maximum precision.
    dataType String
    The datatype for which the indexing behavior is applied to.
    kind String
    Indicates the type of index.
    precision Number
    The precision of the index. -1 is maximum precision.

    IndexingPolicyResponse

    Automatic bool
    Indicates if the indexing policy is automatic
    ExcludedPaths List<Pulumi.AzureNative.CosmosDB.Inputs.ExcludedPathResponse>
    List of paths to exclude from indexing
    IncludedPaths List<Pulumi.AzureNative.CosmosDB.Inputs.IncludedPathResponse>
    List of paths to include in the indexing
    IndexingMode string
    Indicates the indexing mode.
    Automatic bool
    Indicates if the indexing policy is automatic
    ExcludedPaths []ExcludedPathResponse
    List of paths to exclude from indexing
    IncludedPaths []IncludedPathResponse
    List of paths to include in the indexing
    IndexingMode string
    Indicates the indexing mode.
    automatic Boolean
    Indicates if the indexing policy is automatic
    excludedPaths List<ExcludedPathResponse>
    List of paths to exclude from indexing
    includedPaths List<IncludedPathResponse>
    List of paths to include in the indexing
    indexingMode String
    Indicates the indexing mode.
    automatic boolean
    Indicates if the indexing policy is automatic
    excludedPaths ExcludedPathResponse[]
    List of paths to exclude from indexing
    includedPaths IncludedPathResponse[]
    List of paths to include in the indexing
    indexingMode string
    Indicates the indexing mode.
    automatic bool
    Indicates if the indexing policy is automatic
    excluded_paths Sequence[ExcludedPathResponse]
    List of paths to exclude from indexing
    included_paths Sequence[IncludedPathResponse]
    List of paths to include in the indexing
    indexing_mode str
    Indicates the indexing mode.
    automatic Boolean
    Indicates if the indexing policy is automatic
    excludedPaths List<Property Map>
    List of paths to exclude from indexing
    includedPaths List<Property Map>
    List of paths to include in the indexing
    indexingMode String
    Indicates the indexing mode.

    UniqueKeyPolicyResponse

    UniqueKeys List<Pulumi.AzureNative.CosmosDB.Inputs.UniqueKeyResponse>
    List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
    UniqueKeys []UniqueKeyResponse
    List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
    uniqueKeys List<UniqueKeyResponse>
    List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
    uniqueKeys UniqueKeyResponse[]
    List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
    unique_keys Sequence[UniqueKeyResponse]
    List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
    uniqueKeys List<Property Map>
    List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

    UniqueKeyResponse

    Paths List<string>
    List of paths must be unique for each document in the Azure Cosmos DB service
    Paths []string
    List of paths must be unique for each document in the Azure Cosmos DB service
    paths List<String>
    List of paths must be unique for each document in the Azure Cosmos DB service
    paths string[]
    List of paths must be unique for each document in the Azure Cosmos DB service
    paths Sequence[str]
    List of paths must be unique for each document in the Azure Cosmos DB service
    paths List<String>
    List of paths must be unique for each document in the Azure Cosmos DB service

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Try Pulumi Cloud free. Your team will thank you.