azure-native.documentdb.GremlinResourceGremlinGraph
Explore with Pulumi AI
An Azure Cosmos DB Gremlin graph. Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-03-15.
Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview.
Example Usage
CosmosDBGremlinGraphCreateUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var gremlinResourceGremlinGraph = new AzureNative.DocumentDB.GremlinResourceGremlinGraph("gremlinResourceGremlinGraph", new()
{
AccountName = "ddb1",
DatabaseName = "databaseName",
GraphName = "graphName",
Location = "West US",
Options = null,
Resource = new AzureNative.DocumentDB.Inputs.GremlinGraphResourceArgs
{
ConflictResolutionPolicy = new AzureNative.DocumentDB.Inputs.ConflictResolutionPolicyArgs
{
ConflictResolutionPath = "/path",
Mode = AzureNative.DocumentDB.ConflictResolutionMode.LastWriterWins,
},
DefaultTtl = 100,
Id = "graphName",
IndexingPolicy = new AzureNative.DocumentDB.Inputs.IndexingPolicyArgs
{
Automatic = true,
ExcludedPaths = new() { },
IncludedPaths = new[]
{
new AzureNative.DocumentDB.Inputs.IncludedPathArgs
{
Indexes = new[]
{
new AzureNative.DocumentDB.Inputs.IndexesArgs
{
DataType = AzureNative.DocumentDB.DataType.String,
Kind = AzureNative.DocumentDB.IndexKind.Range,
Precision = -1,
},
new AzureNative.DocumentDB.Inputs.IndexesArgs
{
DataType = AzureNative.DocumentDB.DataType.Number,
Kind = AzureNative.DocumentDB.IndexKind.Range,
Precision = -1,
},
},
Path = "/*",
},
},
IndexingMode = AzureNative.DocumentDB.IndexingMode.Consistent,
},
PartitionKey = new AzureNative.DocumentDB.Inputs.ContainerPartitionKeyArgs
{
Kind = AzureNative.DocumentDB.PartitionKind.Hash,
Paths = new[]
{
"/AccountNumber",
},
},
UniqueKeyPolicy = new AzureNative.DocumentDB.Inputs.UniqueKeyPolicyArgs
{
UniqueKeys = new[]
{
new AzureNative.DocumentDB.Inputs.UniqueKeyArgs
{
Paths = new[]
{
"/testPath",
},
},
},
},
},
ResourceGroupName = "rg1",
Tags = null,
});
});
package main
import (
documentdb "github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := documentdb.NewGremlinResourceGremlinGraph(ctx, "gremlinResourceGremlinGraph", &documentdb.GremlinResourceGremlinGraphArgs{
AccountName: pulumi.String("ddb1"),
DatabaseName: pulumi.String("databaseName"),
GraphName: pulumi.String("graphName"),
Location: pulumi.String("West US"),
Options: nil,
Resource: &documentdb.GremlinGraphResourceArgs{
ConflictResolutionPolicy: &documentdb.ConflictResolutionPolicyArgs{
ConflictResolutionPath: pulumi.String("/path"),
Mode: pulumi.String(documentdb.ConflictResolutionModeLastWriterWins),
},
DefaultTtl: pulumi.Int(100),
Id: pulumi.String("graphName"),
IndexingPolicy: &documentdb.IndexingPolicyArgs{
Automatic: pulumi.Bool(true),
ExcludedPaths: documentdb.ExcludedPathArray{},
IncludedPaths: documentdb.IncludedPathArray{
&documentdb.IncludedPathArgs{
Indexes: documentdb.IndexesArray{
&documentdb.IndexesArgs{
DataType: pulumi.String(documentdb.DataTypeString),
Kind: pulumi.String(documentdb.IndexKindRange),
Precision: -1,
},
&documentdb.IndexesArgs{
DataType: pulumi.String(documentdb.DataTypeNumber),
Kind: pulumi.String(documentdb.IndexKindRange),
Precision: -1,
},
},
Path: pulumi.String("/*"),
},
},
IndexingMode: pulumi.String(documentdb.IndexingModeConsistent),
},
PartitionKey: &documentdb.ContainerPartitionKeyArgs{
Kind: pulumi.String(documentdb.PartitionKindHash),
Paths: pulumi.StringArray{
pulumi.String("/AccountNumber"),
},
},
UniqueKeyPolicy: &documentdb.UniqueKeyPolicyArgs{
UniqueKeys: documentdb.UniqueKeyArray{
&documentdb.UniqueKeyArgs{
Paths: pulumi.StringArray{
pulumi.String("/testPath"),
},
},
},
},
},
ResourceGroupName: pulumi.String("rg1"),
Tags: nil,
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.GremlinResourceGremlinGraph;
import com.pulumi.azurenative.documentdb.GremlinResourceGremlinGraphArgs;
import com.pulumi.azurenative.documentdb.inputs.CreateUpdateOptionsArgs;
import com.pulumi.azurenative.documentdb.inputs.GremlinGraphResourceArgs;
import com.pulumi.azurenative.documentdb.inputs.ConflictResolutionPolicyArgs;
import com.pulumi.azurenative.documentdb.inputs.IndexingPolicyArgs;
import com.pulumi.azurenative.documentdb.inputs.ContainerPartitionKeyArgs;
import com.pulumi.azurenative.documentdb.inputs.UniqueKeyPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var gremlinResourceGremlinGraph = new GremlinResourceGremlinGraph("gremlinResourceGremlinGraph", GremlinResourceGremlinGraphArgs.builder()
.accountName("ddb1")
.databaseName("databaseName")
.graphName("graphName")
.location("West US")
.options()
.resource(GremlinGraphResourceArgs.builder()
.conflictResolutionPolicy(ConflictResolutionPolicyArgs.builder()
.conflictResolutionPath("/path")
.mode("LastWriterWins")
.build())
.defaultTtl(100)
.id("graphName")
.indexingPolicy(IndexingPolicyArgs.builder()
.automatic(true)
.excludedPaths()
.includedPaths(IncludedPathArgs.builder()
.indexes(
IndexesArgs.builder()
.dataType("String")
.kind("Range")
.precision("TODO: GenUnaryOpExpression")
.build(),
IndexesArgs.builder()
.dataType("Number")
.kind("Range")
.precision("TODO: GenUnaryOpExpression")
.build())
.path("/*")
.build())
.indexingMode("consistent")
.build())
.partitionKey(ContainerPartitionKeyArgs.builder()
.kind("Hash")
.paths("/AccountNumber")
.build())
.uniqueKeyPolicy(UniqueKeyPolicyArgs.builder()
.uniqueKeys(UniqueKeyArgs.builder()
.paths("/testPath")
.build())
.build())
.build())
.resourceGroupName("rg1")
.tags()
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
gremlin_resource_gremlin_graph = azure_native.documentdb.GremlinResourceGremlinGraph("gremlinResourceGremlinGraph",
account_name="ddb1",
database_name="databaseName",
graph_name="graphName",
location="West US",
options=azure_native.documentdb.CreateUpdateOptionsArgs(),
resource=azure_native.documentdb.GremlinGraphResourceArgs(
conflict_resolution_policy=azure_native.documentdb.ConflictResolutionPolicyArgs(
conflict_resolution_path="/path",
mode=azure_native.documentdb.ConflictResolutionMode.LAST_WRITER_WINS,
),
default_ttl=100,
id="graphName",
indexing_policy=azure_native.documentdb.IndexingPolicyArgs(
automatic=True,
excluded_paths=[],
included_paths=[azure_native.documentdb.IncludedPathArgs(
indexes=[
azure_native.documentdb.IndexesArgs(
data_type=azure_native.documentdb.DataType.STRING,
kind=azure_native.documentdb.IndexKind.RANGE,
precision=-1,
),
azure_native.documentdb.IndexesArgs(
data_type=azure_native.documentdb.DataType.NUMBER,
kind=azure_native.documentdb.IndexKind.RANGE,
precision=-1,
),
],
path="/*",
)],
indexing_mode=azure_native.documentdb.IndexingMode.CONSISTENT,
),
partition_key=azure_native.documentdb.ContainerPartitionKeyArgs(
kind=azure_native.documentdb.PartitionKind.HASH,
paths=["/AccountNumber"],
),
unique_key_policy=azure_native.documentdb.UniqueKeyPolicyArgs(
unique_keys=[azure_native.documentdb.UniqueKeyArgs(
paths=["/testPath"],
)],
),
),
resource_group_name="rg1",
tags={})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const gremlinResourceGremlinGraph = new azure_native.documentdb.GremlinResourceGremlinGraph("gremlinResourceGremlinGraph", {
accountName: "ddb1",
databaseName: "databaseName",
graphName: "graphName",
location: "West US",
options: {},
resource: {
conflictResolutionPolicy: {
conflictResolutionPath: "/path",
mode: azure_native.documentdb.ConflictResolutionMode.LastWriterWins,
},
defaultTtl: 100,
id: "graphName",
indexingPolicy: {
automatic: true,
excludedPaths: [],
includedPaths: [{
indexes: [
{
dataType: azure_native.documentdb.DataType.String,
kind: azure_native.documentdb.IndexKind.Range,
precision: -1,
},
{
dataType: azure_native.documentdb.DataType.Number,
kind: azure_native.documentdb.IndexKind.Range,
precision: -1,
},
],
path: "/*",
}],
indexingMode: azure_native.documentdb.IndexingMode.Consistent,
},
partitionKey: {
kind: azure_native.documentdb.PartitionKind.Hash,
paths: ["/AccountNumber"],
},
uniqueKeyPolicy: {
uniqueKeys: [{
paths: ["/testPath"],
}],
},
},
resourceGroupName: "rg1",
tags: {},
});
resources:
gremlinResourceGremlinGraph:
type: azure-native:documentdb:GremlinResourceGremlinGraph
properties:
accountName: ddb1
databaseName: databaseName
graphName: graphName
location: West US
options: {}
resource:
conflictResolutionPolicy:
conflictResolutionPath: /path
mode: LastWriterWins
defaultTtl: 100
id: graphName
indexingPolicy:
automatic: true
excludedPaths: []
includedPaths:
- indexes:
- dataType: String
kind: Range
precision: -1
- dataType: Number
kind: Range
precision: -1
path: /*
indexingMode: consistent
partitionKey:
kind: Hash
paths:
- /AccountNumber
uniqueKeyPolicy:
uniqueKeys:
- paths:
- /testPath
resourceGroupName: rg1
tags: {}
Create GremlinResourceGremlinGraph Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GremlinResourceGremlinGraph(name: string, args: GremlinResourceGremlinGraphArgs, opts?: CustomResourceOptions);
@overload
def GremlinResourceGremlinGraph(resource_name: str,
args: GremlinResourceGremlinGraphArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GremlinResourceGremlinGraph(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
database_name: Optional[str] = None,
resource: Optional[GremlinGraphResourceArgs] = None,
resource_group_name: Optional[str] = None,
graph_name: Optional[str] = None,
location: Optional[str] = None,
options: Optional[CreateUpdateOptionsArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewGremlinResourceGremlinGraph(ctx *Context, name string, args GremlinResourceGremlinGraphArgs, opts ...ResourceOption) (*GremlinResourceGremlinGraph, error)
public GremlinResourceGremlinGraph(string name, GremlinResourceGremlinGraphArgs args, CustomResourceOptions? opts = null)
public GremlinResourceGremlinGraph(String name, GremlinResourceGremlinGraphArgs args)
public GremlinResourceGremlinGraph(String name, GremlinResourceGremlinGraphArgs args, CustomResourceOptions options)
type: azure-native:documentdb:GremlinResourceGremlinGraph
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GremlinResourceGremlinGraphArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GremlinResourceGremlinGraphArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GremlinResourceGremlinGraphArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GremlinResourceGremlinGraphArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GremlinResourceGremlinGraphArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gremlinResourceGremlinGraphResource = new AzureNative.DocumentDB.GremlinResourceGremlinGraph("gremlinResourceGremlinGraphResource", new()
{
AccountName = "string",
DatabaseName = "string",
Resource = new AzureNative.DocumentDB.Inputs.GremlinGraphResourceArgs
{
Id = "string",
AnalyticalStorageTtl = 0,
ConflictResolutionPolicy = new AzureNative.DocumentDB.Inputs.ConflictResolutionPolicyArgs
{
ConflictResolutionPath = "string",
ConflictResolutionProcedure = "string",
Mode = "string",
},
DefaultTtl = 0,
IndexingPolicy = new AzureNative.DocumentDB.Inputs.IndexingPolicyArgs
{
Automatic = false,
CompositeIndexes = new[]
{
new[]
{
new AzureNative.DocumentDB.Inputs.CompositePathArgs
{
Order = "string",
Path = "string",
},
},
},
ExcludedPaths = new[]
{
new AzureNative.DocumentDB.Inputs.ExcludedPathArgs
{
Path = "string",
},
},
IncludedPaths = new[]
{
new AzureNative.DocumentDB.Inputs.IncludedPathArgs
{
Indexes = new[]
{
new AzureNative.DocumentDB.Inputs.IndexesArgs
{
DataType = "string",
Kind = "string",
Precision = 0,
},
},
Path = "string",
},
},
IndexingMode = "string",
SpatialIndexes = new[]
{
new AzureNative.DocumentDB.Inputs.SpatialSpecArgs
{
Path = "string",
Types = new[]
{
"string",
},
},
},
},
PartitionKey = new AzureNative.DocumentDB.Inputs.ContainerPartitionKeyArgs
{
Kind = "string",
Paths = new[]
{
"string",
},
Version = 0,
},
UniqueKeyPolicy = new AzureNative.DocumentDB.Inputs.UniqueKeyPolicyArgs
{
UniqueKeys = new[]
{
new AzureNative.DocumentDB.Inputs.UniqueKeyArgs
{
Paths = new[]
{
"string",
},
},
},
},
},
ResourceGroupName = "string",
GraphName = "string",
Location = "string",
Options = new AzureNative.DocumentDB.Inputs.CreateUpdateOptionsArgs
{
AutoscaleSettings = new AzureNative.DocumentDB.Inputs.AutoscaleSettingsArgs
{
MaxThroughput = 0,
},
Throughput = 0,
},
Tags =
{
{ "string", "string" },
},
});
example, err := documentdb.NewGremlinResourceGremlinGraph(ctx, "gremlinResourceGremlinGraphResource", &documentdb.GremlinResourceGremlinGraphArgs{
AccountName: pulumi.String("string"),
DatabaseName: pulumi.String("string"),
Resource: &documentdb.GremlinGraphResourceArgs{
Id: pulumi.String("string"),
AnalyticalStorageTtl: pulumi.Float64(0),
ConflictResolutionPolicy: &documentdb.ConflictResolutionPolicyArgs{
ConflictResolutionPath: pulumi.String("string"),
ConflictResolutionProcedure: pulumi.String("string"),
Mode: pulumi.String("string"),
},
DefaultTtl: pulumi.Int(0),
IndexingPolicy: &documentdb.IndexingPolicyArgs{
Automatic: pulumi.Bool(false),
CompositeIndexes: documentdb.CompositePathArrayArray{
documentdb.CompositePathArray{
&documentdb.CompositePathArgs{
Order: pulumi.String("string"),
Path: pulumi.String("string"),
},
},
},
ExcludedPaths: documentdb.ExcludedPathArray{
&documentdb.ExcludedPathArgs{
Path: pulumi.String("string"),
},
},
IncludedPaths: documentdb.IncludedPathArray{
&documentdb.IncludedPathArgs{
Indexes: documentdb.IndexesArray{
&documentdb.IndexesArgs{
DataType: pulumi.String("string"),
Kind: pulumi.String("string"),
Precision: pulumi.Int(0),
},
},
Path: pulumi.String("string"),
},
},
IndexingMode: pulumi.String("string"),
SpatialIndexes: documentdb.SpatialSpecArray{
&documentdb.SpatialSpecArgs{
Path: pulumi.String("string"),
Types: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
PartitionKey: &documentdb.ContainerPartitionKeyArgs{
Kind: pulumi.String("string"),
Paths: pulumi.StringArray{
pulumi.String("string"),
},
Version: pulumi.Int(0),
},
UniqueKeyPolicy: &documentdb.UniqueKeyPolicyArgs{
UniqueKeys: documentdb.UniqueKeyArray{
&documentdb.UniqueKeyArgs{
Paths: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
},
ResourceGroupName: pulumi.String("string"),
GraphName: pulumi.String("string"),
Location: pulumi.String("string"),
Options: &documentdb.CreateUpdateOptionsArgs{
AutoscaleSettings: &documentdb.AutoscaleSettingsArgs{
MaxThroughput: pulumi.Int(0),
},
Throughput: pulumi.Int(0),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var gremlinResourceGremlinGraphResource = new GremlinResourceGremlinGraph("gremlinResourceGremlinGraphResource", GremlinResourceGremlinGraphArgs.builder()
.accountName("string")
.databaseName("string")
.resource(GremlinGraphResourceArgs.builder()
.id("string")
.analyticalStorageTtl(0)
.conflictResolutionPolicy(ConflictResolutionPolicyArgs.builder()
.conflictResolutionPath("string")
.conflictResolutionProcedure("string")
.mode("string")
.build())
.defaultTtl(0)
.indexingPolicy(IndexingPolicyArgs.builder()
.automatic(false)
.compositeIndexes(CompositePathArgs.builder()
.order("string")
.path("string")
.build())
.excludedPaths(ExcludedPathArgs.builder()
.path("string")
.build())
.includedPaths(IncludedPathArgs.builder()
.indexes(IndexesArgs.builder()
.dataType("string")
.kind("string")
.precision(0)
.build())
.path("string")
.build())
.indexingMode("string")
.spatialIndexes(SpatialSpecArgs.builder()
.path("string")
.types("string")
.build())
.build())
.partitionKey(ContainerPartitionKeyArgs.builder()
.kind("string")
.paths("string")
.version(0)
.build())
.uniqueKeyPolicy(UniqueKeyPolicyArgs.builder()
.uniqueKeys(UniqueKeyArgs.builder()
.paths("string")
.build())
.build())
.build())
.resourceGroupName("string")
.graphName("string")
.location("string")
.options(CreateUpdateOptionsArgs.builder()
.autoscaleSettings(AutoscaleSettingsArgs.builder()
.maxThroughput(0)
.build())
.throughput(0)
.build())
.tags(Map.of("string", "string"))
.build());
gremlin_resource_gremlin_graph_resource = azure_native.documentdb.GremlinResourceGremlinGraph("gremlinResourceGremlinGraphResource",
account_name="string",
database_name="string",
resource=azure_native.documentdb.GremlinGraphResourceArgs(
id="string",
analytical_storage_ttl=0,
conflict_resolution_policy=azure_native.documentdb.ConflictResolutionPolicyArgs(
conflict_resolution_path="string",
conflict_resolution_procedure="string",
mode="string",
),
default_ttl=0,
indexing_policy=azure_native.documentdb.IndexingPolicyArgs(
automatic=False,
composite_indexes=[[azure_native.documentdb.CompositePathArgs(
order="string",
path="string",
)]],
excluded_paths=[azure_native.documentdb.ExcludedPathArgs(
path="string",
)],
included_paths=[azure_native.documentdb.IncludedPathArgs(
indexes=[azure_native.documentdb.IndexesArgs(
data_type="string",
kind="string",
precision=0,
)],
path="string",
)],
indexing_mode="string",
spatial_indexes=[azure_native.documentdb.SpatialSpecArgs(
path="string",
types=["string"],
)],
),
partition_key=azure_native.documentdb.ContainerPartitionKeyArgs(
kind="string",
paths=["string"],
version=0,
),
unique_key_policy=azure_native.documentdb.UniqueKeyPolicyArgs(
unique_keys=[azure_native.documentdb.UniqueKeyArgs(
paths=["string"],
)],
),
),
resource_group_name="string",
graph_name="string",
location="string",
options=azure_native.documentdb.CreateUpdateOptionsArgs(
autoscale_settings=azure_native.documentdb.AutoscaleSettingsArgs(
max_throughput=0,
),
throughput=0,
),
tags={
"string": "string",
})
const gremlinResourceGremlinGraphResource = new azure_native.documentdb.GremlinResourceGremlinGraph("gremlinResourceGremlinGraphResource", {
accountName: "string",
databaseName: "string",
resource: {
id: "string",
analyticalStorageTtl: 0,
conflictResolutionPolicy: {
conflictResolutionPath: "string",
conflictResolutionProcedure: "string",
mode: "string",
},
defaultTtl: 0,
indexingPolicy: {
automatic: false,
compositeIndexes: [[{
order: "string",
path: "string",
}]],
excludedPaths: [{
path: "string",
}],
includedPaths: [{
indexes: [{
dataType: "string",
kind: "string",
precision: 0,
}],
path: "string",
}],
indexingMode: "string",
spatialIndexes: [{
path: "string",
types: ["string"],
}],
},
partitionKey: {
kind: "string",
paths: ["string"],
version: 0,
},
uniqueKeyPolicy: {
uniqueKeys: [{
paths: ["string"],
}],
},
},
resourceGroupName: "string",
graphName: "string",
location: "string",
options: {
autoscaleSettings: {
maxThroughput: 0,
},
throughput: 0,
},
tags: {
string: "string",
},
});
type: azure-native:documentdb:GremlinResourceGremlinGraph
properties:
accountName: string
databaseName: string
graphName: string
location: string
options:
autoscaleSettings:
maxThroughput: 0
throughput: 0
resource:
analyticalStorageTtl: 0
conflictResolutionPolicy:
conflictResolutionPath: string
conflictResolutionProcedure: string
mode: string
defaultTtl: 0
id: string
indexingPolicy:
automatic: false
compositeIndexes:
- - order: string
path: string
excludedPaths:
- path: string
includedPaths:
- indexes:
- dataType: string
kind: string
precision: 0
path: string
indexingMode: string
spatialIndexes:
- path: string
types:
- string
partitionKey:
kind: string
paths:
- string
version: 0
uniqueKeyPolicy:
uniqueKeys:
- paths:
- string
resourceGroupName: string
tags:
string: string
GremlinResourceGremlinGraph Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The GremlinResourceGremlinGraph resource accepts the following input properties:
- Account
Name string - Cosmos DB database account name.
- Database
Name string - Cosmos DB database name.
- Resource
Pulumi.
Azure Native. Document DB. Inputs. Gremlin Graph Resource - The standard JSON format of a Gremlin graph
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Graph
Name string - Cosmos DB graph name.
- Location string
- The location of the resource group to which the resource belongs.
- Options
Pulumi.
Azure Native. Document DB. Inputs. Create Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
- Account
Name string - Cosmos DB database account name.
- Database
Name string - Cosmos DB database name.
- Resource
Gremlin
Graph Resource Args - The standard JSON format of a Gremlin graph
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Graph
Name string - Cosmos DB graph name.
- Location string
- The location of the resource group to which the resource belongs.
- Options
Create
Update Options Args - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
- account
Name String - Cosmos DB database account name.
- database
Name String - Cosmos DB database name.
- resource
Gremlin
Graph Resource - The standard JSON format of a Gremlin graph
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- graph
Name String - Cosmos DB graph name.
- location String
- The location of the resource group to which the resource belongs.
- options
Create
Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
- account
Name string - Cosmos DB database account name.
- database
Name string - Cosmos DB database name.
- resource
Gremlin
Graph Resource - The standard JSON format of a Gremlin graph
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- graph
Name string - Cosmos DB graph name.
- location string
- The location of the resource group to which the resource belongs.
- options
Create
Update Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- {[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".
- account_
name str - Cosmos DB database account name.
- database_
name str - Cosmos DB database name.
- resource
Gremlin
Graph Resource Args - The standard JSON format of a Gremlin graph
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- graph_
name str - Cosmos DB graph name.
- location str
- The location of the resource group to which the resource belongs.
- options
Create
Update Options Args - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
- account
Name String - Cosmos DB database account name.
- database
Name String - Cosmos DB database name.
- resource Property Map
- The standard JSON format of a Gremlin graph
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- graph
Name String - Cosmos DB graph name.
- location String
- The location of the resource group to which the resource belongs.
- options Property Map
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- 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".
Outputs
All input properties are implicitly available as output properties. Additionally, the GremlinResourceGremlinGraph resource produces the following output properties:
Supporting Types
AutoscaleSettings, AutoscaleSettingsArgs
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer - Represents maximum throughput, the resource can scale up to.
- max
Throughput number - Represents maximum throughput, the resource can scale up to.
- max_
throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Number - Represents maximum throughput, the resource can scale up to.
AutoscaleSettingsResponse, AutoscaleSettingsResponseArgs
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- Max
Throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer - Represents maximum throughput, the resource can scale up to.
- max
Throughput number - Represents maximum throughput, the resource can scale up to.
- max_
throughput int - Represents maximum throughput, the resource can scale up to.
- max
Throughput Number - Represents maximum throughput, the resource can scale up to.
CompositePath, CompositePathArgs
- Order
string | Pulumi.
Azure Native. Document DB. Composite Path Sort Order - Sort order for composite paths.
- Path string
- The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
- Order
string | Composite
Path Sort Order - Sort order for composite paths.
- Path string
- The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
- order
String | Composite
Path Sort Order - Sort order for composite paths.
- path String
- The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
- order
string | Composite
Path Sort Order - Sort order for composite paths.
- path string
- The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
- order
str | Composite
Path Sort Order - Sort order for composite paths.
- path str
- The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
- order String | "ascending" | "descending"
- Sort order for composite paths.
- path String
- The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
CompositePathResponse, CompositePathResponseArgs
CompositePathSortOrder, CompositePathSortOrderArgs
- @Ascending
- ascending
- @Descending
- descending
- Composite
Path Sort Order Ascending - ascending
- Composite
Path Sort Order Descending - descending
- Ascending
- ascending
- Descending
- descending
- Ascending
- ascending
- Descending
- descending
- ASCENDING
- ascending
- DESCENDING
- descending
- "ascending"
- ascending
- "descending"
- descending
ConflictResolutionMode, ConflictResolutionModeArgs
- Last
Writer Wins - LastWriterWins
- Custom
- Custom
- Conflict
Resolution Mode Last Writer Wins - LastWriterWins
- Conflict
Resolution Mode Custom - Custom
- Last
Writer Wins - LastWriterWins
- Custom
- Custom
- Last
Writer Wins - LastWriterWins
- Custom
- Custom
- LAST_WRITER_WINS
- LastWriterWins
- CUSTOM
- Custom
- "Last
Writer Wins" - LastWriterWins
- "Custom"
- Custom
ConflictResolutionPolicy, ConflictResolutionPolicyArgs
- Conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- Conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- Mode
string | Pulumi.
Azure Native. Document DB. Conflict Resolution Mode - Indicates the conflict resolution mode.
- Conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- Conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- Mode
string | Conflict
Resolution Mode - Indicates the conflict resolution mode.
- conflict
Resolution StringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution StringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode
String | Conflict
Resolution Mode - Indicates the conflict resolution mode.
- conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode
string | Conflict
Resolution Mode - Indicates the conflict resolution mode.
- conflict_
resolution_ strpath - The conflict resolution path in the case of LastWriterWins mode.
- conflict_
resolution_ strprocedure - The procedure to resolve conflicts in the case of custom mode.
- mode
str | Conflict
Resolution Mode - Indicates the conflict resolution mode.
- conflict
Resolution StringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution StringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode
String | "Last
Writer Wins" | "Custom" - Indicates the conflict resolution mode.
ConflictResolutionPolicyResponse, ConflictResolutionPolicyResponseArgs
- Conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- Conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- Mode string
- Indicates the conflict resolution mode.
- Conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- Conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- Mode string
- Indicates the conflict resolution mode.
- conflict
Resolution StringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution StringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode String
- Indicates the conflict resolution mode.
- conflict
Resolution stringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution stringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode string
- Indicates the conflict resolution mode.
- conflict_
resolution_ strpath - The conflict resolution path in the case of LastWriterWins mode.
- conflict_
resolution_ strprocedure - The procedure to resolve conflicts in the case of custom mode.
- mode str
- Indicates the conflict resolution mode.
- conflict
Resolution StringPath - The conflict resolution path in the case of LastWriterWins mode.
- conflict
Resolution StringProcedure - The procedure to resolve conflicts in the case of custom mode.
- mode String
- Indicates the conflict resolution mode.
ContainerPartitionKey, ContainerPartitionKeyArgs
- Kind
string | Pulumi.
Azure Native. Document DB. Partition Kind - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- Paths List<string>
- List of paths using which data within the container can be partitioned
- Version int
- Indicates the version of the partition key definition
- Kind
string | Partition
Kind - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- Paths []string
- List of paths using which data within the container can be partitioned
- Version int
- Indicates the version of the partition key definition
- kind
String | Partition
Kind - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- paths List<String>
- List of paths using which data within the container can be partitioned
- version Integer
- Indicates the version of the partition key definition
- kind
string | Partition
Kind - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- paths string[]
- List of paths using which data within the container can be partitioned
- version number
- Indicates the version of the partition key definition
- kind
str | Partition
Kind - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- paths Sequence[str]
- List of paths using which data within the container can be partitioned
- version int
- Indicates the version of the partition key definition
- kind
String | "Hash" | "Range" | "Multi
Hash" - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- paths List<String>
- List of paths using which data within the container can be partitioned
- version Number
- Indicates the version of the partition key definition
ContainerPartitionKeyResponse, ContainerPartitionKeyResponseArgs
- System
Key bool - Indicates if the container is using a system generated partition key
- Kind string
- Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- Paths List<string>
- List of paths using which data within the container can be partitioned
- Version int
- Indicates the version of the partition key definition
- System
Key bool - Indicates if the container is using a system generated partition key
- Kind string
- Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- Paths []string
- List of paths using which data within the container can be partitioned
- Version int
- Indicates the version of the partition key definition
- system
Key Boolean - Indicates if the container is using a system generated partition key
- kind String
- Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- paths List<String>
- List of paths using which data within the container can be partitioned
- version Integer
- Indicates the version of the partition key definition
- system
Key boolean - Indicates if the container is using a system generated partition key
- kind string
- Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- paths string[]
- List of paths using which data within the container can be partitioned
- version number
- Indicates the version of the partition key definition
- system_
key bool - Indicates if the container is using a system generated partition key
- kind str
- Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- paths Sequence[str]
- List of paths using which data within the container can be partitioned
- version int
- Indicates the version of the partition key definition
- system
Key Boolean - Indicates if the container is using a system generated partition key
- kind String
- Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
- paths List<String>
- List of paths using which data within the container can be partitioned
- version Number
- Indicates the version of the partition key definition
CreateUpdateOptions, CreateUpdateOptionsArgs
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings - Specifies the Autoscale settings.
- Throughput int
- Request Units per second. For example, "throughput": 10000.
- Autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- Throughput int
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput Integer
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput number
- Request Units per second. For example, "throughput": 10000.
- autoscale_
settings AutoscaleSettings - Specifies the Autoscale settings.
- throughput int
- Request Units per second. For example, "throughput": 10000.
- autoscale
Settings Property Map - Specifies the Autoscale settings.
- throughput Number
- Request Units per second. For example, "throughput": 10000.
DataType, DataTypeArgs
- String
- String
- Number
- Number
- Point
- Point
- Polygon
- Polygon
- Line
String - LineString
- Multi
Polygon - MultiPolygon
- Data
Type String - String
- Data
Type Number - Number
- Data
Type Point - Point
- Data
Type Polygon - Polygon
- Data
Type Line String - LineString
- Data
Type Multi Polygon - MultiPolygon
- String
- String
- Number
- Number
- Point
- Point
- Polygon
- Polygon
- Line
String - LineString
- Multi
Polygon - MultiPolygon
- String
- String
- Number
- Number
- Point
- Point
- Polygon
- Polygon
- Line
String - LineString
- Multi
Polygon - MultiPolygon
- STRING
- String
- NUMBER
- Number
- POINT
- Point
- POLYGON
- Polygon
- LINE_STRING
- LineString
- MULTI_POLYGON
- MultiPolygon
- "String"
- String
- "Number"
- Number
- "Point"
- Point
- "Polygon"
- Polygon
- "Line
String" - LineString
- "Multi
Polygon" - MultiPolygon
ExcludedPath, ExcludedPathArgs
- 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/*)
ExcludedPathResponse, ExcludedPathResponseArgs
- 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/*)
GremlinGraphGetPropertiesResponseOptions, GremlinGraphGetPropertiesResponseOptionsArgs
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings Response - Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- Autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput Integer
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput number
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale_
settings AutoscaleSettings Response - Specifies the Autoscale settings.
- throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings Property Map - Specifies the Autoscale settings.
- throughput Number
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
GremlinGraphGetPropertiesResponseResource, GremlinGraphGetPropertiesResponseResourceArgs
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Id string
- Name of the Cosmos DB Gremlin graph
- Rid string
- A system generated property. A unique identifier.
- Ts double
- A system generated property that denotes the last updated timestamp of the resource.
- Analytical
Storage doubleTtl - Analytical TTL.
- Conflict
Resolution Pulumi.Policy Azure Native. Document DB. Inputs. Conflict Resolution Policy Response - The conflict resolution policy for the graph.
- Default
Ttl int - Default time to live
- Indexing
Policy Pulumi.Azure Native. Document DB. Inputs. Indexing Policy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- Partition
Key Pulumi.Azure Native. Document DB. Inputs. Container Partition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- Unique
Key Pulumi.Policy Azure Native. Document DB. Inputs. Unique Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Id string
- Name of the Cosmos DB Gremlin graph
- Rid string
- A system generated property. A unique identifier.
- Ts float64
- A system generated property that denotes the last updated timestamp of the resource.
- Analytical
Storage float64Ttl - Analytical TTL.
- Conflict
Resolution ConflictPolicy Resolution Policy Response - The conflict resolution policy for the graph.
- Default
Ttl int - Default time to live
- Indexing
Policy IndexingPolicy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- Partition
Key ContainerPartition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- Unique
Key UniquePolicy Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- id String
- Name of the Cosmos DB Gremlin graph
- rid String
- A system generated property. A unique identifier.
- ts Double
- A system generated property that denotes the last updated timestamp of the resource.
- analytical
Storage DoubleTtl - Analytical TTL.
- conflict
Resolution ConflictPolicy Resolution Policy Response - The conflict resolution policy for the graph.
- default
Ttl Integer - Default time to live
- indexing
Policy IndexingPolicy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- partition
Key ContainerPartition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- unique
Key UniquePolicy Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- id string
- Name of the Cosmos DB Gremlin graph
- rid string
- A system generated property. A unique identifier.
- ts number
- A system generated property that denotes the last updated timestamp of the resource.
- analytical
Storage numberTtl - Analytical TTL.
- conflict
Resolution ConflictPolicy Resolution Policy Response - The conflict resolution policy for the graph.
- default
Ttl number - Default time to live
- indexing
Policy IndexingPolicy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- partition
Key ContainerPartition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- unique
Key UniquePolicy Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- etag str
- A system generated property representing the resource etag required for optimistic concurrency control.
- id str
- Name of the Cosmos DB Gremlin graph
- rid str
- A system generated property. A unique identifier.
- ts float
- A system generated property that denotes the last updated timestamp of the resource.
- analytical_
storage_ floatttl - Analytical TTL.
- conflict_
resolution_ Conflictpolicy Resolution Policy Response - The conflict resolution policy for the graph.
- default_
ttl int - Default time to live
- indexing_
policy IndexingPolicy Response - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- partition_
key ContainerPartition Key Response - The configuration of the partition key to be used for partitioning data into multiple partitions
- unique_
key_ Uniquepolicy Key Policy Response - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- id String
- Name of the Cosmos DB Gremlin graph
- rid String
- A system generated property. A unique identifier.
- ts Number
- A system generated property that denotes the last updated timestamp of the resource.
- analytical
Storage NumberTtl - Analytical TTL.
- conflict
Resolution Property MapPolicy - The conflict resolution policy for the graph.
- default
Ttl Number - Default time to live
- indexing
Policy Property Map - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- partition
Key Property Map - The configuration of the partition key to be used for partitioning data into multiple partitions
- unique
Key Property MapPolicy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
GremlinGraphResource, GremlinGraphResourceArgs
- Id string
- Name of the Cosmos DB Gremlin graph
- Analytical
Storage doubleTtl - Analytical TTL.
- Conflict
Resolution Pulumi.Policy Azure Native. Document DB. Inputs. Conflict Resolution Policy - The conflict resolution policy for the graph.
- Default
Ttl int - Default time to live
- Indexing
Policy Pulumi.Azure Native. Document DB. Inputs. Indexing Policy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- Partition
Key Pulumi.Azure Native. Document DB. Inputs. Container Partition Key - The configuration of the partition key to be used for partitioning data into multiple partitions
- Unique
Key Pulumi.Policy Azure Native. Document DB. Inputs. Unique Key Policy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- Id string
- Name of the Cosmos DB Gremlin graph
- Analytical
Storage float64Ttl - Analytical TTL.
- Conflict
Resolution ConflictPolicy Resolution Policy - The conflict resolution policy for the graph.
- Default
Ttl int - Default time to live
- Indexing
Policy IndexingPolicy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- Partition
Key ContainerPartition Key - The configuration of the partition key to be used for partitioning data into multiple partitions
- Unique
Key UniquePolicy Key Policy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- id String
- Name of the Cosmos DB Gremlin graph
- analytical
Storage DoubleTtl - Analytical TTL.
- conflict
Resolution ConflictPolicy Resolution Policy - The conflict resolution policy for the graph.
- default
Ttl Integer - Default time to live
- indexing
Policy IndexingPolicy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- partition
Key ContainerPartition Key - The configuration of the partition key to be used for partitioning data into multiple partitions
- unique
Key UniquePolicy Key Policy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- id string
- Name of the Cosmos DB Gremlin graph
- analytical
Storage numberTtl - Analytical TTL.
- conflict
Resolution ConflictPolicy Resolution Policy - The conflict resolution policy for the graph.
- default
Ttl number - Default time to live
- indexing
Policy IndexingPolicy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- partition
Key ContainerPartition Key - The configuration of the partition key to be used for partitioning data into multiple partitions
- unique
Key UniquePolicy Key Policy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- id str
- Name of the Cosmos DB Gremlin graph
- analytical_
storage_ floatttl - Analytical TTL.
- conflict_
resolution_ Conflictpolicy Resolution Policy - The conflict resolution policy for the graph.
- default_
ttl int - Default time to live
- indexing_
policy IndexingPolicy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- partition_
key ContainerPartition Key - The configuration of the partition key to be used for partitioning data into multiple partitions
- unique_
key_ Uniquepolicy Key Policy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
- id String
- Name of the Cosmos DB Gremlin graph
- analytical
Storage NumberTtl - Analytical TTL.
- conflict
Resolution Property MapPolicy - The conflict resolution policy for the graph.
- default
Ttl Number - Default time to live
- indexing
Policy Property Map - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
- partition
Key Property Map - The configuration of the partition key to be used for partitioning data into multiple partitions
- unique
Key Property MapPolicy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
IncludedPath, IncludedPathArgs
- Indexes
List<Pulumi.
Azure Native. Document DB. Inputs. Indexes> - 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<Indexes>
- 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[Indexes]
- 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/*)
IncludedPathResponse, IncludedPathResponseArgs
- Indexes
List<Pulumi.
Azure Native. Document DB. Inputs. Indexes Response> - 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
[]Indexes
Response - 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<Indexes
Response> - 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
Indexes
Response[] - 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[Indexes
Response] - 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/*)
IndexKind, IndexKindArgs
- Hash
- Hash
- Range
- Range
- Spatial
- Spatial
- Index
Kind Hash - Hash
- Index
Kind Range - Range
- Index
Kind Spatial - Spatial
- Hash
- Hash
- Range
- Range
- Spatial
- Spatial
- Hash
- Hash
- Range
- Range
- Spatial
- Spatial
- HASH
- Hash
- RANGE
- Range
- SPATIAL
- Spatial
- "Hash"
- Hash
- "Range"
- Range
- "Spatial"
- Spatial
Indexes, IndexesArgs
- Data
Type string | Pulumi.Azure Native. Document DB. Data Type - The datatype for which the indexing behavior is applied to.
- Kind
string | Pulumi.
Azure Native. Document DB. Index Kind - Indicates the type of index.
- Precision int
- The precision of the index. -1 is maximum precision.
- data
Type String | "String" | "Number" | "Point" | "Polygon" | "LineString" | "Multi Polygon" - The datatype for which the indexing behavior is applied to.
- kind String | "Hash" | "Range" | "Spatial"
- Indicates the type of index.
- precision Number
- The precision of the index. -1 is maximum precision.
IndexesResponse, IndexesResponseArgs
IndexingMode, IndexingModeArgs
- Consistent
- consistent
- Lazy
- lazy
- None
- none
- Indexing
Mode Consistent - consistent
- Indexing
Mode Lazy - lazy
- Indexing
Mode None - none
- Consistent
- consistent
- Lazy
- lazy
- None
- none
- Consistent
- consistent
- Lazy
- lazy
- None
- none
- CONSISTENT
- consistent
- LAZY
- lazy
- NONE
- none
- "consistent"
- consistent
- "lazy"
- lazy
- "none"
- none
IndexingPolicy, IndexingPolicyArgs
- Automatic bool
- Indicates if the indexing policy is automatic
- Composite
Indexes List<ImmutableArray<Pulumi. Azure Native. Document DB. Inputs. Composite Path>> - List of composite path list
- Excluded
Paths List<Pulumi.Azure Native. Document DB. Inputs. Excluded Path> - List of paths to exclude from indexing
- Included
Paths List<Pulumi.Azure Native. Document DB. Inputs. Included Path> - List of paths to include in the indexing
- Indexing
Mode string | Pulumi.Azure Native. Document DB. Indexing Mode - Indicates the indexing mode.
- Spatial
Indexes List<Pulumi.Azure Native. Document DB. Inputs. Spatial Spec> - List of spatial specifics
- Automatic bool
- Indicates if the indexing policy is automatic
- Composite
Indexes [][]CompositePath - List of composite path list
- Excluded
Paths []ExcludedPath - List of paths to exclude from indexing
- Included
Paths []IncludedPath - List of paths to include in the indexing
- Indexing
Mode string | IndexingMode - Indicates the indexing mode.
- Spatial
Indexes []SpatialSpec - List of spatial specifics
- automatic Boolean
- Indicates if the indexing policy is automatic
- composite
Indexes List<List<CompositePath>> - List of composite path list
- excluded
Paths List<ExcludedPath> - List of paths to exclude from indexing
- included
Paths List<IncludedPath> - List of paths to include in the indexing
- indexing
Mode String | IndexingMode - Indicates the indexing mode.
- spatial
Indexes List<SpatialSpec> - List of spatial specifics
- automatic boolean
- Indicates if the indexing policy is automatic
- composite
Indexes CompositePath[][] - List of composite path list
- excluded
Paths ExcludedPath[] - List of paths to exclude from indexing
- included
Paths IncludedPath[] - List of paths to include in the indexing
- indexing
Mode string | IndexingMode - Indicates the indexing mode.
- spatial
Indexes SpatialSpec[] - List of spatial specifics
- automatic bool
- Indicates if the indexing policy is automatic
- composite_
indexes Sequence[Sequence[CompositePath]] - List of composite path list
- excluded_
paths Sequence[ExcludedPath] - List of paths to exclude from indexing
- included_
paths Sequence[IncludedPath] - List of paths to include in the indexing
- indexing_
mode str | IndexingMode - Indicates the indexing mode.
- spatial_
indexes Sequence[SpatialSpec] - List of spatial specifics
- automatic Boolean
- Indicates if the indexing policy is automatic
- composite
Indexes List<List<Property Map>> - List of composite path list
- excluded
Paths List<Property Map> - List of paths to exclude from indexing
- included
Paths List<Property Map> - List of paths to include in the indexing
- indexing
Mode String | "consistent" | "lazy" | "none" - Indicates the indexing mode.
- spatial
Indexes List<Property Map> - List of spatial specifics
IndexingPolicyResponse, IndexingPolicyResponseArgs
- Automatic bool
- Indicates if the indexing policy is automatic
- Composite
Indexes List<ImmutableArray<Pulumi. Azure Native. Document DB. Inputs. Composite Path Response>> - List of composite path list
- Excluded
Paths List<Pulumi.Azure Native. Document DB. Inputs. Excluded Path Response> - List of paths to exclude from indexing
- Included
Paths List<Pulumi.Azure Native. Document DB. Inputs. Included Path Response> - List of paths to include in the indexing
- Indexing
Mode string - Indicates the indexing mode.
- Spatial
Indexes List<Pulumi.Azure Native. Document DB. Inputs. Spatial Spec Response> - List of spatial specifics
- Automatic bool
- Indicates if the indexing policy is automatic
- Composite
Indexes [][]CompositePath Response - List of composite path list
- Excluded
Paths []ExcludedPath Response - List of paths to exclude from indexing
- Included
Paths []IncludedPath Response - List of paths to include in the indexing
- Indexing
Mode string - Indicates the indexing mode.
- Spatial
Indexes []SpatialSpec Response - List of spatial specifics
- automatic Boolean
- Indicates if the indexing policy is automatic
- composite
Indexes List<List<CompositePath Response>> - List of composite path list
- excluded
Paths List<ExcludedPath Response> - List of paths to exclude from indexing
- included
Paths List<IncludedPath Response> - List of paths to include in the indexing
- indexing
Mode String - Indicates the indexing mode.
- spatial
Indexes List<SpatialSpec Response> - List of spatial specifics
- automatic boolean
- Indicates if the indexing policy is automatic
- composite
Indexes CompositePath Response[][] - List of composite path list
- excluded
Paths ExcludedPath Response[] - List of paths to exclude from indexing
- included
Paths IncludedPath Response[] - List of paths to include in the indexing
- indexing
Mode string - Indicates the indexing mode.
- spatial
Indexes SpatialSpec Response[] - List of spatial specifics
- automatic bool
- Indicates if the indexing policy is automatic
- composite_
indexes Sequence[Sequence[CompositePath Response]] - List of composite path list
- excluded_
paths Sequence[ExcludedPath Response] - List of paths to exclude from indexing
- included_
paths Sequence[IncludedPath Response] - List of paths to include in the indexing
- indexing_
mode str - Indicates the indexing mode.
- spatial_
indexes Sequence[SpatialSpec Response] - List of spatial specifics
- automatic Boolean
- Indicates if the indexing policy is automatic
- composite
Indexes List<List<Property Map>> - List of composite path list
- excluded
Paths List<Property Map> - List of paths to exclude from indexing
- included
Paths List<Property Map> - List of paths to include in the indexing
- indexing
Mode String - Indicates the indexing mode.
- spatial
Indexes List<Property Map> - List of spatial specifics
PartitionKind, PartitionKindArgs
- Hash
- Hash
- Range
- Range
- Multi
Hash - MultiHash
- Partition
Kind Hash - Hash
- Partition
Kind Range - Range
- Partition
Kind Multi Hash - MultiHash
- Hash
- Hash
- Range
- Range
- Multi
Hash - MultiHash
- Hash
- Hash
- Range
- Range
- Multi
Hash - MultiHash
- HASH
- Hash
- RANGE
- Range
- MULTI_HASH
- MultiHash
- "Hash"
- Hash
- "Range"
- Range
- "Multi
Hash" - MultiHash
SpatialSpec, SpatialSpecArgs
SpatialSpecResponse, SpatialSpecResponseArgs
SpatialType, SpatialTypeArgs
- Point
- Point
- Line
String - LineString
- Polygon
- Polygon
- Multi
Polygon - MultiPolygon
- Spatial
Type Point - Point
- Spatial
Type Line String - LineString
- Spatial
Type Polygon - Polygon
- Spatial
Type Multi Polygon - MultiPolygon
- Point
- Point
- Line
String - LineString
- Polygon
- Polygon
- Multi
Polygon - MultiPolygon
- Point
- Point
- Line
String - LineString
- Polygon
- Polygon
- Multi
Polygon - MultiPolygon
- POINT
- Point
- LINE_STRING
- LineString
- POLYGON
- Polygon
- MULTI_POLYGON
- MultiPolygon
- "Point"
- Point
- "Line
String" - LineString
- "Polygon"
- Polygon
- "Multi
Polygon" - MultiPolygon
UniqueKey, UniqueKeyArgs
- 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
UniqueKeyPolicy, UniqueKeyPolicyArgs
- Unique
Keys List<Pulumi.Azure Native. Document DB. Inputs. Unique Key> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- Unique
Keys []UniqueKey - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys List<UniqueKey> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys UniqueKey[] - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique_
keys Sequence[UniqueKey] - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys List<Property Map> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
UniqueKeyPolicyResponse, UniqueKeyPolicyResponseArgs
- Unique
Keys List<Pulumi.Azure Native. Document DB. Inputs. Unique Key Response> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- Unique
Keys []UniqueKey Response - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys List<UniqueKey Response> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys UniqueKey Response[] - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique_
keys Sequence[UniqueKey Response] - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
- unique
Keys List<Property Map> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
UniqueKeyResponse, UniqueKeyResponseArgs
- 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
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:documentdb:GremlinResourceGremlinGraph graphName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0