1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getGremlinResourceGremlinGraph
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.documentdb.getGremlinResourceGremlinGraph

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.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Gets the Gremlin graph under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-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.

    Using getGremlinResourceGremlinGraph

    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 getGremlinResourceGremlinGraph(args: GetGremlinResourceGremlinGraphArgs, opts?: InvokeOptions): Promise<GetGremlinResourceGremlinGraphResult>
    function getGremlinResourceGremlinGraphOutput(args: GetGremlinResourceGremlinGraphOutputArgs, opts?: InvokeOptions): Output<GetGremlinResourceGremlinGraphResult>
    def get_gremlin_resource_gremlin_graph(account_name: Optional[str] = None,
                                           database_name: Optional[str] = None,
                                           graph_name: Optional[str] = None,
                                           resource_group_name: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetGremlinResourceGremlinGraphResult
    def get_gremlin_resource_gremlin_graph_output(account_name: Optional[pulumi.Input[str]] = None,
                                           database_name: Optional[pulumi.Input[str]] = None,
                                           graph_name: Optional[pulumi.Input[str]] = None,
                                           resource_group_name: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetGremlinResourceGremlinGraphResult]
    func LookupGremlinResourceGremlinGraph(ctx *Context, args *LookupGremlinResourceGremlinGraphArgs, opts ...InvokeOption) (*LookupGremlinResourceGremlinGraphResult, error)
    func LookupGremlinResourceGremlinGraphOutput(ctx *Context, args *LookupGremlinResourceGremlinGraphOutputArgs, opts ...InvokeOption) LookupGremlinResourceGremlinGraphResultOutput

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

    public static class GetGremlinResourceGremlinGraph 
    {
        public static Task<GetGremlinResourceGremlinGraphResult> InvokeAsync(GetGremlinResourceGremlinGraphArgs args, InvokeOptions? opts = null)
        public static Output<GetGremlinResourceGremlinGraphResult> Invoke(GetGremlinResourceGremlinGraphInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGremlinResourceGremlinGraphResult> getGremlinResourceGremlinGraph(GetGremlinResourceGremlinGraphArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:documentdb:getGremlinResourceGremlinGraph
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    DatabaseName string
    Cosmos DB database name.
    GraphName string
    Cosmos DB graph name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    Cosmos DB database account name.
    DatabaseName string
    Cosmos DB database name.
    GraphName string
    Cosmos DB graph name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    databaseName String
    Cosmos DB database name.
    graphName String
    Cosmos DB graph name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    Cosmos DB database account name.
    databaseName string
    Cosmos DB database name.
    graphName string
    Cosmos DB graph name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    Cosmos DB database account name.
    database_name str
    Cosmos DB database name.
    graph_name str
    Cosmos DB graph name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    databaseName String
    Cosmos DB database name.
    graphName String
    Cosmos DB graph name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getGremlinResourceGremlinGraph Result

    The following output properties are available:

    Id string
    The unique resource identifier of the ARM resource.
    Name string
    The name of the ARM resource.
    Type string
    The type of Azure resource.
    Location string
    The location of the resource group to which the resource belongs.
    Options Pulumi.AzureNative.DocumentDB.Outputs.GremlinGraphGetPropertiesResponseOptions
    Resource Pulumi.AzureNative.DocumentDB.Outputs.GremlinGraphGetPropertiesResponseResource
    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".
    Id string
    The unique resource identifier of the ARM resource.
    Name string
    The name of the ARM resource.
    Type string
    The type of Azure resource.
    Location string
    The location of the resource group to which the resource belongs.
    Options GremlinGraphGetPropertiesResponseOptions
    Resource GremlinGraphGetPropertiesResponseResource
    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".
    id String
    The unique resource identifier of the ARM resource.
    name String
    The name of the ARM resource.
    type String
    The type of Azure resource.
    location String
    The location of the resource group to which the resource belongs.
    options GremlinGraphGetPropertiesResponseOptions
    resource GremlinGraphGetPropertiesResponseResource
    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".
    id string
    The unique resource identifier of the ARM resource.
    name string
    The name of the ARM resource.
    type string
    The type of Azure resource.
    location string
    The location of the resource group to which the resource belongs.
    options GremlinGraphGetPropertiesResponseOptions
    resource GremlinGraphGetPropertiesResponseResource
    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".
    id str
    The unique resource identifier of the ARM resource.
    name str
    The name of the ARM resource.
    type str
    The type of Azure resource.
    location str
    The location of the resource group to which the resource belongs.
    options GremlinGraphGetPropertiesResponseOptions
    resource GremlinGraphGetPropertiesResponseResource
    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".
    id String
    The unique resource identifier of the ARM resource.
    name String
    The name of the ARM resource.
    type String
    The type of Azure resource.
    location String
    The location of the resource group to which the resource belongs.
    options Property Map
    resource Property Map
    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".

    Supporting Types

    AutoscaleSettingsResponse

    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.

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

    GremlinGraphGetPropertiesResponseOptions

    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.

    GremlinGraphGetPropertiesResponseResource

    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB Gremlin graph
    Rid string
    A system generated property. A unique identifier.
    Ts double
    A system generated property that denotes the last updated timestamp of the resource.
    AnalyticalStorageTtl double
    Analytical TTL.
    ConflictResolutionPolicy Pulumi.AzureNative.DocumentDB.Inputs.ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    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 graph
    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 Gremlin graph
    Rid string
    A system generated property. A unique identifier.
    Ts float64
    A system generated property that denotes the last updated timestamp of the resource.
    AnalyticalStorageTtl float64
    Analytical TTL.
    ConflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    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 graph
    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 Gremlin graph
    rid String
    A system generated property. A unique identifier.
    ts Double
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl Double
    Analytical TTL.
    conflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    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 graph
    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 Gremlin graph
    rid string
    A system generated property. A unique identifier.
    ts number
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl number
    Analytical TTL.
    conflictResolutionPolicy ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    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 graph
    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 Gremlin graph
    rid str
    A system generated property. A unique identifier.
    ts float
    A system generated property that denotes the last updated timestamp of the resource.
    analytical_storage_ttl float
    Analytical TTL.
    conflict_resolution_policy ConflictResolutionPolicyResponse
    The conflict resolution policy for the graph.
    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 graph
    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 Gremlin graph
    rid String
    A system generated property. A unique identifier.
    ts Number
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl Number
    Analytical TTL.
    conflictResolutionPolicy Property Map
    The conflict resolution policy for the graph.
    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 graph
    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.

    IncludedPathResponse

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

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

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

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

    Package Details

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