1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getSqlResourceSqlDatabase
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native.documentdb.getSqlResourceSqlDatabase

Explore with Pulumi AI

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.

Uses Azure REST API version 2023-04-15.

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

Using getSqlResourceSqlDatabase

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 getSqlResourceSqlDatabase(args: GetSqlResourceSqlDatabaseArgs, opts?: InvokeOptions): Promise<GetSqlResourceSqlDatabaseResult>
function getSqlResourceSqlDatabaseOutput(args: GetSqlResourceSqlDatabaseOutputArgs, opts?: InvokeOptions): Output<GetSqlResourceSqlDatabaseResult>
Copy
def get_sql_resource_sql_database(account_name: Optional[str] = None,
                                  database_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetSqlResourceSqlDatabaseResult
def get_sql_resource_sql_database_output(account_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[GetSqlResourceSqlDatabaseResult]
Copy
func LookupSqlResourceSqlDatabase(ctx *Context, args *LookupSqlResourceSqlDatabaseArgs, opts ...InvokeOption) (*LookupSqlResourceSqlDatabaseResult, error)
func LookupSqlResourceSqlDatabaseOutput(ctx *Context, args *LookupSqlResourceSqlDatabaseOutputArgs, opts ...InvokeOption) LookupSqlResourceSqlDatabaseResultOutput
Copy

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

public static class GetSqlResourceSqlDatabase 
{
    public static Task<GetSqlResourceSqlDatabaseResult> InvokeAsync(GetSqlResourceSqlDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlResourceSqlDatabaseResult> Invoke(GetSqlResourceSqlDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSqlResourceSqlDatabaseResult> getSqlResourceSqlDatabase(GetSqlResourceSqlDatabaseArgs args, InvokeOptions options)
public static Output<GetSqlResourceSqlDatabaseResult> getSqlResourceSqlDatabase(GetSqlResourceSqlDatabaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:documentdb:getSqlResourceSqlDatabase
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
database_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getSqlResourceSqlDatabase 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.SqlDatabaseGetPropertiesResponseOptions
Resource Pulumi.AzureNative.DocumentDB.Outputs.SqlDatabaseGetPropertiesResponseResource
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 SqlDatabaseGetPropertiesResponseOptions
Resource SqlDatabaseGetPropertiesResponseResource
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 SqlDatabaseGetPropertiesResponseOptions
resource SqlDatabaseGetPropertiesResponseResource
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 SqlDatabaseGetPropertiesResponseOptions
resource SqlDatabaseGetPropertiesResponseResource
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 SqlDatabaseGetPropertiesResponseOptions
resource SqlDatabaseGetPropertiesResponseResource
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.

SqlDatabaseGetPropertiesResponseOptions

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.

SqlDatabaseGetPropertiesResponseResource

Etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
Id This property is required. string
Name of the Cosmos DB SQL database
Rid This property is required. string
A system generated property. A unique identifier.
Ts This property is required. double
A system generated property that denotes the last updated timestamp of the resource.
Colls string
A system generated property that specified the addressable path of the collections resource.
Users string
A system generated property that specifies the addressable path of the users resource.
Etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
Id This property is required. string
Name of the Cosmos DB SQL database
Rid This property is required. string
A system generated property. A unique identifier.
Ts This property is required. float64
A system generated property that denotes the last updated timestamp of the resource.
Colls string
A system generated property that specified the addressable path of the collections resource.
Users string
A system generated property that specifies the addressable path of the users resource.
etag This property is required. String
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. String
Name of the Cosmos DB SQL database
rid This property is required. String
A system generated property. A unique identifier.
ts This property is required. Double
A system generated property that denotes the last updated timestamp of the resource.
colls String
A system generated property that specified the addressable path of the collections resource.
users String
A system generated property that specifies the addressable path of the users resource.
etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. string
Name of the Cosmos DB SQL database
rid This property is required. string
A system generated property. A unique identifier.
ts This property is required. number
A system generated property that denotes the last updated timestamp of the resource.
colls string
A system generated property that specified the addressable path of the collections resource.
users string
A system generated property that specifies the addressable path of the users resource.
etag This property is required. str
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. str
Name of the Cosmos DB SQL database
rid This property is required. str
A system generated property. A unique identifier.
ts This property is required. float
A system generated property that denotes the last updated timestamp of the resource.
colls str
A system generated property that specified the addressable path of the collections resource.
users str
A system generated property that specifies the addressable path of the users resource.
etag This property is required. String
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. String
Name of the Cosmos DB SQL database
rid This property is required. String
A system generated property. A unique identifier.
ts This property is required. Number
A system generated property that denotes the last updated timestamp of the resource.
colls String
A system generated property that specified the addressable path of the collections resource.
users String
A system generated property that specifies the addressable path of the users resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi