1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. SqlResourceSqlContainer
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi

azure-native.documentdb.SqlResourceSqlContainer

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi

    An Azure Cosmos DB container. Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-03-15.

    Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview.

    Example Usage

    CosmosDBSqlContainerCreateUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var sqlResourceSqlContainer = new AzureNative.DocumentDB.SqlResourceSqlContainer("sqlResourceSqlContainer", new()
        {
            AccountName = "ddb1",
            ContainerName = "containerName",
            DatabaseName = "databaseName",
            Location = "West US",
            Options = null,
            Resource = new AzureNative.DocumentDB.Inputs.SqlContainerResourceArgs
            {
                ClientEncryptionPolicy = new AzureNative.DocumentDB.Inputs.ClientEncryptionPolicyArgs
                {
                    IncludedPaths = new[]
                    {
                        new AzureNative.DocumentDB.Inputs.ClientEncryptionIncludedPathArgs
                        {
                            ClientEncryptionKeyId = "keyId",
                            EncryptionAlgorithm = "AEAD_AES_256_CBC_HMAC_SHA256",
                            EncryptionType = "Deterministic",
                            Path = "/path",
                        },
                    },
                    PolicyFormatVersion = 2,
                },
                ConflictResolutionPolicy = new AzureNative.DocumentDB.Inputs.ConflictResolutionPolicyArgs
                {
                    ConflictResolutionPath = "/path",
                    Mode = "LastWriterWins",
                },
                DefaultTtl = 100,
                Id = "containerName",
                IndexingPolicy = new AzureNative.DocumentDB.Inputs.IndexingPolicyArgs
                {
                    Automatic = true,
                    ExcludedPaths = new[] {},
                    IncludedPaths = new[]
                    {
                        new AzureNative.DocumentDB.Inputs.IncludedPathArgs
                        {
                            Indexes = new[]
                            {
                                new AzureNative.DocumentDB.Inputs.IndexesArgs
                                {
                                    DataType = "String",
                                    Kind = "Range",
                                    Precision = -1,
                                },
                                new AzureNative.DocumentDB.Inputs.IndexesArgs
                                {
                                    DataType = "Number",
                                    Kind = "Range",
                                    Precision = -1,
                                },
                            },
                            Path = "/*",
                        },
                    },
                    IndexingMode = "consistent",
                },
                PartitionKey = new AzureNative.DocumentDB.Inputs.ContainerPartitionKeyArgs
                {
                    Kind = "Hash",
                    Paths = new[]
                    {
                        "/AccountNumber",
                    },
                },
                UniqueKeyPolicy = new AzureNative.DocumentDB.Inputs.UniqueKeyPolicyArgs
                {
                    UniqueKeys = new[]
                    {
                        new AzureNative.DocumentDB.Inputs.UniqueKeyArgs
                        {
                            Paths = new[]
                            {
                                "/testPath",
                            },
                        },
                    },
                },
            },
            ResourceGroupName = "rg1",
            Tags = null,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    _, err := documentdb.NewSqlResourceSqlContainer(ctx, "sqlResourceSqlContainer", &documentdb.SqlResourceSqlContainerArgs{
    AccountName: pulumi.String("ddb1"),
    ContainerName: pulumi.String("containerName"),
    DatabaseName: pulumi.String("databaseName"),
    Location: pulumi.String("West US"),
    Options: nil,
    Resource: documentdb.SqlContainerGetPropertiesResponseResource{
    ClientEncryptionPolicy: interface{}{
    IncludedPaths: documentdb.ClientEncryptionIncludedPathArray{
    &documentdb.ClientEncryptionIncludedPathArgs{
    ClientEncryptionKeyId: pulumi.String("keyId"),
    EncryptionAlgorithm: pulumi.String("AEAD_AES_256_CBC_HMAC_SHA256"),
    EncryptionType: pulumi.String("Deterministic"),
    Path: pulumi.String("/path"),
    },
    },
    PolicyFormatVersion: pulumi.Int(2),
    },
    ConflictResolutionPolicy: &documentdb.ConflictResolutionPolicyArgs{
    ConflictResolutionPath: pulumi.String("/path"),
    Mode: pulumi.String("LastWriterWins"),
    },
    DefaultTtl: pulumi.Int(100),
    Id: pulumi.String("containerName"),
    IndexingPolicy: interface{}{
    Automatic: pulumi.Bool(true),
    ExcludedPaths: documentdb.ExcludedPathArray{
    },
    IncludedPaths: documentdb.IncludedPathArray{
    interface{}{
    Indexes: documentdb.IndexesArray{
    &documentdb.IndexesArgs{
    DataType: pulumi.String("String"),
    Kind: pulumi.String("Range"),
    Precision: -1,
    },
    &documentdb.IndexesArgs{
    DataType: pulumi.String("Number"),
    Kind: pulumi.String("Range"),
    Precision: -1,
    },
    },
    Path: pulumi.String("/*"),
    },
    },
    IndexingMode: pulumi.String("consistent"),
    },
    PartitionKey: &documentdb.ContainerPartitionKeyArgs{
    Kind: pulumi.String("Hash"),
    Paths: pulumi.StringArray{
    pulumi.String("/AccountNumber"),
    },
    },
    UniqueKeyPolicy: interface{}{
    UniqueKeys: documentdb.UniqueKeyArray{
    &documentdb.UniqueKeyArgs{
    Paths: pulumi.StringArray{
    pulumi.String("/testPath"),
    },
    },
    },
    },
    },
    ResourceGroupName: pulumi.String("rg1"),
    Tags: nil,
    })
    if err != nil {
    return err
    }
    return nil
    })
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.documentdb.SqlResourceSqlContainer;
    import com.pulumi.azurenative.documentdb.SqlResourceSqlContainerArgs;
    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 sqlResourceSqlContainer = new SqlResourceSqlContainer("sqlResourceSqlContainer", SqlResourceSqlContainerArgs.builder()        
                .accountName("ddb1")
                .containerName("containerName")
                .databaseName("databaseName")
                .location("West US")
                .options()
                .resource(Map.ofEntries(
                    Map.entry("clientEncryptionPolicy", Map.ofEntries(
                        Map.entry("includedPaths", Map.ofEntries(
                            Map.entry("clientEncryptionKeyId", "keyId"),
                            Map.entry("encryptionAlgorithm", "AEAD_AES_256_CBC_HMAC_SHA256"),
                            Map.entry("encryptionType", "Deterministic"),
                            Map.entry("path", "/path")
                        )),
                        Map.entry("policyFormatVersion", 2)
                    )),
                    Map.entry("conflictResolutionPolicy", Map.ofEntries(
                        Map.entry("conflictResolutionPath", "/path"),
                        Map.entry("mode", "LastWriterWins")
                    )),
                    Map.entry("defaultTtl", 100),
                    Map.entry("id", "containerName"),
                    Map.entry("indexingPolicy", Map.ofEntries(
                        Map.entry("automatic", true),
                        Map.entry("excludedPaths", ),
                        Map.entry("includedPaths", Map.ofEntries(
                            Map.entry("indexes",                         
                                Map.ofEntries(
                                    Map.entry("dataType", "String"),
                                    Map.entry("kind", "Range"),
                                    Map.entry("precision", "TODO: GenUnaryOpExpression")
                                ),
                                Map.ofEntries(
                                    Map.entry("dataType", "Number"),
                                    Map.entry("kind", "Range"),
                                    Map.entry("precision", "TODO: GenUnaryOpExpression")
                                )),
                            Map.entry("path", "/*")
                        )),
                        Map.entry("indexingMode", "consistent")
                    )),
                    Map.entry("partitionKey", Map.ofEntries(
                        Map.entry("kind", "Hash"),
                        Map.entry("paths", "/AccountNumber")
                    )),
                    Map.entry("uniqueKeyPolicy", Map.of("uniqueKeys", Map.of("paths", "/testPath")))
                ))
                .resourceGroupName("rg1")
                .tags()
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    sql_resource_sql_container = azure_native.documentdb.SqlResourceSqlContainer("sqlResourceSqlContainer",
        account_name="ddb1",
        container_name="containerName",
        database_name="databaseName",
        location="West US",
        options=azure_native.documentdb.CreateUpdateOptionsArgs(),
        resource=azure_native.documentdb.SqlContainerGetPropertiesResponseResourceArgs(
            client_encryption_policy={
                "includedPaths": [azure_native.documentdb.ClientEncryptionIncludedPathArgs(
                    client_encryption_key_id="keyId",
                    encryption_algorithm="AEAD_AES_256_CBC_HMAC_SHA256",
                    encryption_type="Deterministic",
                    path="/path",
                )],
                "policyFormatVersion": 2,
            },
            conflict_resolution_policy=azure_native.documentdb.ConflictResolutionPolicyArgs(
                conflict_resolution_path="/path",
                mode="LastWriterWins",
            ),
            default_ttl=100,
            id="containerName",
            indexing_policy={
                "automatic": True,
                "excludedPaths": [],
                "includedPaths": [{
                    "indexes": [
                        azure_native.documentdb.IndexesArgs(
                            data_type="String",
                            kind="Range",
                            precision=-1,
                        ),
                        azure_native.documentdb.IndexesArgs(
                            data_type="Number",
                            kind="Range",
                            precision=-1,
                        ),
                    ],
                    "path": "/*",
                }],
                "indexingMode": "consistent",
            },
            partition_key=azure_native.documentdb.ContainerPartitionKeyArgs(
                kind="Hash",
                paths=["/AccountNumber"],
            ),
            unique_key_policy={
                "uniqueKeys": [azure_native.documentdb.UniqueKeyArgs(
                    paths=["/testPath"],
                )],
            },
        ),
        resource_group_name="rg1",
        tags={})
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const sqlResourceSqlContainer = new azure_native.documentdb.SqlResourceSqlContainer("sqlResourceSqlContainer", {
        accountName: "ddb1",
        containerName: "containerName",
        databaseName: "databaseName",
        location: "West US",
        options: {},
        resource: {
            clientEncryptionPolicy: {
                includedPaths: [{
                    clientEncryptionKeyId: "keyId",
                    encryptionAlgorithm: "AEAD_AES_256_CBC_HMAC_SHA256",
                    encryptionType: "Deterministic",
                    path: "/path",
                }],
                policyFormatVersion: 2,
            },
            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",
        tags: {},
    });
    

    Create SqlResourceSqlContainer Resource

    new SqlResourceSqlContainer(name: string, args: SqlResourceSqlContainerArgs, opts?: CustomResourceOptions);
    @overload
    def SqlResourceSqlContainer(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                account_name: Optional[str] = None,
                                container_name: Optional[str] = None,
                                database_name: Optional[str] = None,
                                location: Optional[str] = None,
                                options: Optional[CreateUpdateOptionsArgs] = None,
                                resource: Optional[SqlContainerResourceArgs] = None,
                                resource_group_name: Optional[str] = None,
                                tags: Optional[Mapping[str, str]] = None)
    @overload
    def SqlResourceSqlContainer(resource_name: str,
                                args: SqlResourceSqlContainerArgs,
                                opts: Optional[ResourceOptions] = None)
    func NewSqlResourceSqlContainer(ctx *Context, name string, args SqlResourceSqlContainerArgs, opts ...ResourceOption) (*SqlResourceSqlContainer, error)
    public SqlResourceSqlContainer(string name, SqlResourceSqlContainerArgs args, CustomResourceOptions? opts = null)
    public SqlResourceSqlContainer(String name, SqlResourceSqlContainerArgs args)
    public SqlResourceSqlContainer(String name, SqlResourceSqlContainerArgs args, CustomResourceOptions options)
    
    type: azure-native:documentdb:SqlResourceSqlContainer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args SqlResourceSqlContainerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SqlResourceSqlContainerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SqlResourceSqlContainerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlResourceSqlContainerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlResourceSqlContainerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SqlResourceSqlContainer Resource Properties

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

    Inputs

    The SqlResourceSqlContainer resource accepts the following input properties:

    AccountName string
    Cosmos DB database account name.
    DatabaseName string
    Cosmos DB database name.
    Resource Pulumi.AzureNative.DocumentDB.Inputs.SqlContainerResource
    The standard JSON format of a container
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ContainerName string
    Cosmos DB container name.
    Location string
    The location of the resource group to which the resource belongs.
    Options Pulumi.AzureNative.DocumentDB.Inputs.CreateUpdateOptions
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    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".
    AccountName string
    Cosmos DB database account name.
    DatabaseName string
    Cosmos DB database name.
    Resource SqlContainerResourceArgs
    The standard JSON format of a container
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ContainerName string
    Cosmos DB container name.
    Location string
    The location of the resource group to which the resource belongs.
    Options CreateUpdateOptionsArgs
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    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".
    accountName String
    Cosmos DB database account name.
    databaseName String
    Cosmos DB database name.
    resource SqlContainerResource
    The standard JSON format of a container
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    containerName String
    Cosmos DB container name.
    location String
    The location of the resource group to which the resource belongs.
    options CreateUpdateOptions
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    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".
    accountName string
    Cosmos DB database account name.
    databaseName string
    Cosmos DB database name.
    resource SqlContainerResource
    The standard JSON format of a container
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    containerName string
    Cosmos DB container name.
    location string
    The location of the resource group to which the resource belongs.
    options CreateUpdateOptions
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    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".
    account_name str
    Cosmos DB database account name.
    database_name str
    Cosmos DB database name.
    resource SqlContainerResourceArgs
    The standard JSON format of a container
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    container_name str
    Cosmos DB container name.
    location str
    The location of the resource group to which the resource belongs.
    options CreateUpdateOptionsArgs
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    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".
    accountName String
    Cosmos DB database account name.
    databaseName String
    Cosmos DB database name.
    resource Property Map
    The standard JSON format of a container
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    containerName String
    Cosmos DB container name.
    location String
    The location of the resource group to which the resource belongs.
    options Property Map
    A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
    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".

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the ARM resource.
    Type string
    The type of Azure resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the ARM resource.
    Type string
    The type of Azure resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the ARM resource.
    type String
    The type of Azure resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the ARM resource.
    type string
    The type of Azure resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the ARM resource.
    type str
    The type of Azure resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the ARM resource.
    type String
    The type of Azure resource.

    Supporting Types

    AutoscaleSettings, AutoscaleSettingsArgs

    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Integer
    Represents maximum throughput, the resource can scale up to.
    maxThroughput number
    Represents maximum throughput, the resource can scale up to.
    max_throughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Number
    Represents maximum throughput, the resource can scale up to.

    AutoscaleSettingsResponse, AutoscaleSettingsResponseArgs

    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Integer
    Represents maximum throughput, the resource can scale up to.
    maxThroughput number
    Represents maximum throughput, the resource can scale up to.
    max_throughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Number
    Represents maximum throughput, the resource can scale up to.

    ClientEncryptionIncludedPath, ClientEncryptionIncludedPathArgs

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

    ClientEncryptionIncludedPathResponse, ClientEncryptionIncludedPathResponseArgs

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

    ClientEncryptionPolicy, ClientEncryptionPolicyArgs

    IncludedPaths List<Pulumi.AzureNative.DocumentDB.Inputs.ClientEncryptionIncludedPath>
    Paths of the item that need encryption along with path-specific settings.
    PolicyFormatVersion int
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
    IncludedPaths []ClientEncryptionIncludedPath
    Paths of the item that need encryption along with path-specific settings.
    PolicyFormatVersion int
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
    includedPaths List<ClientEncryptionIncludedPath>
    Paths of the item that need encryption along with path-specific settings.
    policyFormatVersion Integer
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
    includedPaths ClientEncryptionIncludedPath[]
    Paths of the item that need encryption along with path-specific settings.
    policyFormatVersion 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 Sequence[ClientEncryptionIncludedPath]
    Paths of the item that need encryption along with path-specific settings.
    policy_format_version int
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
    includedPaths List<Property Map>
    Paths of the item that need encryption along with path-specific settings.
    policyFormatVersion Number
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.

    ClientEncryptionPolicyResponse, ClientEncryptionPolicyResponseArgs

    IncludedPaths List<Pulumi.AzureNative.DocumentDB.Inputs.ClientEncryptionIncludedPathResponse>
    Paths of the item that need encryption along with path-specific settings.
    PolicyFormatVersion int
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
    IncludedPaths []ClientEncryptionIncludedPathResponse
    Paths of the item that need encryption along with path-specific settings.
    PolicyFormatVersion int
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
    includedPaths List<ClientEncryptionIncludedPathResponse>
    Paths of the item that need encryption along with path-specific settings.
    policyFormatVersion Integer
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
    includedPaths ClientEncryptionIncludedPathResponse[]
    Paths of the item that need encryption along with path-specific settings.
    policyFormatVersion 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 Sequence[ClientEncryptionIncludedPathResponse]
    Paths of the item that need encryption along with path-specific settings.
    policy_format_version int
    Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
    includedPaths List<Property Map>
    Paths of the item that need encryption along with path-specific settings.
    policyFormatVersion 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.DocumentDB.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

    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.DocumentDB.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.DocumentDB.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 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 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 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 boolean
    Indicates if the container is using a system generated partition key
    kind string
    Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
    paths string[]
    List of paths using which data within the container can be partitioned
    version number
    Indicates the version of the partition key definition
    system_key bool
    Indicates if the container is using a system generated partition key
    kind str
    Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
    paths Sequence[str]
    List of paths using which data within the container can be partitioned
    version int
    Indicates the version of the partition key definition
    systemKey Boolean
    Indicates if the container is using a system generated partition key
    kind String
    Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
    paths List<String>
    List of paths using which data within the container can be partitioned
    version Number
    Indicates the version of the partition key definition

    CreateUpdateOptions, CreateUpdateOptionsArgs

    AutoscaleSettings Pulumi.AzureNative.DocumentDB.Inputs.AutoscaleSettings
    Specifies the Autoscale settings.
    Throughput int
    Request Units per second. For example, "throughput": 10000.
    AutoscaleSettings AutoscaleSettings
    Specifies the Autoscale settings.
    Throughput int
    Request Units per second. For example, "throughput": 10000.
    autoscaleSettings AutoscaleSettings
    Specifies the Autoscale settings.
    throughput Integer
    Request Units per second. For example, "throughput": 10000.
    autoscaleSettings AutoscaleSettings
    Specifies the Autoscale settings.
    throughput number
    Request Units per second. For example, "throughput": 10000.
    autoscale_settings AutoscaleSettings
    Specifies the Autoscale settings.
    throughput int
    Request Units per second. For example, "throughput": 10000.
    autoscaleSettings Property Map
    Specifies the Autoscale settings.
    throughput Number
    Request Units per second. For example, "throughput": 10000.

    DataType, DataTypeArgs

    String
    String
    Number
    Number
    Point
    Point
    Polygon
    Polygon
    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

    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.DocumentDB.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.DocumentDB.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.DocumentDB.DataType
    The datatype for which the indexing behavior is applied to.
    Kind string | Pulumi.AzureNative.DocumentDB.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
    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
    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
    automatic bool
    Indicates if the indexing policy is automatic
    composite_indexes Sequence[Sequence[CompositePath]]
    List of composite path list
    excluded_paths Sequence[ExcludedPath]
    List of paths to exclude from indexing
    included_paths Sequence[IncludedPath]
    List of paths to include in the indexing
    indexing_mode str | IndexingMode
    Indicates the indexing mode.
    spatial_indexes Sequence[SpatialSpec]
    List of spatial specifics
    automatic Boolean
    Indicates if the indexing policy is automatic
    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

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

    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

    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.DocumentDB.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

    SqlContainerGetPropertiesResponseOptions, SqlContainerGetPropertiesResponseOptionsArgs

    AutoscaleSettings Pulumi.AzureNative.DocumentDB.Inputs.AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    Throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    AutoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    Throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput Integer
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput number
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscale_settings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings Property Map
    Specifies the Autoscale settings.
    throughput Number
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

    SqlContainerGetPropertiesResponseResource, SqlContainerGetPropertiesResponseResourceArgs

    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB SQL container
    Rid string
    A system generated property. A unique identifier.
    Ts double
    A system generated property that denotes the last updated timestamp of the resource.
    AnalyticalStorageTtl double
    Analytical TTL.
    ClientEncryptionPolicy Pulumi.AzureNative.DocumentDB.Inputs.ClientEncryptionPolicyResponse
    The client encryption policy for the container.
    ConflictResolutionPolicy Pulumi.AzureNative.DocumentDB.Inputs.ConflictResolutionPolicyResponse
    The conflict resolution policy for the container.
    DefaultTtl int
    Default time to live
    IndexingPolicy Pulumi.AzureNative.DocumentDB.Inputs.IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
    PartitionKey Pulumi.AzureNative.DocumentDB.Inputs.ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    UniqueKeyPolicy Pulumi.AzureNative.DocumentDB.Inputs.UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB SQL container
    Rid string
    A system generated property. A unique identifier.
    Ts float64
    A system generated property that denotes the last updated timestamp of the resource.
    AnalyticalStorageTtl float64
    Analytical TTL.
    ClientEncryptionPolicy ClientEncryptionPolicyResponse
    The client encryption policy for the container.
    ConflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the container.
    DefaultTtl int
    Default time to live
    IndexingPolicy IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
    PartitionKey ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    UniqueKeyPolicy UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    id String
    Name of the Cosmos DB SQL container
    rid String
    A system generated property. A unique identifier.
    ts Double
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl Double
    Analytical TTL.
    clientEncryptionPolicy ClientEncryptionPolicyResponse
    The client encryption policy for the container.
    conflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the container.
    defaultTtl Integer
    Default time to live
    indexingPolicy IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
    partitionKey ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    uniqueKeyPolicy UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    id string
    Name of the Cosmos DB SQL container
    rid string
    A system generated property. A unique identifier.
    ts number
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl number
    Analytical TTL.
    clientEncryptionPolicy ClientEncryptionPolicyResponse
    The client encryption policy for the container.
    conflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the container.
    defaultTtl number
    Default time to live
    indexingPolicy IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
    partitionKey ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    uniqueKeyPolicy UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    etag str
    A system generated property representing the resource etag required for optimistic concurrency control.
    id str
    Name of the Cosmos DB SQL container
    rid str
    A system generated property. A unique identifier.
    ts float
    A system generated property that denotes the last updated timestamp of the resource.
    analytical_storage_ttl float
    Analytical TTL.
    client_encryption_policy ClientEncryptionPolicyResponse
    The client encryption policy for the container.
    conflict_resolution_policy ConflictResolutionPolicyResponse
    The conflict resolution policy for the container.
    default_ttl int
    Default time to live
    indexing_policy IndexingPolicyResponse
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
    partition_key ContainerPartitionKeyResponse
    The configuration of the partition key to be used for partitioning data into multiple partitions
    unique_key_policy UniqueKeyPolicyResponse
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    id String
    Name of the Cosmos DB SQL container
    rid String
    A system generated property. A unique identifier.
    ts Number
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl Number
    Analytical TTL.
    clientEncryptionPolicy Property Map
    The client encryption policy for the container.
    conflictResolutionPolicy Property Map
    The conflict resolution policy for the container.
    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
    uniqueKeyPolicy Property Map
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

    SqlContainerResource, SqlContainerResourceArgs

    Id string
    Name of the Cosmos DB SQL container
    AnalyticalStorageTtl double
    Analytical TTL.
    ClientEncryptionPolicy Pulumi.AzureNative.DocumentDB.Inputs.ClientEncryptionPolicy
    The client encryption policy for the container.
    ConflictResolutionPolicy Pulumi.AzureNative.DocumentDB.Inputs.ConflictResolutionPolicy
    The conflict resolution policy for the container.
    DefaultTtl int
    Default time to live
    IndexingPolicy Pulumi.AzureNative.DocumentDB.Inputs.IndexingPolicy
    The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
    PartitionKey Pulumi.AzureNative.DocumentDB.Inputs.ContainerPartitionKey
    The configuration of the partition key to be used for partitioning data into multiple partitions
    UniqueKeyPolicy Pulumi.AzureNative.DocumentDB.Inputs.UniqueKeyPolicy
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    Id string
    Name of the Cosmos DB SQL container
    AnalyticalStorageTtl float64
    Analytical TTL.
    ClientEncryptionPolicy ClientEncryptionPolicy
    The client encryption policy for the container.
    ConflictResolutionPolicy ConflictResolutionPolicy
    The conflict resolution policy for the container.
    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
    UniqueKeyPolicy UniqueKeyPolicy
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    id String
    Name of the Cosmos DB SQL container
    analyticalStorageTtl Double
    Analytical TTL.
    clientEncryptionPolicy ClientEncryptionPolicy
    The client encryption policy for the container.
    conflictResolutionPolicy ConflictResolutionPolicy
    The conflict resolution policy for the container.
    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
    uniqueKeyPolicy UniqueKeyPolicy
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    id string
    Name of the Cosmos DB SQL container
    analyticalStorageTtl number
    Analytical TTL.
    clientEncryptionPolicy ClientEncryptionPolicy
    The client encryption policy for the container.
    conflictResolutionPolicy ConflictResolutionPolicy
    The conflict resolution policy for the container.
    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
    uniqueKeyPolicy UniqueKeyPolicy
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    id str
    Name of the Cosmos DB SQL container
    analytical_storage_ttl float
    Analytical TTL.
    client_encryption_policy ClientEncryptionPolicy
    The client encryption policy for the container.
    conflict_resolution_policy ConflictResolutionPolicy
    The conflict resolution policy for the container.
    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
    unique_key_policy UniqueKeyPolicy
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
    id String
    Name of the Cosmos DB SQL container
    analyticalStorageTtl Number
    Analytical TTL.
    clientEncryptionPolicy Property Map
    The client encryption policy for the container.
    conflictResolutionPolicy Property Map
    The conflict resolution policy for the container.
    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
    uniqueKeyPolicy Property Map
    The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

    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.DocumentDB.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.DocumentDB.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

    Import

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

    $ pulumi import azure-native:documentdb:SqlResourceSqlContainer containerName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi