published on Wednesday, Mar 4, 2026 by Pulumi
published on Wednesday, Mar 4, 2026 by Pulumi
Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.
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 getDatabaseAccountSqlDatabase
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 getDatabaseAccountSqlDatabase(args: GetDatabaseAccountSqlDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseAccountSqlDatabaseResult>
function getDatabaseAccountSqlDatabaseOutput(args: GetDatabaseAccountSqlDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseAccountSqlDatabaseResult>def get_database_account_sql_database(account_name: Optional[str] = None,
database_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDatabaseAccountSqlDatabaseResult
def get_database_account_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[GetDatabaseAccountSqlDatabaseResult]func LookupDatabaseAccountSqlDatabase(ctx *Context, args *LookupDatabaseAccountSqlDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseAccountSqlDatabaseResult, error)
func LookupDatabaseAccountSqlDatabaseOutput(ctx *Context, args *LookupDatabaseAccountSqlDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseAccountSqlDatabaseResultOutput> Note: This function is named LookupDatabaseAccountSqlDatabase in the Go SDK.
public static class GetDatabaseAccountSqlDatabase
{
public static Task<GetDatabaseAccountSqlDatabaseResult> InvokeAsync(GetDatabaseAccountSqlDatabaseArgs args, InvokeOptions? opts = null)
public static Output<GetDatabaseAccountSqlDatabaseResult> Invoke(GetDatabaseAccountSqlDatabaseInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDatabaseAccountSqlDatabaseResult> getDatabaseAccountSqlDatabase(GetDatabaseAccountSqlDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseAccountSqlDatabaseResult> getDatabaseAccountSqlDatabase(GetDatabaseAccountSqlDatabaseArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cosmosdb:getDatabaseAccountSqlDatabase
arguments:
# arguments dictionaryThe following arguments are supported:
- Account
Name string - Cosmos DB database account 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.
- Database
Name string - Cosmos DB database name.
- Resource
Group stringName - Name of an Azure resource group.
- account
Name String - Cosmos DB database account 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.
- database
Name string - Cosmos DB database name.
- resource
Group stringName - Name of an Azure resource group.
- account_
name str - Cosmos DB database account 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.
- database
Name String - Cosmos DB database name.
- resource
Group StringName - Name of an Azure resource group.
getDatabaseAccountSqlDatabase 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.
- Colls string
- A system generated property that specified the addressable path of the collections resource.
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Location string
- The location of the resource group to which the resource belongs.
- 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.
- Users string
- A system generated property that specifies the addressable path of the users resource.
- 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.
- Colls string
- A system generated property that specified the addressable path of the collections resource.
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Location string
- The location of the resource group to which the resource belongs.
- 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.
- Users string
- A system generated property that specifies the addressable path of the users resource.
- 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.
- colls String
- A system generated property that specified the addressable path of the collections resource.
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- location String
- The location of the resource group to which the resource belongs.
- 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.
- users String
- A system generated property that specifies the addressable path of the users resource.
- 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.
- colls string
- A system generated property that specified the addressable path of the collections resource.
- etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- location string
- The location of the resource group to which the resource belongs.
- 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.
- users string
- A system generated property that specifies the addressable path of the users resource.
- 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.
- colls str
- A system generated property that specified the addressable path of the collections resource.
- etag str
- A system generated property representing the resource etag required for optimistic concurrency control.
- location str
- The location of the resource group to which the resource belongs.
- 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.
- users str
- A system generated property that specifies the addressable path of the users resource.
- 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.
- colls String
- A system generated property that specified the addressable path of the collections resource.
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- location String
- The location of the resource group to which the resource belongs.
- 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.
- 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
published on Wednesday, Mar 4, 2026 by Pulumi
