Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. databasefleetmanager
  5. getFleetDatabase
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.databasefleetmanager.getFleetDatabase

Explore with Pulumi AI

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

    Gets a fleet database.

    Uses Azure REST API version 2025-02-01-preview.

    Using getFleetDatabase

    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 getFleetDatabase(args: GetFleetDatabaseArgs, opts?: InvokeOptions): Promise<GetFleetDatabaseResult>
function getFleetDatabaseOutput(args: GetFleetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetFleetDatabaseResult>
    def get_fleet_database(database_name: Optional[str] = None,
                       fleet_name: Optional[str] = None,
                       fleetspace_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetFleetDatabaseResult
def get_fleet_database_output(database_name: Optional[pulumi.Input[str]] = None,
                       fleet_name: Optional[pulumi.Input[str]] = None,
                       fleetspace_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetFleetDatabaseResult]
    func LookupFleetDatabase(ctx *Context, args *LookupFleetDatabaseArgs, opts ...InvokeOption) (*LookupFleetDatabaseResult, error)
func LookupFleetDatabaseOutput(ctx *Context, args *LookupFleetDatabaseOutputArgs, opts ...InvokeOption) LookupFleetDatabaseResultOutput

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

    public static class GetFleetDatabase 
{
    public static Task<GetFleetDatabaseResult> InvokeAsync(GetFleetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetFleetDatabaseResult> Invoke(GetFleetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFleetDatabaseResult> getFleetDatabase(GetFleetDatabaseArgs args, InvokeOptions options)
public static Output<GetFleetDatabaseResult> getFleetDatabase(GetFleetDatabaseArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:databasefleetmanager:getFleetDatabase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    Name of the database.
    FleetName string
    Name of the database fleet.
    FleetspaceName string
    Name of the fleetspace.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DatabaseName string
    Name of the database.
    FleetName string
    Name of the database fleet.
    FleetspaceName string
    Name of the fleetspace.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    databaseName String
    Name of the database.
    fleetName String
    Name of the database fleet.
    fleetspaceName String
    Name of the fleetspace.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    databaseName string
    Name of the database.
    fleetName string
    Name of the database fleet.
    fleetspaceName string
    Name of the fleetspace.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    database_name str
    Name of the database.
    fleet_name str
    Name of the database fleet.
    fleetspace_name str
    Name of the fleetspace.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    databaseName String
    Name of the database.
    fleetName String
    Name of the database fleet.
    fleetspaceName String
    Name of the fleetspace.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getFleetDatabase Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.DatabaseFleetManager.Outputs.FleetDatabasePropertiesResponse
    Fleet database properties.
    SystemData Pulumi.AzureNative.DatabaseFleetManager.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties FleetDatabasePropertiesResponse
    Fleet database properties.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties FleetDatabasePropertiesResponse
    Fleet database properties.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties FleetDatabasePropertiesResponse
    Fleet database properties.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties FleetDatabasePropertiesResponse
    Fleet database properties.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    Fleet database properties.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    DatabaseIdentityResponse

    ClientId string
    Client Id of the database identity.
    PrincipalId string
    Principal Id of the database identity.
    ResourceId string
    Resource Id of the database identity.
    ClientId string
    Client Id of the database identity.
    PrincipalId string
    Principal Id of the database identity.
    ResourceId string
    Resource Id of the database identity.
    clientId String
    Client Id of the database identity.
    principalId String
    Principal Id of the database identity.
    resourceId String
    Resource Id of the database identity.
    clientId string
    Client Id of the database identity.
    principalId string
    Principal Id of the database identity.
    resourceId string
    Resource Id of the database identity.
    client_id str
    Client Id of the database identity.
    principal_id str
    Principal Id of the database identity.
    resource_id str
    Resource Id of the database identity.
    clientId String
    Client Id of the database identity.
    principalId String
    Principal Id of the database identity.
    resourceId String
    Resource Id of the database identity.

    FleetDatabasePropertiesResponse

    BackupRetentionDays int
    Backup retention in days.
    ConnectionString string
    Connection string to connect to the database with.
    DatabaseSizeGbMax int
    Maximum database size in Gb.
    EarliestRestoreTime string
    Earliest restore time.
    LatestRestoreTime string
    Latest restore time.
    OriginalDatabaseId string
    Resource identifier for the underlying database resource.
    ProvisioningState string
    Database state.
    Recoverable bool
    If true, database is recoverable.
    Collation string
    Database collation.
    CreateMode string
    Create mode. Available options: Default - Create a database. Copy - Copy the source database (source database name must be specified) PointInTimeRestore - Create a database by restoring source database from a point in time (source database name and restore from time must be specified)
    Identity Pulumi.AzureNative.DatabaseFleetManager.Inputs.IdentityResponse
    Identity property.
    ResourceTags Dictionary<string, string>
    Additional database properties to be applied as the underlying database resource tags.
    RestoreFromTime string
    Restore from time when CreateMode is PointInTimeRestore.
    SourceDatabaseName string
    Source database name used when CreateMode is Copy or PointInTimeRestore.
    TierName string
    Name of the tier this database belongs to.
    TransparentDataEncryption Pulumi.AzureNative.DatabaseFleetManager.Inputs.TransparentDataEncryptionResponse
    Transparent Data Encryption properties
    BackupRetentionDays int
    Backup retention in days.
    ConnectionString string
    Connection string to connect to the database with.
    DatabaseSizeGbMax int
    Maximum database size in Gb.
    EarliestRestoreTime string
    Earliest restore time.
    LatestRestoreTime string
    Latest restore time.
    OriginalDatabaseId string
    Resource identifier for the underlying database resource.
    ProvisioningState string
    Database state.
    Recoverable bool
    If true, database is recoverable.
    Collation string
    Database collation.
    CreateMode string
    Create mode. Available options: Default - Create a database. Copy - Copy the source database (source database name must be specified) PointInTimeRestore - Create a database by restoring source database from a point in time (source database name and restore from time must be specified)
    Identity IdentityResponse
    Identity property.
    ResourceTags map[string]string
    Additional database properties to be applied as the underlying database resource tags.
    RestoreFromTime string
    Restore from time when CreateMode is PointInTimeRestore.
    SourceDatabaseName string
    Source database name used when CreateMode is Copy or PointInTimeRestore.
    TierName string
    Name of the tier this database belongs to.
    TransparentDataEncryption TransparentDataEncryptionResponse
    Transparent Data Encryption properties
    backupRetentionDays Integer
    Backup retention in days.
    connectionString String
    Connection string to connect to the database with.
    databaseSizeGbMax Integer
    Maximum database size in Gb.
    earliestRestoreTime String
    Earliest restore time.
    latestRestoreTime String
    Latest restore time.
    originalDatabaseId String
    Resource identifier for the underlying database resource.
    provisioningState String
    Database state.
    recoverable Boolean
    If true, database is recoverable.
    collation String
    Database collation.
    createMode String
    Create mode. Available options: Default - Create a database. Copy - Copy the source database (source database name must be specified) PointInTimeRestore - Create a database by restoring source database from a point in time (source database name and restore from time must be specified)
    identity IdentityResponse
    Identity property.
    resourceTags Map<String,String>
    Additional database properties to be applied as the underlying database resource tags.
    restoreFromTime String
    Restore from time when CreateMode is PointInTimeRestore.
    sourceDatabaseName String
    Source database name used when CreateMode is Copy or PointInTimeRestore.
    tierName String
    Name of the tier this database belongs to.
    transparentDataEncryption TransparentDataEncryptionResponse
    Transparent Data Encryption properties
    backupRetentionDays number
    Backup retention in days.
    connectionString string
    Connection string to connect to the database with.
    databaseSizeGbMax number
    Maximum database size in Gb.
    earliestRestoreTime string
    Earliest restore time.
    latestRestoreTime string
    Latest restore time.
    originalDatabaseId string
    Resource identifier for the underlying database resource.
    provisioningState string
    Database state.
    recoverable boolean
    If true, database is recoverable.
    collation string
    Database collation.
    createMode string
    Create mode. Available options: Default - Create a database. Copy - Copy the source database (source database name must be specified) PointInTimeRestore - Create a database by restoring source database from a point in time (source database name and restore from time must be specified)
    identity IdentityResponse
    Identity property.
    resourceTags {[key: string]: string}
    Additional database properties to be applied as the underlying database resource tags.
    restoreFromTime string
    Restore from time when CreateMode is PointInTimeRestore.
    sourceDatabaseName string
    Source database name used when CreateMode is Copy or PointInTimeRestore.
    tierName string
    Name of the tier this database belongs to.
    transparentDataEncryption TransparentDataEncryptionResponse
    Transparent Data Encryption properties
    backup_retention_days int
    Backup retention in days.
    connection_string str
    Connection string to connect to the database with.
    database_size_gb_max int
    Maximum database size in Gb.
    earliest_restore_time str
    Earliest restore time.
    latest_restore_time str
    Latest restore time.
    original_database_id str
    Resource identifier for the underlying database resource.
    provisioning_state str
    Database state.
    recoverable bool
    If true, database is recoverable.
    collation str
    Database collation.
    create_mode str
    Create mode. Available options: Default - Create a database. Copy - Copy the source database (source database name must be specified) PointInTimeRestore - Create a database by restoring source database from a point in time (source database name and restore from time must be specified)
    identity IdentityResponse
    Identity property.
    resource_tags Mapping[str, str]
    Additional database properties to be applied as the underlying database resource tags.
    restore_from_time str
    Restore from time when CreateMode is PointInTimeRestore.
    source_database_name str
    Source database name used when CreateMode is Copy or PointInTimeRestore.
    tier_name str
    Name of the tier this database belongs to.
    transparent_data_encryption TransparentDataEncryptionResponse
    Transparent Data Encryption properties
    backupRetentionDays Number
    Backup retention in days.
    connectionString String
    Connection string to connect to the database with.
    databaseSizeGbMax Number
    Maximum database size in Gb.
    earliestRestoreTime String
    Earliest restore time.
    latestRestoreTime String
    Latest restore time.
    originalDatabaseId String
    Resource identifier for the underlying database resource.
    provisioningState String
    Database state.
    recoverable Boolean
    If true, database is recoverable.
    collation String
    Database collation.
    createMode String
    Create mode. Available options: Default - Create a database. Copy - Copy the source database (source database name must be specified) PointInTimeRestore - Create a database by restoring source database from a point in time (source database name and restore from time must be specified)
    identity Property Map
    Identity property.
    resourceTags Map<String>
    Additional database properties to be applied as the underlying database resource tags.
    restoreFromTime String
    Restore from time when CreateMode is PointInTimeRestore.
    sourceDatabaseName String
    Source database name used when CreateMode is Copy or PointInTimeRestore.
    tierName String
    Name of the tier this database belongs to.
    transparentDataEncryption Property Map
    Transparent Data Encryption properties

    IdentityResponse

    FederatedClientId string
    The federated client id for the SQL Database. It is used for cross tenant CMK scenario.
    IdentityType string
    Identity type of the main principal.
    UserAssignedIdentities List<Pulumi.AzureNative.DatabaseFleetManager.Inputs.DatabaseIdentityResponse>
    User identity ids
    FederatedClientId string
    The federated client id for the SQL Database. It is used for cross tenant CMK scenario.
    IdentityType string
    Identity type of the main principal.
    UserAssignedIdentities []DatabaseIdentityResponse
    User identity ids
    federatedClientId String
    The federated client id for the SQL Database. It is used for cross tenant CMK scenario.
    identityType String
    Identity type of the main principal.
    userAssignedIdentities List<DatabaseIdentityResponse>
    User identity ids
    federatedClientId string
    The federated client id for the SQL Database. It is used for cross tenant CMK scenario.
    identityType string
    Identity type of the main principal.
    userAssignedIdentities DatabaseIdentityResponse[]
    User identity ids
    federated_client_id str
    The federated client id for the SQL Database. It is used for cross tenant CMK scenario.
    identity_type str
    Identity type of the main principal.
    user_assigned_identities Sequence[DatabaseIdentityResponse]
    User identity ids
    federatedClientId String
    The federated client id for the SQL Database. It is used for cross tenant CMK scenario.
    identityType String
    Identity type of the main principal.
    userAssignedIdentities List<Property Map>
    User identity ids

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    TransparentDataEncryptionResponse

    EnableAutoRotation bool
    Enable key auto rotation
    KeyUri string
    Customer Managed Key (CMK) Uri.
    Keys List<string>
    Additional Keys
    EnableAutoRotation bool
    Enable key auto rotation
    KeyUri string
    Customer Managed Key (CMK) Uri.
    Keys []string
    Additional Keys
    enableAutoRotation Boolean
    Enable key auto rotation
    keyUri String
    Customer Managed Key (CMK) Uri.
    keys List<String>
    Additional Keys
    enableAutoRotation boolean
    Enable key auto rotation
    keyUri string
    Customer Managed Key (CMK) Uri.
    keys string[]
    Additional Keys
    enable_auto_rotation bool
    Enable key auto rotation
    key_uri str
    Customer Managed Key (CMK) Uri.
    keys Sequence[str]
    Additional Keys
    enableAutoRotation Boolean
    Enable key auto rotation
    keyUri String
    Customer Managed Key (CMK) Uri.
    keys List<String>
    Additional Keys

    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 v2 docs if using the v2 version of this package.
    Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-azure-native