Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. DatabaseAccountSqlContainer
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.DatabaseAccountSqlContainer

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

An Azure Cosmos DB container.

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.

Example Usage

CosmosDBSqlContainerCreateUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var databaseAccountSqlContainer = new AzureNative.CosmosDB.DatabaseAccountSqlContainer("databaseAccountSqlContainer", new()
    {
        AccountName = "ddb1",
        ContainerName = "containerName",
        DatabaseName = "databaseName",
        Options = null,
        Resource = new AzureNative.CosmosDB.Inputs.SqlContainerResourceArgs
        {
            ConflictResolutionPolicy = new AzureNative.CosmosDB.Inputs.ConflictResolutionPolicyArgs
            {
                ConflictResolutionPath = "/path",
                Mode = AzureNative.CosmosDB.ConflictResolutionMode.LastWriterWins,
            },
            DefaultTtl = 100,
            Id = "containerName",
            IndexingPolicy = new AzureNative.CosmosDB.Inputs.IndexingPolicyArgs
            {
                Automatic = true,
                ExcludedPaths = new() { },
                IncludedPaths = new[]
                {
                    new AzureNative.CosmosDB.Inputs.IncludedPathArgs
                    {
                        Indexes = new[]
                        {
                            new AzureNative.CosmosDB.Inputs.IndexesArgs
                            {
                                DataType = AzureNative.CosmosDB.DataType.String,
                                Kind = AzureNative.CosmosDB.IndexKind.Range,
                                Precision = -1,
                            },
                            new AzureNative.CosmosDB.Inputs.IndexesArgs
                            {
                                DataType = AzureNative.CosmosDB.DataType.Number,
                                Kind = AzureNative.CosmosDB.IndexKind.Range,
                                Precision = -1,
                            },
                        },
                        Path = "/*",
                    },
                },
                IndexingMode = "Consistent",
            },
            PartitionKey = new AzureNative.CosmosDB.Inputs.ContainerPartitionKeyArgs
            {
                Kind = AzureNative.CosmosDB.PartitionKind.Hash,
                Paths = new[]
                {
                    "/AccountNumber",
                },
            },
            UniqueKeyPolicy = new AzureNative.CosmosDB.Inputs.UniqueKeyPolicyArgs
            {
                UniqueKeys = new[]
                {
                    new AzureNative.CosmosDB.Inputs.UniqueKeyArgs
                    {
                        Paths = new[]
                        {
                            "/testPath",
                        },
                    },
                },
            },
        },
        ResourceGroupName = "rg1",
    });

});
Copy
package main

import (
	cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cosmosdb.NewDatabaseAccountSqlContainer(ctx, "databaseAccountSqlContainer", &cosmosdb.DatabaseAccountSqlContainerArgs{
			AccountName:   pulumi.String("ddb1"),
			ContainerName: pulumi.String("containerName"),
			DatabaseName:  pulumi.String("databaseName"),
			Options:       pulumi.StringMap{},
			Resource: &cosmosdb.SqlContainerResourceArgs{
				ConflictResolutionPolicy: &cosmosdb.ConflictResolutionPolicyArgs{
					ConflictResolutionPath: pulumi.String("/path"),
					Mode:                   pulumi.String(cosmosdb.ConflictResolutionModeLastWriterWins),
				},
				DefaultTtl: pulumi.Int(100),
				Id:         pulumi.String("containerName"),
				IndexingPolicy: &cosmosdb.IndexingPolicyArgs{
					Automatic:     pulumi.Bool(true),
					ExcludedPaths: cosmosdb.ExcludedPathArray{},
					IncludedPaths: cosmosdb.IncludedPathArray{
						&cosmosdb.IncludedPathArgs{
							Indexes: cosmosdb.IndexesArray{
								&cosmosdb.IndexesArgs{
									DataType:  pulumi.String(cosmosdb.DataTypeString),
									Kind:      pulumi.String(cosmosdb.IndexKindRange),
									Precision: pulumi.Int(-1),
								},
								&cosmosdb.IndexesArgs{
									DataType:  pulumi.String(cosmosdb.DataTypeNumber),
									Kind:      pulumi.String(cosmosdb.IndexKindRange),
									Precision: pulumi.Int(-1),
								},
							},
							Path: pulumi.String("/*"),
						},
					},
					IndexingMode: pulumi.String("Consistent"),
				},
				PartitionKey: &cosmosdb.ContainerPartitionKeyArgs{
					Kind: pulumi.String(cosmosdb.PartitionKindHash),
					Paths: pulumi.StringArray{
						pulumi.String("/AccountNumber"),
					},
				},
				UniqueKeyPolicy: &cosmosdb.UniqueKeyPolicyArgs{
					UniqueKeys: cosmosdb.UniqueKeyArray{
						&cosmosdb.UniqueKeyArgs{
							Paths: pulumi.StringArray{
								pulumi.String("/testPath"),
							},
						},
					},
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cosmosdb.DatabaseAccountSqlContainer;
import com.pulumi.azurenative.cosmosdb.DatabaseAccountSqlContainerArgs;
import com.pulumi.azurenative.cosmosdb.inputs.SqlContainerResourceArgs;
import com.pulumi.azurenative.cosmosdb.inputs.ConflictResolutionPolicyArgs;
import com.pulumi.azurenative.cosmosdb.inputs.IndexingPolicyArgs;
import com.pulumi.azurenative.cosmosdb.inputs.ContainerPartitionKeyArgs;
import com.pulumi.azurenative.cosmosdb.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 databaseAccountSqlContainer = new DatabaseAccountSqlContainer("databaseAccountSqlContainer", DatabaseAccountSqlContainerArgs.builder()
            .accountName("ddb1")
            .containerName("containerName")
            .databaseName("databaseName")
            .options(Map.ofEntries(
            ))
            .resource(SqlContainerResourceArgs.builder()
                .conflictResolutionPolicy(ConflictResolutionPolicyArgs.builder()
                    .conflictResolutionPath("/path")
                    .mode("LastWriterWins")
                    .build())
                .defaultTtl(100)
                .id("containerName")
                .indexingPolicy(IndexingPolicyArgs.builder()
                    .automatic(true)
                    .excludedPaths()
                    .includedPaths(IncludedPathArgs.builder()
                        .indexes(                        
                            IndexesArgs.builder()
                                .dataType("String")
                                .kind("Range")
                                .precision(-1)
                                .build(),
                            IndexesArgs.builder()
                                .dataType("Number")
                                .kind("Range")
                                .precision(-1)
                                .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")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const databaseAccountSqlContainer = new azure_native.cosmosdb.DatabaseAccountSqlContainer("databaseAccountSqlContainer", {
    accountName: "ddb1",
    containerName: "containerName",
    databaseName: "databaseName",
    options: {},
    resource: {
        conflictResolutionPolicy: {
            conflictResolutionPath: "/path",
            mode: azure_native.cosmosdb.ConflictResolutionMode.LastWriterWins,
        },
        defaultTtl: 100,
        id: "containerName",
        indexingPolicy: {
            automatic: true,
            excludedPaths: [],
            includedPaths: [{
                indexes: [
                    {
                        dataType: azure_native.cosmosdb.DataType.String,
                        kind: azure_native.cosmosdb.IndexKind.Range,
                        precision: -1,
                    },
                    {
                        dataType: azure_native.cosmosdb.DataType.Number,
                        kind: azure_native.cosmosdb.IndexKind.Range,
                        precision: -1,
                    },
                ],
                path: "/*",
            }],
            indexingMode: "Consistent",
        },
        partitionKey: {
            kind: azure_native.cosmosdb.PartitionKind.Hash,
            paths: ["/AccountNumber"],
        },
        uniqueKeyPolicy: {
            uniqueKeys: [{
                paths: ["/testPath"],
            }],
        },
    },
    resourceGroupName: "rg1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

database_account_sql_container = azure_native.cosmosdb.DatabaseAccountSqlContainer("databaseAccountSqlContainer",
    account_name="ddb1",
    container_name="containerName",
    database_name="databaseName",
    options={},
    resource={
        "conflict_resolution_policy": {
            "conflict_resolution_path": "/path",
            "mode": azure_native.cosmosdb.ConflictResolutionMode.LAST_WRITER_WINS,
        },
        "default_ttl": 100,
        "id": "containerName",
        "indexing_policy": {
            "automatic": True,
            "excluded_paths": [],
            "included_paths": [{
                "indexes": [
                    {
                        "data_type": azure_native.cosmosdb.DataType.STRING,
                        "kind": azure_native.cosmosdb.IndexKind.RANGE,
                        "precision": -1,
                    },
                    {
                        "data_type": azure_native.cosmosdb.DataType.NUMBER,
                        "kind": azure_native.cosmosdb.IndexKind.RANGE,
                        "precision": -1,
                    },
                ],
                "path": "/*",
            }],
            "indexing_mode": "Consistent",
        },
        "partition_key": {
            "kind": azure_native.cosmosdb.PartitionKind.HASH,
            "paths": ["/AccountNumber"],
        },
        "unique_key_policy": {
            "unique_keys": [{
                "paths": ["/testPath"],
            }],
        },
    },
    resource_group_name="rg1")
Copy
resources:
  databaseAccountSqlContainer:
    type: azure-native:cosmosdb:DatabaseAccountSqlContainer
    properties:
      accountName: ddb1
      containerName: containerName
      databaseName: databaseName
      options: {}
      resource:
        conflictResolutionPolicy:
          conflictResolutionPath: /path
          mode: LastWriterWins
        defaultTtl: 100
        id: containerName
        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
Copy

Create DatabaseAccountSqlContainer Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DatabaseAccountSqlContainer(name: string, args: DatabaseAccountSqlContainerArgs, opts?: CustomResourceOptions);
@overload
def DatabaseAccountSqlContainer(resource_name: str,
                                args: DatabaseAccountSqlContainerArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def DatabaseAccountSqlContainer(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                account_name: Optional[str] = None,
                                database_name: Optional[str] = None,
                                options: Optional[Mapping[str, str]] = None,
                                resource: Optional[SqlContainerResourceArgs] = None,
                                resource_group_name: Optional[str] = None,
                                container_name: Optional[str] = None)
func NewDatabaseAccountSqlContainer(ctx *Context, name string, args DatabaseAccountSqlContainerArgs, opts ...ResourceOption) (*DatabaseAccountSqlContainer, error)
public DatabaseAccountSqlContainer(string name, DatabaseAccountSqlContainerArgs args, CustomResourceOptions? opts = null)
public DatabaseAccountSqlContainer(String name, DatabaseAccountSqlContainerArgs args)
public DatabaseAccountSqlContainer(String name, DatabaseAccountSqlContainerArgs args, CustomResourceOptions options)

type: azure-native:cosmosdb:DatabaseAccountSqlContainer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DatabaseAccountSqlContainerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DatabaseAccountSqlContainerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseAccountSqlContainerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseAccountSqlContainerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DatabaseAccountSqlContainerArgs
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 databaseAccountSqlContainerResource = new AzureNative.CosmosDB.DatabaseAccountSqlContainer("databaseAccountSqlContainerResource", new()
{
    AccountName = "string",
    DatabaseName = "string",
    Options = 
    {
        { "string", "string" },
    },
    Resource = new AzureNative.CosmosDB.Inputs.SqlContainerResourceArgs
    {
        Id = "string",
        AnalyticalStorageTtl = 0,
        ClientEncryptionPolicy = new AzureNative.CosmosDB.Inputs.ClientEncryptionPolicyArgs
        {
            IncludedPaths = new[]
            {
                new AzureNative.CosmosDB.Inputs.ClientEncryptionIncludedPathArgs
                {
                    ClientEncryptionKeyId = "string",
                    EncryptionAlgorithm = "string",
                    EncryptionType = "string",
                    Path = "string",
                },
            },
            PolicyFormatVersion = 0,
        },
        ComputedProperties = new[]
        {
            new AzureNative.CosmosDB.Inputs.ComputedPropertyArgs
            {
                Name = "string",
                Query = "string",
            },
        },
        ConflictResolutionPolicy = new AzureNative.CosmosDB.Inputs.ConflictResolutionPolicyArgs
        {
            ConflictResolutionPath = "string",
            ConflictResolutionProcedure = "string",
            Mode = "string",
        },
        CreateMode = "string",
        DefaultTtl = 0,
        IndexingPolicy = new AzureNative.CosmosDB.Inputs.IndexingPolicyArgs
        {
            Automatic = false,
            CompositeIndexes = new[]
            {
                new[]
                {
                    new AzureNative.CosmosDB.Inputs.CompositePathArgs
                    {
                        Order = "string",
                        Path = "string",
                    },
                },
            },
            ExcludedPaths = new[]
            {
                new AzureNative.CosmosDB.Inputs.ExcludedPathArgs
                {
                    Path = "string",
                },
            },
            IncludedPaths = new[]
            {
                new AzureNative.CosmosDB.Inputs.IncludedPathArgs
                {
                    Indexes = new[]
                    {
                        new AzureNative.CosmosDB.Inputs.IndexesArgs
                        {
                            DataType = "string",
                            Kind = "string",
                            Precision = 0,
                        },
                    },
                    Path = "string",
                },
            },
            IndexingMode = "string",
            SpatialIndexes = new[]
            {
                new AzureNative.CosmosDB.Inputs.SpatialSpecArgs
                {
                    Path = "string",
                    Types = new[]
                    {
                        "string",
                    },
                },
            },
            VectorIndexes = new[]
            {
                new AzureNative.CosmosDB.Inputs.VectorIndexArgs
                {
                    Path = "string",
                    Type = "string",
                },
            },
        },
        PartitionKey = new AzureNative.CosmosDB.Inputs.ContainerPartitionKeyArgs
        {
            Kind = "string",
            Paths = new[]
            {
                "string",
            },
            Version = 0,
        },
        RestoreParameters = new AzureNative.CosmosDB.Inputs.ResourceRestoreParametersArgs
        {
            RestoreSource = "string",
            RestoreTimestampInUtc = "string",
            RestoreWithTtlDisabled = false,
        },
        UniqueKeyPolicy = new AzureNative.CosmosDB.Inputs.UniqueKeyPolicyArgs
        {
            UniqueKeys = new[]
            {
                new AzureNative.CosmosDB.Inputs.UniqueKeyArgs
                {
                    Paths = new[]
                    {
                        "string",
                    },
                },
            },
        },
        VectorEmbeddingPolicy = new AzureNative.CosmosDB.Inputs.VectorEmbeddingPolicyArgs
        {
            VectorEmbeddings = new[]
            {
                new AzureNative.CosmosDB.Inputs.VectorEmbeddingArgs
                {
                    DataType = "string",
                    Dimensions = 0,
                    DistanceFunction = "string",
                    Path = "string",
                },
            },
        },
    },
    ResourceGroupName = "string",
    ContainerName = "string",
});
Copy
example, err := cosmosdb.NewDatabaseAccountSqlContainer(ctx, "databaseAccountSqlContainerResource", &cosmosdb.DatabaseAccountSqlContainerArgs{
	AccountName:  pulumi.String("string"),
	DatabaseName: pulumi.String("string"),
	Options: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Resource: &cosmosdb.SqlContainerResourceArgs{
		Id:                   pulumi.String("string"),
		AnalyticalStorageTtl: pulumi.Float64(0),
		ClientEncryptionPolicy: &cosmosdb.ClientEncryptionPolicyArgs{
			IncludedPaths: cosmosdb.ClientEncryptionIncludedPathArray{
				&cosmosdb.ClientEncryptionIncludedPathArgs{
					ClientEncryptionKeyId: pulumi.String("string"),
					EncryptionAlgorithm:   pulumi.String("string"),
					EncryptionType:        pulumi.String("string"),
					Path:                  pulumi.String("string"),
				},
			},
			PolicyFormatVersion: pulumi.Int(0),
		},
		ComputedProperties: cosmosdb.ComputedPropertyArray{
			&cosmosdb.ComputedPropertyArgs{
				Name:  pulumi.String("string"),
				Query: pulumi.String("string"),
			},
		},
		ConflictResolutionPolicy: &cosmosdb.ConflictResolutionPolicyArgs{
			ConflictResolutionPath:      pulumi.String("string"),
			ConflictResolutionProcedure: pulumi.String("string"),
			Mode:                        pulumi.String("string"),
		},
		CreateMode: pulumi.String("string"),
		DefaultTtl: pulumi.Int(0),
		IndexingPolicy: &cosmosdb.IndexingPolicyArgs{
			Automatic: pulumi.Bool(false),
			CompositeIndexes: cosmosdb.CompositePathArrayArray{
				cosmosdb.CompositePathArray{
					&cosmosdb.CompositePathArgs{
						Order: pulumi.String("string"),
						Path:  pulumi.String("string"),
					},
				},
			},
			ExcludedPaths: cosmosdb.ExcludedPathArray{
				&cosmosdb.ExcludedPathArgs{
					Path: pulumi.String("string"),
				},
			},
			IncludedPaths: cosmosdb.IncludedPathArray{
				&cosmosdb.IncludedPathArgs{
					Indexes: cosmosdb.IndexesArray{
						&cosmosdb.IndexesArgs{
							DataType:  pulumi.String("string"),
							Kind:      pulumi.String("string"),
							Precision: pulumi.Int(0),
						},
					},
					Path: pulumi.String("string"),
				},
			},
			IndexingMode: pulumi.String("string"),
			SpatialIndexes: cosmosdb.SpatialSpecArray{
				&cosmosdb.SpatialSpecArgs{
					Path: pulumi.String("string"),
					Types: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			VectorIndexes: cosmosdb.VectorIndexArray{
				&cosmosdb.VectorIndexArgs{
					Path: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
		},
		PartitionKey: &cosmosdb.ContainerPartitionKeyArgs{
			Kind: pulumi.String("string"),
			Paths: pulumi.StringArray{
				pulumi.String("string"),
			},
			Version: pulumi.Int(0),
		},
		RestoreParameters: &cosmosdb.ResourceRestoreParametersArgs{
			RestoreSource:          pulumi.String("string"),
			RestoreTimestampInUtc:  pulumi.String("string"),
			RestoreWithTtlDisabled: pulumi.Bool(false),
		},
		UniqueKeyPolicy: &cosmosdb.UniqueKeyPolicyArgs{
			UniqueKeys: cosmosdb.UniqueKeyArray{
				&cosmosdb.UniqueKeyArgs{
					Paths: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
		VectorEmbeddingPolicy: &cosmosdb.VectorEmbeddingPolicyArgs{
			VectorEmbeddings: cosmosdb.VectorEmbeddingArray{
				&cosmosdb.VectorEmbeddingArgs{
					DataType:         pulumi.String("string"),
					Dimensions:       pulumi.Int(0),
					DistanceFunction: pulumi.String("string"),
					Path:             pulumi.String("string"),
				},
			},
		},
	},
	ResourceGroupName: pulumi.String("string"),
	ContainerName:     pulumi.String("string"),
})
Copy
var databaseAccountSqlContainerResource = new DatabaseAccountSqlContainer("databaseAccountSqlContainerResource", DatabaseAccountSqlContainerArgs.builder()
    .accountName("string")
    .databaseName("string")
    .options(Map.of("string", "string"))
    .resource(SqlContainerResourceArgs.builder()
        .id("string")
        .analyticalStorageTtl(0)
        .clientEncryptionPolicy(ClientEncryptionPolicyArgs.builder()
            .includedPaths(ClientEncryptionIncludedPathArgs.builder()
                .clientEncryptionKeyId("string")
                .encryptionAlgorithm("string")
                .encryptionType("string")
                .path("string")
                .build())
            .policyFormatVersion(0)
            .build())
        .computedProperties(ComputedPropertyArgs.builder()
            .name("string")
            .query("string")
            .build())
        .conflictResolutionPolicy(ConflictResolutionPolicyArgs.builder()
            .conflictResolutionPath("string")
            .conflictResolutionProcedure("string")
            .mode("string")
            .build())
        .createMode("string")
        .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())
            .vectorIndexes(VectorIndexArgs.builder()
                .path("string")
                .type("string")
                .build())
            .build())
        .partitionKey(ContainerPartitionKeyArgs.builder()
            .kind("string")
            .paths("string")
            .version(0)
            .build())
        .restoreParameters(ResourceRestoreParametersArgs.builder()
            .restoreSource("string")
            .restoreTimestampInUtc("string")
            .restoreWithTtlDisabled(false)
            .build())
        .uniqueKeyPolicy(UniqueKeyPolicyArgs.builder()
            .uniqueKeys(UniqueKeyArgs.builder()
                .paths("string")
                .build())
            .build())
        .vectorEmbeddingPolicy(VectorEmbeddingPolicyArgs.builder()
            .vectorEmbeddings(VectorEmbeddingArgs.builder()
                .dataType("string")
                .dimensions(0)
                .distanceFunction("string")
                .path("string")
                .build())
            .build())
        .build())
    .resourceGroupName("string")
    .containerName("string")
    .build());
Copy
database_account_sql_container_resource = azure_native.cosmosdb.DatabaseAccountSqlContainer("databaseAccountSqlContainerResource",
    account_name="string",
    database_name="string",
    options={
        "string": "string",
    },
    resource={
        "id": "string",
        "analytical_storage_ttl": 0,
        "client_encryption_policy": {
            "included_paths": [{
                "client_encryption_key_id": "string",
                "encryption_algorithm": "string",
                "encryption_type": "string",
                "path": "string",
            }],
            "policy_format_version": 0,
        },
        "computed_properties": [{
            "name": "string",
            "query": "string",
        }],
        "conflict_resolution_policy": {
            "conflict_resolution_path": "string",
            "conflict_resolution_procedure": "string",
            "mode": "string",
        },
        "create_mode": "string",
        "default_ttl": 0,
        "indexing_policy": {
            "automatic": False,
            "composite_indexes": [[{
                "order": "string",
                "path": "string",
            }]],
            "excluded_paths": [{
                "path": "string",
            }],
            "included_paths": [{
                "indexes": [{
                    "data_type": "string",
                    "kind": "string",
                    "precision": 0,
                }],
                "path": "string",
            }],
            "indexing_mode": "string",
            "spatial_indexes": [{
                "path": "string",
                "types": ["string"],
            }],
            "vector_indexes": [{
                "path": "string",
                "type": "string",
            }],
        },
        "partition_key": {
            "kind": "string",
            "paths": ["string"],
            "version": 0,
        },
        "restore_parameters": {
            "restore_source": "string",
            "restore_timestamp_in_utc": "string",
            "restore_with_ttl_disabled": False,
        },
        "unique_key_policy": {
            "unique_keys": [{
                "paths": ["string"],
            }],
        },
        "vector_embedding_policy": {
            "vector_embeddings": [{
                "data_type": "string",
                "dimensions": 0,
                "distance_function": "string",
                "path": "string",
            }],
        },
    },
    resource_group_name="string",
    container_name="string")
Copy
const databaseAccountSqlContainerResource = new azure_native.cosmosdb.DatabaseAccountSqlContainer("databaseAccountSqlContainerResource", {
    accountName: "string",
    databaseName: "string",
    options: {
        string: "string",
    },
    resource: {
        id: "string",
        analyticalStorageTtl: 0,
        clientEncryptionPolicy: {
            includedPaths: [{
                clientEncryptionKeyId: "string",
                encryptionAlgorithm: "string",
                encryptionType: "string",
                path: "string",
            }],
            policyFormatVersion: 0,
        },
        computedProperties: [{
            name: "string",
            query: "string",
        }],
        conflictResolutionPolicy: {
            conflictResolutionPath: "string",
            conflictResolutionProcedure: "string",
            mode: "string",
        },
        createMode: "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"],
            }],
            vectorIndexes: [{
                path: "string",
                type: "string",
            }],
        },
        partitionKey: {
            kind: "string",
            paths: ["string"],
            version: 0,
        },
        restoreParameters: {
            restoreSource: "string",
            restoreTimestampInUtc: "string",
            restoreWithTtlDisabled: false,
        },
        uniqueKeyPolicy: {
            uniqueKeys: [{
                paths: ["string"],
            }],
        },
        vectorEmbeddingPolicy: {
            vectorEmbeddings: [{
                dataType: "string",
                dimensions: 0,
                distanceFunction: "string",
                path: "string",
            }],
        },
    },
    resourceGroupName: "string",
    containerName: "string",
});
Copy
type: azure-native:cosmosdb:DatabaseAccountSqlContainer
properties:
    accountName: string
    containerName: string
    databaseName: string
    options:
        string: string
    resource:
        analyticalStorageTtl: 0
        clientEncryptionPolicy:
            includedPaths:
                - clientEncryptionKeyId: string
                  encryptionAlgorithm: string
                  encryptionType: string
                  path: string
            policyFormatVersion: 0
        computedProperties:
            - name: string
              query: string
        conflictResolutionPolicy:
            conflictResolutionPath: string
            conflictResolutionProcedure: string
            mode: string
        createMode: 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
            vectorIndexes:
                - path: string
                  type: string
        partitionKey:
            kind: string
            paths:
                - string
            version: 0
        restoreParameters:
            restoreSource: string
            restoreTimestampInUtc: string
            restoreWithTtlDisabled: false
        uniqueKeyPolicy:
            uniqueKeys:
                - paths:
                    - string
        vectorEmbeddingPolicy:
            vectorEmbeddings:
                - dataType: string
                  dimensions: 0
                  distanceFunction: string
                  path: string
    resourceGroupName: string
Copy

DatabaseAccountSqlContainer Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DatabaseAccountSqlContainer resource accepts the following input properties:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
Options This property is required. Dictionary<string, string>
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Resource This property is required. Pulumi.AzureNative.CosmosDB.Inputs.SqlContainerResource
The standard JSON format of a container
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
ContainerName Changes to this property will trigger replacement. string
Cosmos DB container name.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
Options This property is required. map[string]string
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Resource This property is required. SqlContainerResourceArgs
The standard JSON format of a container
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
ContainerName Changes to this property will trigger replacement. string
Cosmos DB container name.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database name.
options This property is required. Map<String,String>
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
resource This property is required. SqlContainerResource
The standard JSON format of a container
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.
containerName Changes to this property will trigger replacement. String
Cosmos DB container name.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
options This property is required. {[key: string]: string}
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
resource This property is required. SqlContainerResource
The standard JSON format of a container
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
containerName Changes to this property will trigger replacement. string
Cosmos DB container name.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
database_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database name.
options This property is required. Mapping[str, str]
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
resource This property is required. SqlContainerResourceArgs
The standard JSON format of a container
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure resource group.
container_name Changes to this property will trigger replacement. str
Cosmos DB container name.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database name.
options This property is required. Map<String>
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
resource This property is required. Property Map
The standard JSON format of a container
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.
containerName Changes to this property will trigger replacement. String
Cosmos DB container name.

Outputs

All input properties are implicitly available as output properties. Additionally, the DatabaseAccountSqlContainer resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
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 container.
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 container
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 provider-assigned unique ID for this managed resource.
Name string
The name of the database account.
Type string
The type of Azure resource.
ConflictResolutionPolicy ConflictResolutionPolicyResponse
The conflict resolution policy for the container.
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 container
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 provider-assigned unique ID for this managed resource.
name String
The name of the database account.
type String
The type of Azure resource.
conflictResolutionPolicy ConflictResolutionPolicyResponse
The conflict resolution policy for the container.
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 container
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 provider-assigned unique ID for this managed resource.
name string
The name of the database account.
type string
The type of Azure resource.
conflictResolutionPolicy ConflictResolutionPolicyResponse
The conflict resolution policy for the container.
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 container
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 provider-assigned unique ID for this managed resource.
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 container.
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 container
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 provider-assigned unique ID for this managed resource.
name String
The name of the database account.
type String
The type of Azure resource.
conflictResolutionPolicy Property Map
The conflict resolution policy for the container.
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 container
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

ClientEncryptionIncludedPath
, ClientEncryptionIncludedPathArgs

ClientEncryptionKeyId This property is required. string
The identifier of the Client Encryption Key to be used to encrypt the path.
EncryptionAlgorithm This property is required. string
The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
EncryptionType This property is required. string
The type of encryption to be performed. Eg - Deterministic, Randomized.
Path This property is required. string
Path that needs to be encrypted.
ClientEncryptionKeyId This property is required. string
The identifier of the Client Encryption Key to be used to encrypt the path.
EncryptionAlgorithm This property is required. string
The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
EncryptionType This property is required. string
The type of encryption to be performed. Eg - Deterministic, Randomized.
Path This property is required. string
Path that needs to be encrypted.
clientEncryptionKeyId This property is required. String
The identifier of the Client Encryption Key to be used to encrypt the path.
encryptionAlgorithm This property is required. String
The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType This property is required. String
The type of encryption to be performed. Eg - Deterministic, Randomized.
path This property is required. String
Path that needs to be encrypted.
clientEncryptionKeyId This property is required. string
The identifier of the Client Encryption Key to be used to encrypt the path.
encryptionAlgorithm This property is required. string
The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType This property is required. string
The type of encryption to be performed. Eg - Deterministic, Randomized.
path This property is required. string
Path that needs to be encrypted.
client_encryption_key_id This property is required. str
The identifier of the Client Encryption Key to be used to encrypt the path.
encryption_algorithm This property is required. str
The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
encryption_type This property is required. str
The type of encryption to be performed. Eg - Deterministic, Randomized.
path This property is required. str
Path that needs to be encrypted.
clientEncryptionKeyId This property is required. String
The identifier of the Client Encryption Key to be used to encrypt the path.
encryptionAlgorithm This property is required. String
The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType This property is required. String
The type of encryption to be performed. Eg - Deterministic, Randomized.
path This property is required. String
Path that needs to be encrypted.

ClientEncryptionPolicy
, ClientEncryptionPolicyArgs

IncludedPaths This property is required. List<Pulumi.AzureNative.CosmosDB.Inputs.ClientEncryptionIncludedPath>
Paths of the item that need encryption along with path-specific settings.
PolicyFormatVersion This property is required. int
Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
IncludedPaths This property is required. []ClientEncryptionIncludedPath
Paths of the item that need encryption along with path-specific settings.
PolicyFormatVersion This property is required. int
Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
includedPaths This property is required. List<ClientEncryptionIncludedPath>
Paths of the item that need encryption along with path-specific settings.
policyFormatVersion This property is required. Integer
Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
includedPaths This property is required. ClientEncryptionIncludedPath[]
Paths of the item that need encryption along with path-specific settings.
policyFormatVersion This property is required. number
Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
included_paths This property is required. Sequence[ClientEncryptionIncludedPath]
Paths of the item that need encryption along with path-specific settings.
policy_format_version This property is required. int
Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
includedPaths This property is required. List<Property Map>
Paths of the item that need encryption along with path-specific settings.
policyFormatVersion This property is required. Number
Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

CompositePath
, CompositePathArgs

Order string | Pulumi.AzureNative.CosmosDB.CompositePathSortOrder
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 | CompositePathSortOrder
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 | CompositePathSortOrder
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 | CompositePathSortOrder
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 | CompositePathSortOrder
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

Order string
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
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
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
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
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
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/*)

CompositePathSortOrder
, CompositePathSortOrderArgs

@Ascending
ascending
@Descending
descending
CompositePathSortOrderAscending
ascending
CompositePathSortOrderDescending
descending
Ascending
ascending
Descending
descending
Ascending
ascending
Descending
descending
ASCENDING
ascending
DESCENDING
descending
"ascending"
ascending
"descending"
descending

ComputedProperty
, ComputedPropertyArgs

Name string
The name of a computed property, for example - "cp_lowerName"
Query string
The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"
Name string
The name of a computed property, for example - "cp_lowerName"
Query string
The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"
name String
The name of a computed property, for example - "cp_lowerName"
query String
The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"
name string
The name of a computed property, for example - "cp_lowerName"
query string
The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"
name str
The name of a computed property, for example - "cp_lowerName"
query str
The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"
name String
The name of a computed property, for example - "cp_lowerName"
query String
The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode
, ConflictResolutionModeArgs

LastWriterWins
LastWriterWins
Custom
Custom
ConflictResolutionModeLastWriterWins
LastWriterWins
ConflictResolutionModeCustom
Custom
LastWriterWins
LastWriterWins
Custom
Custom
LastWriterWins
LastWriterWins
Custom
Custom
LAST_WRITER_WINS
LastWriterWins
CUSTOM
Custom
"LastWriterWins"
LastWriterWins
"Custom"
Custom

ConflictResolutionPolicy
, ConflictResolutionPolicyArgs

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 | Pulumi.AzureNative.CosmosDB.ConflictResolutionMode
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 | ConflictResolutionMode
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 | ConflictResolutionMode
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 | ConflictResolutionMode
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 | ConflictResolutionMode
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 | "LastWriterWins" | "Custom"
Indicates the conflict resolution mode.

ConflictResolutionPolicyResponse
, ConflictResolutionPolicyResponseArgs

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.

ContainerPartitionKey
, ContainerPartitionKeyArgs

Kind string | Pulumi.AzureNative.CosmosDB.PartitionKind
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 | PartitionKind
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 | PartitionKind
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 | PartitionKind
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 | PartitionKind
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" | "MultiHash"
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

SystemKey This property is required. 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
SystemKey This property is required. 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
systemKey This property is required. 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
systemKey This property is required. 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 This property is required. 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
systemKey This property is required. 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

CreateMode
, CreateModeArgs

Default
Default
Restore
Restore
CreateModeDefault
Default
CreateModeRestore
Restore
Default
Default
Restore
Restore
Default
Default
Restore
Restore
DEFAULT
Default
RESTORE
Restore
"Default"
Default
"Restore"
Restore

DataType
, DataTypeArgs

String
String
Number
Number
Point
Point
Polygon
Polygon
LineString
LineString
MultiPolygon
MultiPolygon
DataTypeString
String
DataTypeNumber
Number
DataTypePoint
Point
DataTypePolygon
Polygon
DataTypeLineString
LineString
DataTypeMultiPolygon
MultiPolygon
String
String
Number
Number
Point
Point
Polygon
Polygon
LineString
LineString
MultiPolygon
MultiPolygon
String
String
Number
Number
Point
Point
Polygon
Polygon
LineString
LineString
MultiPolygon
MultiPolygon
STRING
String
NUMBER
Number
POINT
Point
POLYGON
Polygon
LINE_STRING
LineString
MULTI_POLYGON
MultiPolygon
"String"
String
"Number"
Number
"Point"
Point
"Polygon"
Polygon
"LineString"
LineString
"MultiPolygon"
MultiPolygon

DistanceFunction
, DistanceFunctionArgs

Euclidean
euclidean
Cosine
cosine
Dotproduct
dotproduct
DistanceFunctionEuclidean
euclidean
DistanceFunctionCosine
cosine
DistanceFunctionDotproduct
dotproduct
Euclidean
euclidean
Cosine
cosine
Dotproduct
dotproduct
Euclidean
euclidean
Cosine
cosine
Dotproduct
dotproduct
EUCLIDEAN
euclidean
COSINE
cosine
DOTPRODUCT
dotproduct
"euclidean"
euclidean
"cosine"
cosine
"dotproduct"
dotproduct

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/*)

IncludedPath
, IncludedPathArgs

Indexes List<Pulumi.AzureNative.CosmosDB.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 []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 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.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/*)

IndexKind
, IndexKindArgs

Hash
Hash
Range
Range
Spatial
Spatial
IndexKindHash
Hash
IndexKindRange
Range
IndexKindSpatial
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

DataType string | Pulumi.AzureNative.CosmosDB.DataType
The datatype for which the indexing behavior is applied to.
Kind string | Pulumi.AzureNative.CosmosDB.IndexKind
Indicates the type of index.
Precision int
The precision of the index. -1 is maximum precision.
DataType string | DataType
The datatype for which the indexing behavior is applied to.
Kind string | IndexKind
Indicates the type of index.
Precision int
The precision of the index. -1 is maximum precision.
dataType String | DataType
The datatype for which the indexing behavior is applied to.
kind String | IndexKind
Indicates the type of index.
precision Integer
The precision of the index. -1 is maximum precision.
dataType string | DataType
The datatype for which the indexing behavior is applied to.
kind string | IndexKind
Indicates the type of index.
precision number
The precision of the index. -1 is maximum precision.
data_type str | DataType
The datatype for which the indexing behavior is applied to.
kind str | IndexKind
Indicates the type of index.
precision int
The precision of the index. -1 is maximum precision.
dataType String | "String" | "Number" | "Point" | "Polygon" | "LineString" | "MultiPolygon"
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

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.

IndexingMode
, IndexingModeArgs

Consistent
consistent
Lazy
lazy
None
none
IndexingModeConsistent
consistent
IndexingModeLazy
lazy
IndexingModeNone
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
CompositeIndexes [][]CompositePath
List of composite path list
ExcludedPaths []ExcludedPath
List of paths to exclude from indexing
IncludedPaths []IncludedPath
List of paths to include in the indexing
IndexingMode string | IndexingMode
Indicates the indexing mode.
SpatialIndexes []SpatialSpec
List of spatial specifics
VectorIndexes []VectorIndex
List of paths to include in the vector indexing
automatic Boolean
Indicates if the indexing policy is automatic
compositeIndexes List<List<CompositePath>>
List of composite path list
excludedPaths List<ExcludedPath>
List of paths to exclude from indexing
includedPaths List<IncludedPath>
List of paths to include in the indexing
indexingMode String | IndexingMode
Indicates the indexing mode.
spatialIndexes List<SpatialSpec>
List of spatial specifics
vectorIndexes List<VectorIndex>
List of paths to include in the vector indexing
automatic boolean
Indicates if the indexing policy is automatic
compositeIndexes CompositePath[][]
List of composite path list
excludedPaths ExcludedPath[]
List of paths to exclude from indexing
includedPaths IncludedPath[]
List of paths to include in the indexing
indexingMode string | IndexingMode
Indicates the indexing mode.
spatialIndexes SpatialSpec[]
List of spatial specifics
vectorIndexes VectorIndex[]
List of paths to include in the vector indexing
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
vector_indexes Sequence[VectorIndex]
List of paths to include in the vector indexing
automatic Boolean
Indicates if the indexing policy is automatic
compositeIndexes List<List<Property Map>>
List of composite path list
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 | "consistent" | "lazy" | "none"
Indicates the indexing mode.
spatialIndexes List<Property Map>
List of spatial specifics
vectorIndexes List<Property Map>
List of paths to include in the vector indexing

IndexingPolicyResponse
, IndexingPolicyResponseArgs

Automatic bool
Indicates if the indexing policy is automatic
CompositeIndexes [][]CompositePathResponse
List of composite path list
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.
SpatialIndexes []SpatialSpecResponse
List of spatial specifics
VectorIndexes []VectorIndexResponse
List of paths to include in the vector indexing
automatic Boolean
Indicates if the indexing policy is automatic
compositeIndexes List<List<CompositePathResponse>>
List of composite path list
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.
spatialIndexes List<SpatialSpecResponse>
List of spatial specifics
vectorIndexes List<VectorIndexResponse>
List of paths to include in the vector indexing
automatic boolean
Indicates if the indexing policy is automatic
compositeIndexes CompositePathResponse[][]
List of composite path list
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.
spatialIndexes SpatialSpecResponse[]
List of spatial specifics
vectorIndexes VectorIndexResponse[]
List of paths to include in the vector indexing
automatic bool
Indicates if the indexing policy is automatic
composite_indexes Sequence[Sequence[CompositePathResponse]]
List of composite path list
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.
spatial_indexes Sequence[SpatialSpecResponse]
List of spatial specifics
vector_indexes Sequence[VectorIndexResponse]
List of paths to include in the vector indexing
automatic Boolean
Indicates if the indexing policy is automatic
compositeIndexes List<List<Property Map>>
List of composite path list
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.
spatialIndexes List<Property Map>
List of spatial specifics
vectorIndexes List<Property Map>
List of paths to include in the vector indexing

PartitionKind
, PartitionKindArgs

Hash
Hash
Range
Range
MultiHash
MultiHash
PartitionKindHash
Hash
PartitionKindRange
Range
PartitionKindMultiHash
MultiHash
Hash
Hash
Range
Range
MultiHash
MultiHash
Hash
Hash
Range
Range
MultiHash
MultiHash
HASH
Hash
RANGE
Range
MULTI_HASH
MultiHash
"Hash"
Hash
"Range"
Range
"MultiHash"
MultiHash

ResourceRestoreParameters
, ResourceRestoreParametersArgs

RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
RestoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
RestoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
RestoreWithTtlDisabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource string
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc string
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restore_source str
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restore_timestamp_in_utc str
Time to which the account has to be restored (ISO-8601 format).
restore_with_ttl_disabled bool
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
restoreSource String
The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc String
Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled Boolean
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

SpatialSpec
, SpatialSpecArgs

Path string
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Types List<Union<string, Pulumi.AzureNative.CosmosDB.SpatialType>>
List of path's spatial type
Path string
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Types []string
List of path's spatial type
path String
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types List<Either<String,SpatialType>>
List of path's spatial type
path string
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types (string | SpatialType)[]
List of path's spatial type
path str
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types Sequence[Union[str, SpatialType]]
List of path's spatial type
path String
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types List<String | "Point" | "LineString" | "Polygon" | "MultiPolygon">
List of path's spatial type

SpatialSpecResponse
, SpatialSpecResponseArgs

Path string
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Types List<string>
List of path's spatial type
Path string
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Types []string
List of path's spatial type
path String
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types List<String>
List of path's spatial type
path string
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types string[]
List of path's spatial type
path str
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types Sequence[str]
List of path's spatial type
path String
The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
types List<String>
List of path's spatial type

SpatialType
, SpatialTypeArgs

Point
Point
LineString
LineString
Polygon
Polygon
MultiPolygon
MultiPolygon
SpatialTypePoint
Point
SpatialTypeLineString
LineString
SpatialTypePolygon
Polygon
SpatialTypeMultiPolygon
MultiPolygon
Point
Point
LineString
LineString
Polygon
Polygon
MultiPolygon
MultiPolygon
Point
Point
LineString
LineString
Polygon
Polygon
MultiPolygon
MultiPolygon
POINT
Point
LINE_STRING
LineString
POLYGON
Polygon
MULTI_POLYGON
MultiPolygon
"Point"
Point
"LineString"
LineString
"Polygon"
Polygon
"MultiPolygon"
MultiPolygon

SqlContainerResource
, SqlContainerResourceArgs

Id This property is required. string
Name of the Cosmos DB SQL container
AnalyticalStorageTtl double
Analytical TTL.
ClientEncryptionPolicy Pulumi.AzureNative.CosmosDB.Inputs.ClientEncryptionPolicy
The client encryption policy for the container.
ComputedProperties List<Pulumi.AzureNative.CosmosDB.Inputs.ComputedProperty>
List of computed properties
ConflictResolutionPolicy Pulumi.AzureNative.CosmosDB.Inputs.ConflictResolutionPolicy
The conflict resolution policy for the container.
CreateMode string | Pulumi.AzureNative.CosmosDB.CreateMode
Enum to indicate the mode of resource creation.
DefaultTtl int
Default time to live
IndexingPolicy Pulumi.AzureNative.CosmosDB.Inputs.IndexingPolicy
The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
PartitionKey Pulumi.AzureNative.CosmosDB.Inputs.ContainerPartitionKey
The configuration of the partition key to be used for partitioning data into multiple partitions
RestoreParameters Pulumi.AzureNative.CosmosDB.Inputs.ResourceRestoreParameters
Parameters to indicate the information about the restore
UniqueKeyPolicy Pulumi.AzureNative.CosmosDB.Inputs.UniqueKeyPolicy
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
VectorEmbeddingPolicy Pulumi.AzureNative.CosmosDB.Inputs.VectorEmbeddingPolicy
The vector embedding policy for the container.
Id This property is required. string
Name of the Cosmos DB SQL container
AnalyticalStorageTtl float64
Analytical TTL.
ClientEncryptionPolicy ClientEncryptionPolicy
The client encryption policy for the container.
ComputedProperties []ComputedProperty
List of computed properties
ConflictResolutionPolicy ConflictResolutionPolicy
The conflict resolution policy for the container.
CreateMode string | CreateMode
Enum to indicate the mode of resource creation.
DefaultTtl int
Default time to live
IndexingPolicy IndexingPolicy
The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
PartitionKey ContainerPartitionKey
The configuration of the partition key to be used for partitioning data into multiple partitions
RestoreParameters ResourceRestoreParameters
Parameters to indicate the information about the restore
UniqueKeyPolicy UniqueKeyPolicy
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
VectorEmbeddingPolicy VectorEmbeddingPolicy
The vector embedding policy for the container.
id This property is required. String
Name of the Cosmos DB SQL container
analyticalStorageTtl Double
Analytical TTL.
clientEncryptionPolicy ClientEncryptionPolicy
The client encryption policy for the container.
computedProperties List<ComputedProperty>
List of computed properties
conflictResolutionPolicy ConflictResolutionPolicy
The conflict resolution policy for the container.
createMode String | CreateMode
Enum to indicate the mode of resource creation.
defaultTtl Integer
Default time to live
indexingPolicy IndexingPolicy
The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
partitionKey ContainerPartitionKey
The configuration of the partition key to be used for partitioning data into multiple partitions
restoreParameters ResourceRestoreParameters
Parameters to indicate the information about the restore
uniqueKeyPolicy UniqueKeyPolicy
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
vectorEmbeddingPolicy VectorEmbeddingPolicy
The vector embedding policy for the container.
id This property is required. string
Name of the Cosmos DB SQL container
analyticalStorageTtl number
Analytical TTL.
clientEncryptionPolicy ClientEncryptionPolicy
The client encryption policy for the container.
computedProperties ComputedProperty[]
List of computed properties
conflictResolutionPolicy ConflictResolutionPolicy
The conflict resolution policy for the container.
createMode string | CreateMode
Enum to indicate the mode of resource creation.
defaultTtl number
Default time to live
indexingPolicy IndexingPolicy
The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
partitionKey ContainerPartitionKey
The configuration of the partition key to be used for partitioning data into multiple partitions
restoreParameters ResourceRestoreParameters
Parameters to indicate the information about the restore
uniqueKeyPolicy UniqueKeyPolicy
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
vectorEmbeddingPolicy VectorEmbeddingPolicy
The vector embedding policy for the container.
id This property is required. str
Name of the Cosmos DB SQL container
analytical_storage_ttl float
Analytical TTL.
client_encryption_policy ClientEncryptionPolicy
The client encryption policy for the container.
computed_properties Sequence[ComputedProperty]
List of computed properties
conflict_resolution_policy ConflictResolutionPolicy
The conflict resolution policy for the container.
create_mode str | CreateMode
Enum to indicate the mode of resource creation.
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 container
partition_key ContainerPartitionKey
The configuration of the partition key to be used for partitioning data into multiple partitions
restore_parameters ResourceRestoreParameters
Parameters to indicate the information about the restore
unique_key_policy UniqueKeyPolicy
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
vector_embedding_policy VectorEmbeddingPolicy
The vector embedding policy for the container.
id This property is required. String
Name of the Cosmos DB SQL container
analyticalStorageTtl Number
Analytical TTL.
clientEncryptionPolicy Property Map
The client encryption policy for the container.
computedProperties List<Property Map>
List of computed properties
conflictResolutionPolicy Property Map
The conflict resolution policy for the container.
createMode String | "Default" | "Restore"
Enum to indicate the mode of resource creation.
defaultTtl Number
Default time to live
indexingPolicy Property Map
The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
partitionKey Property Map
The configuration of the partition key to be used for partitioning data into multiple partitions
restoreParameters Property Map
Parameters to indicate the information about the restore
uniqueKeyPolicy Property Map
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
vectorEmbeddingPolicy Property Map
The vector embedding policy for the container.

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

UniqueKeys List<Pulumi.AzureNative.CosmosDB.Inputs.UniqueKey>
List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
UniqueKeys []UniqueKey
List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
uniqueKeys List<UniqueKey>
List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
uniqueKeys 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.
uniqueKeys 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

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
, 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

VectorDataType
, VectorDataTypeArgs

Float32
float32
Uint8
uint8
Int8
int8
VectorDataTypeFloat32
float32
VectorDataTypeUint8
uint8
VectorDataTypeInt8
int8
Float32
float32
Uint8
uint8
Int8
int8
Float32
float32
Uint8
uint8
Int8
int8
FLOAT32
float32
UINT8
uint8
INT8
int8
"float32"
float32
"uint8"
uint8
"int8"
int8

VectorEmbedding
, VectorEmbeddingArgs

DataType This property is required. string | Pulumi.AzureNative.CosmosDB.VectorDataType
Indicates the data type of vector.
Dimensions This property is required. int
The number of dimensions in the vector.
DistanceFunction This property is required. string | Pulumi.AzureNative.CosmosDB.DistanceFunction
The distance function to use for distance calculation in between vectors.
Path This property is required. string
The path to the vector field in the document.
DataType This property is required. string | VectorDataType
Indicates the data type of vector.
Dimensions This property is required. int
The number of dimensions in the vector.
DistanceFunction This property is required. string | DistanceFunction
The distance function to use for distance calculation in between vectors.
Path This property is required. string
The path to the vector field in the document.
dataType This property is required. String | VectorDataType
Indicates the data type of vector.
dimensions This property is required. Integer
The number of dimensions in the vector.
distanceFunction This property is required. String | DistanceFunction
The distance function to use for distance calculation in between vectors.
path This property is required. String
The path to the vector field in the document.
dataType This property is required. string | VectorDataType
Indicates the data type of vector.
dimensions This property is required. number
The number of dimensions in the vector.
distanceFunction This property is required. string | DistanceFunction
The distance function to use for distance calculation in between vectors.
path This property is required. string
The path to the vector field in the document.
data_type This property is required. str | VectorDataType
Indicates the data type of vector.
dimensions This property is required. int
The number of dimensions in the vector.
distance_function This property is required. str | DistanceFunction
The distance function to use for distance calculation in between vectors.
path This property is required. str
The path to the vector field in the document.
dataType This property is required. String | "float32" | "uint8" | "int8"
Indicates the data type of vector.
dimensions This property is required. Number
The number of dimensions in the vector.
distanceFunction This property is required. String | "euclidean" | "cosine" | "dotproduct"
The distance function to use for distance calculation in between vectors.
path This property is required. String
The path to the vector field in the document.

VectorEmbeddingPolicy
, VectorEmbeddingPolicyArgs

VectorEmbeddings []VectorEmbedding
List of vector embeddings
vectorEmbeddings List<VectorEmbedding>
List of vector embeddings
vectorEmbeddings VectorEmbedding[]
List of vector embeddings
vectorEmbeddings List<Property Map>
List of vector embeddings

VectorIndex
, VectorIndexArgs

Path This property is required. string
The path to the vector field in the document.
Type This property is required. string | Pulumi.AzureNative.CosmosDB.VectorIndexType
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
Path This property is required. string
The path to the vector field in the document.
Type This property is required. string | VectorIndexType
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
path This property is required. String
The path to the vector field in the document.
type This property is required. String | VectorIndexType
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
path This property is required. string
The path to the vector field in the document.
type This property is required. string | VectorIndexType
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
path This property is required. str
The path to the vector field in the document.
type This property is required. str | VectorIndexType
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
path This property is required. String
The path to the vector field in the document.
type This property is required. String | "flat" | "diskANN" | "quantizedFlat"
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

VectorIndexResponse
, VectorIndexResponseArgs

Path This property is required. string
The path to the vector field in the document.
Type This property is required. string
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
Path This property is required. string
The path to the vector field in the document.
Type This property is required. string
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
path This property is required. String
The path to the vector field in the document.
type This property is required. String
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
path This property is required. string
The path to the vector field in the document.
type This property is required. string
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
path This property is required. str
The path to the vector field in the document.
type This property is required. str
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
path This property is required. String
The path to the vector field in the document.
type This property is required. String
The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.

VectorIndexType
, VectorIndexTypeArgs

Flat
flat
DiskANN
diskANN
QuantizedFlat
quantizedFlat
VectorIndexTypeFlat
flat
VectorIndexTypeDiskANN
diskANN
VectorIndexTypeQuantizedFlat
quantizedFlat
Flat
flat
DiskANN
diskANN
QuantizedFlat
quantizedFlat
Flat
flat
DiskANN
diskANN
QuantizedFlat
quantizedFlat
FLAT
flat
DISK_ANN
diskANN
QUANTIZED_FLAT
quantizedFlat
"flat"
flat
"diskANN"
diskANN
"quantizedFlat"
quantizedFlat

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:cosmosdb:DatabaseAccountSqlContainer containerName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/sql/databases/{databaseName}/containers/{containerName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native