1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getManagedDatabase
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.sql.getManagedDatabase

Explore with Pulumi AI

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets a managed database.

Uses Azure REST API version 2023-08-01.

Other available API versions: 2017-03-01-preview, 2018-06-01-preview, 2019-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

Using getManagedDatabase

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 getManagedDatabase(args: GetManagedDatabaseArgs, opts?: InvokeOptions): Promise<GetManagedDatabaseResult>
function getManagedDatabaseOutput(args: GetManagedDatabaseOutputArgs, opts?: InvokeOptions): Output<GetManagedDatabaseResult>
Copy
def get_managed_database(database_name: Optional[str] = None,
                         managed_instance_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetManagedDatabaseResult
def get_managed_database_output(database_name: Optional[pulumi.Input[str]] = None,
                         managed_instance_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetManagedDatabaseResult]
Copy
func LookupManagedDatabase(ctx *Context, args *LookupManagedDatabaseArgs, opts ...InvokeOption) (*LookupManagedDatabaseResult, error)
func LookupManagedDatabaseOutput(ctx *Context, args *LookupManagedDatabaseOutputArgs, opts ...InvokeOption) LookupManagedDatabaseResultOutput
Copy

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

public static class GetManagedDatabase 
{
    public static Task<GetManagedDatabaseResult> InvokeAsync(GetManagedDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetManagedDatabaseResult> Invoke(GetManagedDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagedDatabaseResult> getManagedDatabase(GetManagedDatabaseArgs args, InvokeOptions options)
public static Output<GetManagedDatabaseResult> getManagedDatabase(GetManagedDatabaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getManagedDatabase
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database.
managed_instance_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the managed instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

getManagedDatabase Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CreationDate string
Creation date of the database.
DefaultSecondaryLocation string
Geo paired region.
EarliestRestorePoint string
Earliest restore point in time for point in time restore.
FailoverGroupId string
Instance Failover Group resource identifier that this managed database belongs to.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
Status string
Status of the database.
Type string
Resource type.
CatalogCollation string
Collation of the metadata catalog.
Collation string
Collation of the managed database.
IsLedgerOn bool
Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
CreationDate string
Creation date of the database.
DefaultSecondaryLocation string
Geo paired region.
EarliestRestorePoint string
Earliest restore point in time for point in time restore.
FailoverGroupId string
Instance Failover Group resource identifier that this managed database belongs to.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
Status string
Status of the database.
Type string
Resource type.
CatalogCollation string
Collation of the metadata catalog.
Collation string
Collation of the managed database.
IsLedgerOn bool
Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
creationDate String
Creation date of the database.
defaultSecondaryLocation String
Geo paired region.
earliestRestorePoint String
Earliest restore point in time for point in time restore.
failoverGroupId String
Instance Failover Group resource identifier that this managed database belongs to.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
status String
Status of the database.
type String
Resource type.
catalogCollation String
Collation of the metadata catalog.
collation String
Collation of the managed database.
isLedgerOn Boolean
Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
creationDate string
Creation date of the database.
defaultSecondaryLocation string
Geo paired region.
earliestRestorePoint string
Earliest restore point in time for point in time restore.
failoverGroupId string
Instance Failover Group resource identifier that this managed database belongs to.
id string
Resource ID.
location string
Resource location.
name string
Resource name.
status string
Status of the database.
type string
Resource type.
catalogCollation string
Collation of the metadata catalog.
collation string
Collation of the managed database.
isLedgerOn boolean
Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
creation_date str
Creation date of the database.
default_secondary_location str
Geo paired region.
earliest_restore_point str
Earliest restore point in time for point in time restore.
failover_group_id str
Instance Failover Group resource identifier that this managed database belongs to.
id str
Resource ID.
location str
Resource location.
name str
Resource name.
status str
Status of the database.
type str
Resource type.
catalog_collation str
Collation of the metadata catalog.
collation str
Collation of the managed database.
is_ledger_on bool
Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
creationDate String
Creation date of the database.
defaultSecondaryLocation String
Geo paired region.
earliestRestorePoint String
Earliest restore point in time for point in time restore.
failoverGroupId String
Instance Failover Group resource identifier that this managed database belongs to.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
status String
Status of the database.
type String
Resource type.
catalogCollation String
Collation of the metadata catalog.
collation String
Collation of the managed database.
isLedgerOn Boolean
Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
tags Map<String>
Resource tags.

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 v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi