azure-native.cosmosdb.getDatabaseAccountSqlContainer
Explore with Pulumi AI
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 dictionaryThe following arguments are supported:
- Account
Name string - Cosmos DB database account name.
 - Container
Name string - Cosmos DB container name.
 - Database
Name string - Cosmos DB database name.
 - Resource
Group stringName  - Name of an Azure resource group.
 
- Account
Name string - Cosmos DB database account name.
 - Container
Name string - Cosmos DB container name.
 - Database
Name string - Cosmos DB database name.
 - Resource
Group stringName  - Name of an Azure resource group.
 
- account
Name String - Cosmos DB database account name.
 - container
Name String - Cosmos DB container name.
 - database
Name String - Cosmos DB database name.
 - resource
Group StringName  - Name of an Azure resource group.
 
- account
Name string - Cosmos DB database account name.
 - container
Name string - Cosmos DB container name.
 - database
Name string - Cosmos DB database name.
 - resource
Group stringName  - 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_ strname  - Name of an Azure resource group.
 
- account
Name String - Cosmos DB database account name.
 - container
Name String - Cosmos DB container name.
 - database
Name String - Cosmos DB database name.
 - resource
Group StringName  - Name of an Azure resource group.
 
getDatabaseAccountSqlContainer Result
The following output properties are available:
- Azure
Api stringVersion  - 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.
 - Conflict
Resolution Pulumi.Policy Azure Native. Cosmos DB. Outputs. Conflict Resolution Policy Response  - The conflict resolution policy for the container.
 - Default
Ttl int - Default time to live
 - Etag string
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - Indexing
Policy Pulumi.Azure Native. Cosmos DB. Outputs. Indexing Policy Response  - 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.
 - Partition
Key Pulumi.Azure Native. Cosmos DB. Outputs. Container Partition Key Response  - The configuration of the partition key to be used for partitioning data into multiple partitions
 - Rid string
 - A system generated property. A unique identifier.
 - 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.
 - Unique
Key Pulumi.Policy Azure Native. Cosmos DB. Outputs. Unique Key Policy Response  - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
 
- Azure
Api stringVersion  - 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.
 - Conflict
Resolution ConflictPolicy Resolution Policy Response  - The conflict resolution policy for the container.
 - Default
Ttl int - Default time to live
 - Etag string
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - Indexing
Policy IndexingPolicy Response  - 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.
 - Partition
Key ContainerPartition Key Response  - The configuration of the partition key to be used for partitioning data into multiple partitions
 - Rid string
 - A system generated property. A unique identifier.
 - 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.
 - Unique
Key UniquePolicy Key Policy Response  - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
 
- azure
Api StringVersion  - 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.
 - conflict
Resolution ConflictPolicy Resolution Policy Response  - The conflict resolution policy for the container.
 - default
Ttl Integer - Default time to live
 - etag String
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - indexing
Policy IndexingPolicy Response  - 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.
 - partition
Key ContainerPartition Key Response  - The configuration of the partition key to be used for partitioning data into multiple partitions
 - rid String
 - A system generated property. A unique identifier.
 - 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.
 - unique
Key UniquePolicy Key Policy Response  - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
 
- azure
Api stringVersion  - 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.
 - conflict
Resolution ConflictPolicy Resolution Policy Response  - The conflict resolution policy for the container.
 - default
Ttl number - Default time to live
 - etag string
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - indexing
Policy IndexingPolicy Response  - 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.
 - partition
Key ContainerPartition Key Response  - The configuration of the partition key to be used for partitioning data into multiple partitions
 - rid string
 - A system generated property. A unique identifier.
 - {[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.
 - unique
Key UniquePolicy Key Policy Response  - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
 
- azure_
api_ strversion  - 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_ Conflictpolicy Resolution Policy Response  - 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 IndexingPolicy Response  - 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 ContainerPartition Key Response  - The configuration of the partition key to be used for partitioning data into multiple partitions
 - rid str
 - A system generated property. A unique identifier.
 - 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_ Uniquepolicy Key Policy Response  - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
 
- azure
Api StringVersion  - 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.
 - conflict
Resolution Property MapPolicy  - The conflict resolution policy for the container.
 - default
Ttl Number - Default time to live
 - etag String
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - indexing
Policy 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.
 - partition
Key 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.
 - 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.
 - unique
Key Property MapPolicy  - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
 
Supporting Types
CompositePathResponse  
ConflictResolutionPolicyResponse   
- Conflict
Resolution stringPath  - The conflict resolution path in the case of LastWriterWins mode.
 - Conflict
Resolution stringProcedure  - The procedure to resolve conflicts in the case of custom mode.
 - Mode string
 - Indicates the conflict resolution mode.
 
- Conflict
Resolution stringPath  - The conflict resolution path in the case of LastWriterWins mode.
 - Conflict
Resolution stringProcedure  - The procedure to resolve conflicts in the case of custom mode.
 - Mode string
 - Indicates the conflict resolution mode.
 
- conflict
Resolution StringPath  - The conflict resolution path in the case of LastWriterWins mode.
 - conflict
Resolution StringProcedure  - The procedure to resolve conflicts in the case of custom mode.
 - mode String
 - Indicates the conflict resolution mode.
 
- conflict
Resolution stringPath  - The conflict resolution path in the case of LastWriterWins mode.
 - conflict
Resolution stringProcedure  - The procedure to resolve conflicts in the case of custom mode.
 - mode string
 - Indicates the conflict resolution mode.
 
- conflict_
resolution_ strpath  - The conflict resolution path in the case of LastWriterWins mode.
 - conflict_
resolution_ strprocedure  - The procedure to resolve conflicts in the case of custom mode.
 - mode str
 - Indicates the conflict resolution mode.
 
- conflict
Resolution StringPath  - The conflict resolution path in the case of LastWriterWins mode.
 - conflict
Resolution StringProcedure  - The procedure to resolve conflicts in the case of custom mode.
 - mode String
 - Indicates the conflict resolution mode.
 
ContainerPartitionKeyResponse   
- System
Key bool - Indicates if the container is using a system generated partition key
 - Kind string
 - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
 - Paths List<string>
 - List of paths using which data within the container can be partitioned
 - Version int
 - Indicates the version of the partition key definition
 
- System
Key bool - Indicates if the container is using a system generated partition key
 - Kind string
 - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
 - Paths []string
 - List of paths using which data within the container can be partitioned
 - Version int
 - Indicates the version of the partition key definition
 
- system
Key Boolean - Indicates if the container is using a system generated partition key
 - kind String
 - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
 - paths List<String>
 - List of paths using which data within the container can be partitioned
 - version Integer
 - Indicates the version of the partition key definition
 
- system
Key boolean - Indicates if the container is using a system generated partition key
 - kind string
 - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
 - paths string[]
 - List of paths using which data within the container can be partitioned
 - version number
 - Indicates the version of the partition key definition
 
- system_
key bool - Indicates if the container is using a system generated partition key
 - kind str
 - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
 - paths Sequence[str]
 - List of paths using which data within the container can be partitioned
 - version int
 - Indicates the version of the partition key definition
 
- system
Key Boolean - Indicates if the container is using a system generated partition key
 - kind String
 - Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
 - paths List<String>
 - List of paths using which data within the container can be partitioned
 - version Number
 - Indicates the version of the partition key definition
 
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/*)
 
IncludedPathResponse  
- Indexes
List<Pulumi.
Azure Native. Cosmos DB. Inputs. Indexes Response>  - List of indexes for this path
 - Path string
 - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
 
- Indexes
[]Indexes
Response  - List of indexes for this path
 - Path string
 - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
 
- indexes
List<Indexes
Response>  - List of indexes for this path
 - path String
 - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
 
- indexes
Indexes
Response[]  - List of indexes for this path
 - path string
 - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
 
- indexes
Sequence[Indexes
Response]  - List of indexes for this path
 - path str
 - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
 
- indexes List<Property Map>
 - List of indexes for this path
 - path String
 - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
 
IndexesResponse 
IndexingPolicyResponse  
- Automatic bool
 - Indicates if the indexing policy is automatic
 - Composite
Indexes List<ImmutableArray<Pulumi. Azure Native. Cosmos DB. Inputs. Composite Path Response>>  - List of composite path list
 - Excluded
Paths List<Pulumi.Azure Native. Cosmos DB. Inputs. Excluded Path Response>  - List of paths to exclude from indexing
 - Included
Paths List<Pulumi.Azure Native. Cosmos DB. Inputs. Included Path Response>  - List of paths to include in the indexing
 - Indexing
Mode string - Indicates the indexing mode.
 - Spatial
Indexes List<Pulumi.Azure Native. Cosmos DB. Inputs. Spatial Spec Response>  - List of spatial specifics
 - Vector
Indexes List<Pulumi.Azure Native. Cosmos DB. Inputs. Vector Index Response>  - List of paths to include in the vector indexing
 
- Automatic bool
 - Indicates if the indexing policy is automatic
 - Composite
Indexes [][]CompositePath Response  - List of composite path list
 - Excluded
Paths []ExcludedPath Response  - List of paths to exclude from indexing
 - Included
Paths []IncludedPath Response  - List of paths to include in the indexing
 - Indexing
Mode string - Indicates the indexing mode.
 - Spatial
Indexes []SpatialSpec Response  - List of spatial specifics
 - Vector
Indexes []VectorIndex Response  - List of paths to include in the vector indexing
 
- automatic Boolean
 - Indicates if the indexing policy is automatic
 - composite
Indexes List<List<CompositePath Response>>  - List of composite path list
 - excluded
Paths List<ExcludedPath Response>  - List of paths to exclude from indexing
 - included
Paths List<IncludedPath Response>  - List of paths to include in the indexing
 - indexing
Mode String - Indicates the indexing mode.
 - spatial
Indexes List<SpatialSpec Response>  - List of spatial specifics
 - vector
Indexes List<VectorIndex Response>  - List of paths to include in the vector indexing
 
- automatic boolean
 - Indicates if the indexing policy is automatic
 - composite
Indexes CompositePath Response[][]  - List of composite path list
 - excluded
Paths ExcludedPath Response[]  - List of paths to exclude from indexing
 - included
Paths IncludedPath Response[]  - List of paths to include in the indexing
 - indexing
Mode string - Indicates the indexing mode.
 - spatial
Indexes SpatialSpec Response[]  - List of spatial specifics
 - vector
Indexes VectorIndex Response[]  - List of paths to include in the vector indexing
 
- automatic bool
 - Indicates if the indexing policy is automatic
 - composite_
indexes Sequence[Sequence[CompositePath Response]]  - List of composite path list
 - excluded_
paths Sequence[ExcludedPath Response]  - List of paths to exclude from indexing
 - included_
paths Sequence[IncludedPath Response]  - List of paths to include in the indexing
 - indexing_
mode str - Indicates the indexing mode.
 - spatial_
indexes Sequence[SpatialSpec Response]  - List of spatial specifics
 - vector_
indexes Sequence[VectorIndex Response]  - List of paths to include in the vector indexing
 
- automatic Boolean
 - Indicates if the indexing policy is automatic
 - composite
Indexes List<List<Property Map>> - List of composite path list
 - excluded
Paths List<Property Map> - List of paths to exclude from indexing
 - included
Paths List<Property Map> - List of paths to include in the indexing
 - indexing
Mode String - Indicates the indexing mode.
 - spatial
Indexes List<Property Map> - List of spatial specifics
 - vector
Indexes List<Property Map> - List of paths to include in the vector indexing
 
SpatialSpecResponse  
UniqueKeyPolicyResponse   
- Unique
Keys List<Pulumi.Azure Native. Cosmos DB. Inputs. Unique Key Response>  - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
 
- Unique
Keys []UniqueKey Response  - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
 
- unique
Keys List<UniqueKey Response>  - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
 
- unique
Keys UniqueKey Response[]  - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
 
- unique_
keys Sequence[UniqueKey Response]  - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
 
- unique
Keys List<Property Map> - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
 
UniqueKeyResponse  
- 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  
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0