1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getDatabaseAccountSqlContainer
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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.cosmosdb.getDatabaseAccountSqlContainer

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Gets the SQL container under an existing Azure Cosmos DB database account.

    Uses Azure REST API version 2016-03-31.

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

    Using getDatabaseAccountSqlContainer

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

    function getDatabaseAccountSqlContainer(args: GetDatabaseAccountSqlContainerArgs, opts?: InvokeOptions): Promise<GetDatabaseAccountSqlContainerResult>
function getDatabaseAccountSqlContainerOutput(args: GetDatabaseAccountSqlContainerOutputArgs, opts?: InvokeOptions): Output<GetDatabaseAccountSqlContainerResult>
    def get_database_account_sql_container(account_name: Optional[str] = None,
                                       container_name: Optional[str] = None,
                                       database_name: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetDatabaseAccountSqlContainerResult
def get_database_account_sql_container_output(account_name: Optional[pulumi.Input[str]] = None,
                                       container_name: Optional[pulumi.Input[str]] = None,
                                       database_name: Optional[pulumi.Input[str]] = None,
                                       resource_group_name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseAccountSqlContainerResult]
    func LookupDatabaseAccountSqlContainer(ctx *Context, args *LookupDatabaseAccountSqlContainerArgs, opts ...InvokeOption) (*LookupDatabaseAccountSqlContainerResult, error)
func LookupDatabaseAccountSqlContainerOutput(ctx *Context, args *LookupDatabaseAccountSqlContainerOutputArgs, opts ...InvokeOption) LookupDatabaseAccountSqlContainerResultOutput

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

    public static class GetDatabaseAccountSqlContainer 
{
    public static Task<GetDatabaseAccountSqlContainerResult> InvokeAsync(GetDatabaseAccountSqlContainerArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseAccountSqlContainerResult> Invoke(GetDatabaseAccountSqlContainerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseAccountSqlContainerResult> getDatabaseAccountSqlContainer(GetDatabaseAccountSqlContainerArgs args, InvokeOptions options)
public static Output<GetDatabaseAccountSqlContainerResult> getDatabaseAccountSqlContainer(GetDatabaseAccountSqlContainerArgs args, InvokeOptions options)

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

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    ContainerName string
    Cosmos DB container name.
    DatabaseName string
    Cosmos DB database name.
    ResourceGroupName string
    Name of an Azure resource group.
    AccountName string
    Cosmos DB database account name.
    ContainerName string
    Cosmos DB container name.
    DatabaseName string
    Cosmos DB database name.
    ResourceGroupName string
    Name of an Azure resource group.
    accountName String
    Cosmos DB database account name.
    containerName String
    Cosmos DB container name.
    databaseName String
    Cosmos DB database name.
    resourceGroupName String
    Name of an Azure resource group.
    accountName string
    Cosmos DB database account name.
    containerName string
    Cosmos DB container name.
    databaseName string
    Cosmos DB database name.
    resourceGroupName string
    Name of an Azure resource group.
    account_name str
    Cosmos DB database account name.
    container_name str
    Cosmos DB container name.
    database_name str
    Cosmos DB database name.
    resource_group_name str
    Name of an Azure resource group.
    accountName String
    Cosmos DB database account name.
    containerName String
    Cosmos DB container name.
    databaseName String
    Cosmos DB database name.
    resourceGroupName String
    Name of an Azure resource group.

    getDatabaseAccountSqlContainer Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    ConflictResolutionPolicy Pulumi.AzureNative.CosmosDB.Outputs.ConflictResolutionPolicyResponse
    The conflict resolution policy for the 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 unique resource identifier of the database account.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    ConflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the 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 unique resource identifier of the database account.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    conflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the 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 unique resource identifier of the database account.
    name string
    The name of the database account.
    type string
    The type of Azure resource.
    conflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the 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 unique resource identifier of the database account.
    name str
    The name of the database account.
    type str
    The type of Azure resource.
    conflict_resolution_policy ConflictResolutionPolicyResponse
    The conflict resolution policy for the 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 unique resource identifier of the database account.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    conflictResolutionPolicy Property Map
    The conflict resolution policy for the 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

    CompositePathResponse

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

    ConflictResolutionPolicyResponse

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

    ContainerPartitionKeyResponse

    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

    ExcludedPathResponse

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

    FullTextIndexPathResponse

    Path string
    The path to the full text field in the document.
    Path string
    The path to the full text field in the document.
    path String
    The path to the full text field in the document.
    path string
    The path to the full text field in the document.
    path str
    The path to the full text field in the document.
    path String
    The path to the full text field in the document.

    IncludedPathResponse

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

    IndexesResponse

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

    IndexingPolicyResponse

    Automatic bool
    Indicates if the indexing policy is automatic
    CompositeIndexes List<ImmutableArray<Pulumi.AzureNative.CosmosDB.Inputs.CompositePathResponse>>
    List of composite path list
    ExcludedPaths List<Pulumi.AzureNative.CosmosDB.Inputs.ExcludedPathResponse>
    List of paths to exclude from indexing
    FullTextIndexes List<Pulumi.AzureNative.CosmosDB.Inputs.FullTextIndexPathResponse>
    List of paths to include in the full text indexing
    IncludedPaths List<Pulumi.AzureNative.CosmosDB.Inputs.IncludedPathResponse>
    List of paths to include in the indexing
    IndexingMode string
    Indicates the indexing mode.
    SpatialIndexes List<Pulumi.AzureNative.CosmosDB.Inputs.SpatialSpecResponse>
    List of spatial specifics
    VectorIndexes List<Pulumi.AzureNative.CosmosDB.Inputs.VectorIndexResponse>
    List of paths to include in the vector indexing
    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
    FullTextIndexes []FullTextIndexPathResponse
    List of paths to include in the full text 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
    fullTextIndexes List<FullTextIndexPathResponse>
    List of paths to include in the full text 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
    fullTextIndexes FullTextIndexPathResponse[]
    List of paths to include in the full text 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
    full_text_indexes Sequence[FullTextIndexPathResponse]
    List of paths to include in the full text 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
    fullTextIndexes List<Property Map>
    List of paths to include in the full text 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

    SpatialSpecResponse

    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

    UniqueKeyPolicyResponse

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

    UniqueKeyResponse

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

    VectorIndexResponse

    Path string
    The path to the vector field in the document.
    Type string
    The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
    IndexingSearchListSize double
    This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
    QuantizationByteSize double
    The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
    VectorIndexShardKey List<string>
    Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
    Path string
    The path to the vector field in the document.
    Type string
    The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
    IndexingSearchListSize float64
    This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
    QuantizationByteSize float64
    The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
    VectorIndexShardKey []string
    Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
    path String
    The path to the vector field in the document.
    type String
    The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
    indexingSearchListSize Double
    This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
    quantizationByteSize Double
    The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
    vectorIndexShardKey List<String>
    Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
    path string
    The path to the vector field in the document.
    type string
    The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
    indexingSearchListSize number
    This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
    quantizationByteSize number
    The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
    vectorIndexShardKey string[]
    Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
    path str
    The path to the vector field in the document.
    type str
    The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
    indexing_search_list_size float
    This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
    quantization_byte_size float
    The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
    vector_index_shard_key Sequence[str]
    Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.
    path String
    The path to the vector field in the document.
    type String
    The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported.
    indexingSearchListSize Number
    This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type.
    quantizationByteSize Number
    The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types.
    vectorIndexShardKey List<String>
    Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Meet Neo: Your AI Platform Teammate