Test‑SqlDscDatabaseProperty - dsccommunity/SqlServerDsc GitHub Wiki

SYNOPSIS

Tests if database properties on a SQL Server Database Engine instance are in the desired state.

SYNTAX

ServerObjectSet (Default)

Test-SqlDscDatabaseProperty -ServerObject <Server> -Name <String> [-Refresh]
 [-AcceleratedRecoveryEnabled <Boolean>] [-ActiveDirectory <Boolean>] [-AnsiNullDefault <Boolean>]
 [-AnsiNullsEnabled <Boolean>] [-AnsiPaddingEnabled <Boolean>] [-AnsiWarningsEnabled <Boolean>]
 [-ArithmeticAbortEnabled <Boolean>] [-AutoClose <Boolean>] [-AutoCreateIncrementalStatisticsEnabled <Boolean>]
 [-AutoCreateStatisticsEnabled <Boolean>] [-AutoShrink <Boolean>] [-AutoUpdateStatisticsAsync <Boolean>]
 [-AutoUpdateStatisticsEnabled <Boolean>] [-BrokerEnabled <Boolean>] [-CaseSensitive <Boolean>]
 [-ChangeTrackingAutoCleanUp <Boolean>] [-ChangeTrackingEnabled <Boolean>]
 [-CloseCursorsOnCommitEnabled <Boolean>] [-ConcatenateNullYieldsNull <Boolean>]
 [-DatabaseOwnershipChaining <Boolean>] [-DataRetentionEnabled <Boolean>]
 [-DateCorrelationOptimization <Boolean>] [-DelayedDurability <Boolean>] [-EncryptionEnabled <Boolean>]
 [-HasDatabaseEncryptionKey <Boolean>] [-HasFileInCloud <Boolean>] [-HasMemoryOptimizedObjects <Boolean>]
 [-HonorBrokerPriority <Boolean>] [-IsAccessible <Boolean>] [-IsDatabaseSnapshot <Boolean>]
 [-IsDatabaseSnapshotBase <Boolean>] [-IsDbAccessAdmin <Boolean>] [-IsDbBackupOperator <Boolean>]
 [-IsDbDataReader <Boolean>] [-IsDbDataWriter <Boolean>] [-IsDbDdlAdmin <Boolean>]
 [-IsDbDenyDataReader <Boolean>] [-IsDbDenyDataWriter <Boolean>] [-IsDbManager <Boolean>]
 [-IsDbOwner <Boolean>] [-IsDbSecurityAdmin <Boolean>] [-IsFabricDatabase <Boolean>]
 [-IsFullTextEnabled <Boolean>] [-IsLedger <Boolean>] [-IsLoginManager <Boolean>] [-IsMailHost <Boolean>]
 [-IsManagementDataWarehouse <Boolean>] [-IsMaxSizeApplicable <Boolean>] [-IsMirroringEnabled <Boolean>]
 [-IsParameterizationForced <Boolean>] [-IsReadCommittedSnapshotOn <Boolean>] [-IsSqlDw <Boolean>]
 [-IsSqlDwEdition <Boolean>] [-IsSystemObject <Boolean>] [-IsVarDecimalStorageFormatEnabled <Boolean>]
 [-IsVarDecimalStorageFormatSupported <Boolean>] [-LegacyCardinalityEstimation <Boolean>]
 [-LegacyCardinalityEstimationForSecondary <Boolean>] [-LocalCursorsDefault <Boolean>]
 [-NestedTriggersEnabled <Boolean>] [-NumericRoundAbortEnabled <Boolean>] [-ParameterSniffing <Boolean>]
 [-ParameterSniffingForSecondary <Boolean>] [-QueryOptimizerHotfixes <Boolean>]
 [-QueryOptimizerHotfixesForSecondary <Boolean>] [-QuotedIdentifiersEnabled <Boolean>] [-ReadOnly <Boolean>]
 [-RecursiveTriggersEnabled <Boolean>] [-RemoteDataArchiveEnabled <Boolean>]
 [-RemoteDataArchiveUseFederatedServiceAccount <Boolean>] [-TemporalHistoryRetentionEnabled <Boolean>]
 [-TransformNoiseWords <Boolean>] [-Trustworthy <Boolean>] [-WarnOnRename <Boolean>]
 [-ActiveConnections <Int32>] [-ChangeTrackingRetentionPeriod <Int32>] [-DefaultFullTextLanguage <Int32>]
 [-DefaultLanguage <Int32>] [-ID <Int32>] [-MaxDop <Int32>] [-MaxDopForSecondary <Int32>]
 [-MirroringRedoQueueMaxSize <Int32>] [-MirroringRoleSequence <Int32>] [-MirroringSafetySequence <Int32>]
 [-MirroringTimeout <Int32>] [-TargetRecoveryTime <Int32>] [-TwoDigitYearCutoff <Int32>] [-Version <Int32>]
 [-IndexSpaceUsage <Int64>] [-MaxSizeInBytes <Int64>] [-MemoryAllocatedToMemoryOptimizedObjectsInKB <Int64>]
 [-MemoryUsedByMemoryOptimizedObjectsInKB <Int64>] [-MirroringFailoverLogSequenceNumber <Int64>]
 [-PersistentVersionStoreSizeKB <Int64>] [-SpaceAvailable <Int64>] [-Size <Double>]
 [-AvailabilityGroupName <String>] [-AzureServiceObjective <String>] [-CatalogCollation <String>]
 [-Collation <String>] [-DboLogin <String>] [-DefaultFileGroup <String>] [-DefaultFileStreamFileGroup <String>]
 [-DefaultFullTextCatalog <String>] [-DefaultSchema <String>] [-FilestreamDirectoryName <String>]
 [-MirroringPartner <String>] [-MirroringPartnerInstance <String>] [-MirroringWitness <String>]
 [-Owner <String>] [-PersistentVersionStoreFileGroup <String>] [-PrimaryFilePath <String>]
 [-RemoteDataArchiveCredential <String>] [-RemoteDataArchiveEndpoint <String>]
 [-RemoteDataArchiveLinkedServer <String>] [-RemoteDatabaseName <String>] [-UserName <String>]
 [-AzureEdition <String>] [-CreateDate <DateTime>] [-LastBackupDate <DateTime>]
 [-LastDifferentialBackupDate <DateTime>] [-LastGoodCheckDbTime <DateTime>] [-LastLogBackupDate <DateTime>]
 [-DatabaseGuid <Guid>] [-MirroringID <Guid>] [-RecoveryForkGuid <Guid>] [-ServiceBrokerGuid <Guid>]
 [-AvailabilityDatabaseSynchronizationState <AvailabilityDatabaseSynchronizationState>]
 [-ChangeTrackingRetentionPeriodUnits <RetentionPeriodUnits>] [-CompatibilityLevel <CompatibilityLevel>]
 [-ContainmentType <ContainmentType>] [-DatabaseEngineEdition <DatabaseEngineEdition>]
 [-DatabaseEngineType <DatabaseEngineType>]
 [-FilestreamNonTransactedAccess <FilestreamNonTransactedAccessType>]
 [-LogReuseWaitStatus <LogReuseWaitStatus>] [-MirroringSafetyLevel <MirroringSafetyLevel>]
 [-MirroringStatus <MirroringStatus>] [-MirroringWitnessStatus <MirroringWitnessStatus>]
 [-PageVerify <PageVerify>] [-RecoveryModel <RecoveryModel>] [-ReplicationOptions <ReplicationOptions>]
 [-SnapshotIsolationState <SnapshotIsolationState>] [-State <SqlSmoState>] [-Status <DatabaseStatus>]
 [-UserAccess <DatabaseUserAccess>] [<CommonParameters>]

DatabaseObjectSet

Test-SqlDscDatabaseProperty -DatabaseObject <Database> [-AcceleratedRecoveryEnabled <Boolean>]
 [-ActiveDirectory <Boolean>] [-AnsiNullDefault <Boolean>] [-AnsiNullsEnabled <Boolean>]
 [-AnsiPaddingEnabled <Boolean>] [-AnsiWarningsEnabled <Boolean>] [-ArithmeticAbortEnabled <Boolean>]
 [-AutoClose <Boolean>] [-AutoCreateIncrementalStatisticsEnabled <Boolean>]
 [-AutoCreateStatisticsEnabled <Boolean>] [-AutoShrink <Boolean>] [-AutoUpdateStatisticsAsync <Boolean>]
 [-AutoUpdateStatisticsEnabled <Boolean>] [-BrokerEnabled <Boolean>] [-CaseSensitive <Boolean>]
 [-ChangeTrackingAutoCleanUp <Boolean>] [-ChangeTrackingEnabled <Boolean>]
 [-CloseCursorsOnCommitEnabled <Boolean>] [-ConcatenateNullYieldsNull <Boolean>]
 [-DatabaseOwnershipChaining <Boolean>] [-DataRetentionEnabled <Boolean>]
 [-DateCorrelationOptimization <Boolean>] [-DelayedDurability <Boolean>] [-EncryptionEnabled <Boolean>]
 [-HasDatabaseEncryptionKey <Boolean>] [-HasFileInCloud <Boolean>] [-HasMemoryOptimizedObjects <Boolean>]
 [-HonorBrokerPriority <Boolean>] [-IsAccessible <Boolean>] [-IsDatabaseSnapshot <Boolean>]
 [-IsDatabaseSnapshotBase <Boolean>] [-IsDbAccessAdmin <Boolean>] [-IsDbBackupOperator <Boolean>]
 [-IsDbDataReader <Boolean>] [-IsDbDataWriter <Boolean>] [-IsDbDdlAdmin <Boolean>]
 [-IsDbDenyDataReader <Boolean>] [-IsDbDenyDataWriter <Boolean>] [-IsDbManager <Boolean>]
 [-IsDbOwner <Boolean>] [-IsDbSecurityAdmin <Boolean>] [-IsFabricDatabase <Boolean>]
 [-IsFullTextEnabled <Boolean>] [-IsLedger <Boolean>] [-IsLoginManager <Boolean>] [-IsMailHost <Boolean>]
 [-IsManagementDataWarehouse <Boolean>] [-IsMaxSizeApplicable <Boolean>] [-IsMirroringEnabled <Boolean>]
 [-IsParameterizationForced <Boolean>] [-IsReadCommittedSnapshotOn <Boolean>] [-IsSqlDw <Boolean>]
 [-IsSqlDwEdition <Boolean>] [-IsSystemObject <Boolean>] [-IsVarDecimalStorageFormatEnabled <Boolean>]
 [-IsVarDecimalStorageFormatSupported <Boolean>] [-LegacyCardinalityEstimation <Boolean>]
 [-LegacyCardinalityEstimationForSecondary <Boolean>] [-LocalCursorsDefault <Boolean>]
 [-NestedTriggersEnabled <Boolean>] [-NumericRoundAbortEnabled <Boolean>] [-ParameterSniffing <Boolean>]
 [-ParameterSniffingForSecondary <Boolean>] [-QueryOptimizerHotfixes <Boolean>]
 [-QueryOptimizerHotfixesForSecondary <Boolean>] [-QuotedIdentifiersEnabled <Boolean>] [-ReadOnly <Boolean>]
 [-RecursiveTriggersEnabled <Boolean>] [-RemoteDataArchiveEnabled <Boolean>]
 [-RemoteDataArchiveUseFederatedServiceAccount <Boolean>] [-TemporalHistoryRetentionEnabled <Boolean>]
 [-TransformNoiseWords <Boolean>] [-Trustworthy <Boolean>] [-WarnOnRename <Boolean>]
 [-ActiveConnections <Int32>] [-ChangeTrackingRetentionPeriod <Int32>] [-DefaultFullTextLanguage <Int32>]
 [-DefaultLanguage <Int32>] [-ID <Int32>] [-MaxDop <Int32>] [-MaxDopForSecondary <Int32>]
 [-MirroringRedoQueueMaxSize <Int32>] [-MirroringRoleSequence <Int32>] [-MirroringSafetySequence <Int32>]
 [-MirroringTimeout <Int32>] [-TargetRecoveryTime <Int32>] [-TwoDigitYearCutoff <Int32>] [-Version <Int32>]
 [-IndexSpaceUsage <Int64>] [-MaxSizeInBytes <Int64>] [-MemoryAllocatedToMemoryOptimizedObjectsInKB <Int64>]
 [-MemoryUsedByMemoryOptimizedObjectsInKB <Int64>] [-MirroringFailoverLogSequenceNumber <Int64>]
 [-PersistentVersionStoreSizeKB <Int64>] [-SpaceAvailable <Int64>] [-Size <Double>]
 [-AvailabilityGroupName <String>] [-AzureServiceObjective <String>] [-CatalogCollation <String>]
 [-Collation <String>] [-DboLogin <String>] [-DefaultFileGroup <String>] [-DefaultFileStreamFileGroup <String>]
 [-DefaultFullTextCatalog <String>] [-DefaultSchema <String>] [-FilestreamDirectoryName <String>]
 [-MirroringPartner <String>] [-MirroringPartnerInstance <String>] [-MirroringWitness <String>]
 [-Owner <String>] [-PersistentVersionStoreFileGroup <String>] [-PrimaryFilePath <String>]
 [-RemoteDataArchiveCredential <String>] [-RemoteDataArchiveEndpoint <String>]
 [-RemoteDataArchiveLinkedServer <String>] [-RemoteDatabaseName <String>] [-UserName <String>]
 [-AzureEdition <String>] [-CreateDate <DateTime>] [-LastBackupDate <DateTime>]
 [-LastDifferentialBackupDate <DateTime>] [-LastGoodCheckDbTime <DateTime>] [-LastLogBackupDate <DateTime>]
 [-DatabaseGuid <Guid>] [-MirroringID <Guid>] [-RecoveryForkGuid <Guid>] [-ServiceBrokerGuid <Guid>]
 [-AvailabilityDatabaseSynchronizationState <AvailabilityDatabaseSynchronizationState>]
 [-ChangeTrackingRetentionPeriodUnits <RetentionPeriodUnits>] [-CompatibilityLevel <CompatibilityLevel>]
 [-ContainmentType <ContainmentType>] [-DatabaseEngineEdition <DatabaseEngineEdition>]
 [-DatabaseEngineType <DatabaseEngineType>]
 [-FilestreamNonTransactedAccess <FilestreamNonTransactedAccessType>]
 [-LogReuseWaitStatus <LogReuseWaitStatus>] [-MirroringSafetyLevel <MirroringSafetyLevel>]
 [-MirroringStatus <MirroringStatus>] [-MirroringWitnessStatus <MirroringWitnessStatus>]
 [-PageVerify <PageVerify>] [-RecoveryModel <RecoveryModel>] [-ReplicationOptions <ReplicationOptions>]
 [-SnapshotIsolationState <SnapshotIsolationState>] [-State <SqlSmoState>] [-Status <DatabaseStatus>]
 [-UserAccess <DatabaseUserAccess>] [<CommonParameters>]

DESCRIPTION

This command tests if database properties on a SQL Server Database Engine instance are in the desired state.

The command supports a comprehensive set of database properties including configuration settings, metadata, security properties, performance settings, and state information. Users can test one or multiple properties in a single command execution.

All properties correspond directly to Microsoft SQL Server Management Objects (SMO) Database class properties and support the same data types and values as the underlying SMO implementation.

EXAMPLES

EXAMPLE 1

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
Test-SqlDscDatabaseProperty -ServerObject $serverObject -Name 'MyDatabase' -Collation 'SQL_Latin1_General_CP1_CI_AS'

Tests if the database named MyDatabase has the specified collation.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$databaseObject = $serverObject | Get-SqlDscDatabase -Name 'MyDatabase'
Test-SqlDscDatabaseProperty -DatabaseObject $databaseObject -RecoveryModel 'Simple' -CompatibilityLevel 'Version160'

Tests if the database has the specified recovery model and compatibility level using a database object.

EXAMPLE 3

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
Test-SqlDscDatabaseProperty -ServerObject $serverObject -Name 'MyDatabase' -Owner 'sa' -AutoClose $false -Trustworthy $false

Tests multiple database properties at once.

PARAMETERS

-AcceleratedRecoveryEnabled

Specifies whether Accelerated Database Recovery (ADR) is enabled for the database.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ActiveConnections

Specifies the number of active connections to the database (as observed by SMO).

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-ActiveDirectory

Specifies whether the database participates in Active Directory integration features.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AnsiNullDefault

Specifies whether new columns allow NULL by default unless explicitly specified (when ON).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AnsiNullsEnabled

Specifies whether comparisons to NULL follow ANSI SQL behavior (when ON, x = NULL yields UNKNOWN).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AnsiPaddingEnabled

Specifies whether padding for variable-length columns (e.g., CHAR/VARCHAR) follows ANSI rules.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AnsiWarningsEnabled

Specifies whether ANSI warnings are generated for certain conditions (when ON, e.g., divide by zero).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ArithmeticAbortEnabled

Specifies whether a query is terminated when an overflow or divide-by-zero error occurs.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoClose

Specifies whether the database closes after the last user exits.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoCreateIncrementalStatisticsEnabled

Specifies whether creation of incremental statistics on partitioned tables is allowed.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoCreateStatisticsEnabled

Specifies whether single-column statistics are automatically created for query optimization.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoShrink

Specifies whether the database automatically shrinks files when free space is detected.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoUpdateStatisticsAsync

Specifies whether statistics are updated asynchronously, allowing queries to proceed with old stats.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoUpdateStatisticsEnabled

Specifies whether statistics are automatically updated when they are out-of-date.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AvailabilityDatabaseSynchronizationState

Specifies the synchronization state of the database in an Availability Group.

Type: AvailabilityDatabaseSynchronizationState
Parameter Sets: (All)
Aliases:
Accepted values: NotSynchronizing, Synchronizing, Synchronized, Reverting, Initializing

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AvailabilityGroupName

Specifies the name of the Availability Group to which the database belongs, if any.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AzureEdition

Specifies the Azure SQL Database edition (e.g., Basic/Standard/Premium/GeneralPurpose/BusinessCritical).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AzureServiceObjective

Specifies the Azure SQL Database service objective (e.g., S3, P1, GP_Gen5_4).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BrokerEnabled

Specifies whether Service Broker is enabled for the database.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CaseSensitive

Specifies whether the database collation is case-sensitive.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CatalogCollation

Specifies the catalog-level collation used for metadata and temporary objects.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ChangeTrackingAutoCleanUp

Specifies whether automatic cleanup of change tracking information is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ChangeTrackingEnabled

Specifies whether change tracking is enabled for the database.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ChangeTrackingRetentionPeriod

Specifies the retention period value for change tracking information.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-ChangeTrackingRetentionPeriodUnits

Specifies the units for the retention period (e.g., DAYS, HOURS).

Type: RetentionPeriodUnits
Parameter Sets: (All)
Aliases:
Accepted values: None, Minutes, Hours, Days

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CloseCursorsOnCommitEnabled

Specifies whether open cursors are closed when a transaction is committed.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Collation

Specifies the default collation for the database.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CompatibilityLevel

Specifies the database compatibility level (affects query processor behavior and features).

Type: CompatibilityLevel
Parameter Sets: (All)
Aliases:
Accepted values: Version60, Version65, Version70, Version80, Version90, Version100, Version110, Version120, Version130, Version140, Version150, Version160, Version170

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConcatenateNullYieldsNull

Specifies whether concatenation with NULL results in NULL (when ON).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ContainmentType

Specifies the containment level of the database (NONE or PARTIAL).

Type: ContainmentType
Parameter Sets: (All)
Aliases:
Accepted values: None, Partial

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CreateDate

Specifies the date and time that the database was created.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DatabaseEngineEdition

Specifies the edition of the database engine hosting the database.

Type: DatabaseEngineEdition
Parameter Sets: (All)
Aliases:
Accepted values: Unknown, Personal, Standard, Enterprise, Express, SqlDatabase, SqlDataWarehouse, SqlStretchDatabase, SqlManagedInstance, SqlDatabaseEdge, SqlAzureArcManagedInstance, SqlOnDemand

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DatabaseEngineType

Specifies the engine type (e.g., Standalone, AzureSqlDatabase, SqlOnDemand).

Type: DatabaseEngineType
Parameter Sets: (All)
Aliases:
Accepted values: Unknown, Standalone, SqlAzureDatabase

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DatabaseGuid

Specifies the unique identifier (GUID) of the database.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DatabaseObject

Specifies the database object to test properties for (from Get-SqlDscDatabase).

Type: Database
Parameter Sets: DatabaseObjectSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DatabaseOwnershipChaining

Specifies whether ownership chaining across objects within the database is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DataRetentionEnabled

Specifies whether SQL Server data retention policy is enabled at the database level.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DateCorrelationOptimization

Specifies whether date correlation optimization is enabled to speed up temporal joins.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DboLogin

Specifies the login that owns the database (dbo).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultFileGroup

Specifies the name of the default filegroup for the database.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultFileStreamFileGroup

Specifies the name of the default FILESTREAM filegroup.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultFullTextCatalog

Specifies the default full-text catalog used for full-text indexes.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultFullTextLanguage

Specifies the LCID of the default full-text language.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-DefaultLanguage

Specifies the ID of the default language for the database.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-DefaultSchema

Specifies the default schema name for users without an explicit default schema.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DelayedDurability

Specifies whether delayed transaction log flushes are enabled to improve throughput.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EncryptionEnabled

Specifies whether Transparent Data Encryption (TDE) is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-FilestreamDirectoryName

Specifies the directory name used for FILESTREAM data.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FilestreamNonTransactedAccess

Specifies the FILESTREAM access level for non-transactional access.

Type: FilestreamNonTransactedAccessType
Parameter Sets: (All)
Aliases:
Accepted values: Off, ReadOnly, Full

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HasDatabaseEncryptionKey

Specifies whether the database has a database encryption key (TDE).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-HasFileInCloud

Specifies whether the database has one or more files in Azure Storage.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-HasMemoryOptimizedObjects

Specifies whether the database contains memory-optimized (In-Memory OLTP) objects.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-HonorBrokerPriority

Specifies whether honoring Service Broker conversation priority is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ID

Specifies the database ID (DB_ID). Unique numeric identifier assigned to the database by SQL Server.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-IndexSpaceUsage

Specifies the space used by indexes in KB.

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-IsAccessible

Specifies whether the database is accessible to the current connection.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDatabaseSnapshot

Specifies whether the database is a database snapshot.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDatabaseSnapshotBase

Specifies whether the database is the source (base) of one or more snapshots.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbAccessAdmin

Specifies whether the caller is member of db_accessadmin for this database.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbBackupOperator

Specifies whether the caller is member of db_backupoperator.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbDataReader

Specifies whether the caller is member of db_datareader.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbDataWriter

Specifies whether the caller is member of db_datawriter.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbDdlAdmin

Specifies whether the caller is member of db_ddladmin.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbDenyDataReader

Specifies whether the caller is member of db_denydatareader.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbDenyDataWriter

Specifies whether the caller is member of db_denydatawriter.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbManager

Specifies whether the caller is member of db_manager (Azure role).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbOwner

Specifies whether the caller is member of db_owner.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsDbSecurityAdmin

Specifies whether the caller is member of db_securityadmin.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsFabricDatabase

Specifies whether the database is a Microsoft Fabric SQL database.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsFullTextEnabled

Specifies whether full-text search is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsLedger

Specifies whether the database is enabled for SQL Ledger features.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsLoginManager

Specifies whether the caller is member of the login manager role (Azure).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsMailHost

Specifies whether Database Mail host features are configured on this database.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsManagementDataWarehouse

Specifies whether the database is configured as the Management Data Warehouse.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsMaxSizeApplicable

Specifies whether MaxSizeInBytes is enforced for the database.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsMirroringEnabled

Specifies whether database mirroring is configured.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsParameterizationForced

Specifies whether parameterization of queries is forced by default (when ON).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsReadCommittedSnapshotOn

Specifies whether READ_COMMITTED_SNAPSHOT isolation is ON.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsSqlDw

Specifies whether the database is an Azure Synapse (SQL DW) database.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsSqlDwEdition

Specifies whether the edition corresponds to Azure Synapse (DW).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsSystemObject

Specifies whether the database is a system database (master, model, msdb, tempdb).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsVarDecimalStorageFormatEnabled

Specifies whether vardecimal storage format is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsVarDecimalStorageFormatSupported

Specifies whether vardecimal storage format is supported by the server.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-LastBackupDate

Specifies the timestamp of the last full database backup.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LastDifferentialBackupDate

Specifies the timestamp of the last differential backup.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LastGoodCheckDbTime

Specifies the timestamp when DBCC CHECKDB last completed successfully.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LastLogBackupDate

Specifies the timestamp of the last transaction log backup.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LegacyCardinalityEstimation

Specifies whether the legacy cardinality estimator is enabled for the primary.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-LegacyCardinalityEstimationForSecondary

Specifies whether the legacy cardinality estimator is enabled for secondary replicas.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-LocalCursorsDefault

Specifies whether cursors are local by default instead of global (when ON).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-LogReuseWaitStatus

Specifies the reason why the transaction log cannot be reused.

Type: LogReuseWaitStatus
Parameter Sets: (All)
Aliases:
Accepted values: Nothing, Checkpoint, LogBackup, BackupOrRestore, Transaction, Mirroring, Replication, SnapshotCreation, LogScan, Other

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MaxDop

Specifies the MAXDOP database-scoped configuration for primary replicas.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MaxDopForSecondary

Specifies the MAXDOP database-scoped configuration for secondary replicas.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MaxSizeInBytes

Specifies the maximum size of the database in bytes.

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MemoryAllocatedToMemoryOptimizedObjectsInKB

Specifies the memory allocated to memory-optimized objects (KB).

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MemoryUsedByMemoryOptimizedObjectsInKB

Specifies the memory used by memory-optimized objects (KB).

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MirroringFailoverLogSequenceNumber

Specifies the mirroring failover LSN (if mirroring configured).

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MirroringID

Specifies the unique mirroring ID for the database.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MirroringPartner

Specifies the mirroring partner server name (if configured).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MirroringPartnerInstance

Specifies the mirroring partner instance name (if configured).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MirroringRedoQueueMaxSize

Specifies the redo queue maximum size for mirroring/AGs.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MirroringRoleSequence

Specifies the sequence number for mirroring role transitions.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MirroringSafetyLevel

Specifies the mirroring safety level (FULL/Off/HighPerformance).

Type: MirroringSafetyLevel
Parameter Sets: (All)
Aliases:
Accepted values: None, Unknown, Off, Full

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MirroringSafetySequence

Specifies the sequence for mirroring safety changes.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MirroringStatus

Specifies the current mirroring state of the database.

Type: MirroringStatus
Parameter Sets: (All)
Aliases:
Accepted values: None, Suspended, Disconnected, Synchronizing, PendingFailover, Synchronized

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MirroringTimeout

Specifies the timeout in seconds for mirroring sessions.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-MirroringWitness

Specifies the mirroring witness server (if used).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MirroringWitnessStatus

Specifies the status of the mirroring witness.

Type: MirroringWitnessStatus
Parameter Sets: (All)
Aliases:
Accepted values: None, Unknown, Connected, Disconnected

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the database to test properties for. The logical database name as it appears in SQL Server.

Type: String
Parameter Sets: ServerObjectSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NestedTriggersEnabled

Specifies whether triggers are allowed to fire other triggers (nested triggers).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-NumericRoundAbortEnabled

Specifies whether an error is raised on loss of precision due to rounding (when ON).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Owner

Specifies the owner (login) of the database.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageVerify

Specifies the page verification setting (NONE, TORN_PAGE_DETECTION, CHECKSUM).

Type: PageVerify
Parameter Sets: (All)
Aliases:
Accepted values: None, TornPageDetection, Checksum

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ParameterSniffing

Specifies whether parameter sniffing behavior is enabled on the primary.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ParameterSniffingForSecondary

Specifies whether parameter sniffing is enabled on secondary replicas.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PersistentVersionStoreFileGroup

Specifies the filegroup used for the Persistent Version Store (PVS).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PersistentVersionStoreSizeKB

Specifies the size of the Persistent Version Store in KB.

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PrimaryFilePath

Specifies the path of the primary data files directory.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-QueryOptimizerHotfixes

Specifies whether query optimizer hotfixes are enabled on the primary.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-QueryOptimizerHotfixesForSecondary

Specifies whether query optimizer hotfixes are enabled on secondary replicas.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-QuotedIdentifiersEnabled

Specifies whether identifiers can be delimited by double quotes (when ON).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ReadOnly

Specifies whether the database is in read-only mode.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-RecoveryForkGuid

Specifies the GUID for the current recovery fork of the database.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RecoveryModel

Specifies the database recovery model (FULL, BULK_LOGGED, SIMPLE).

Type: RecoveryModel
Parameter Sets: (All)
Aliases:
Accepted values: Full, BulkLogged, Simple

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RecursiveTriggersEnabled

Specifies whether a trigger is allowed to fire itself recursively.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Refresh

Specifies that the ServerObject's databases should be refreshed before trying to get the database object. This is helpful when databases could have been modified outside of the ServerObject, for example through T-SQL. But on instances with a large amount of databases it might be better to make sure the ServerObject is recent enough.

This parameter is only used when testing properties using ServerObject and Name parameters.

Type: SwitchParameter
Parameter Sets: ServerObjectSet
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-RemoteDataArchiveCredential

Specifies the credential name for Stretch Database/remote data archive.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemoteDataArchiveEnabled

Specifies whether Stretch Database (remote data archive) is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-RemoteDataArchiveEndpoint

Specifies the endpoint URL for remote data archive.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemoteDataArchiveLinkedServer

Specifies the linked server used by remote data archive.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemoteDataArchiveUseFederatedServiceAccount

Specifies whether to use federated service account for remote data archive.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-RemoteDatabaseName

Specifies the remote database name for remote data archive.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ReplicationOptions

Specifies the replication options that are enabled for the database.

Type: ReplicationOptions
Parameter Sets: (All)
Aliases:
Accepted values: None, Published, Subscribed, MergePublished, MergeSubscribed

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ServerObject

Specifies current server connection object.

Type: Server
Parameter Sets: ServerObjectSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ServiceBrokerGuid

Specifies the unique Service Broker identifier for the database.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Size

Specifies the approximate size of the database in MB (as reported by SMO).

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-SnapshotIsolationState

Specifies whether SNAPSHOT isolation is OFF/ON/IN_TRANSITION.

Type: SnapshotIsolationState
Parameter Sets: (All)
Aliases:
Accepted values: Disabled, Enabled, PendingOff, PendingOn

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SpaceAvailable

Specifies the free space available in the database (KB).

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-State

Specifies the general state of the SMO object.

Type: SqlSmoState
Parameter Sets: (All)
Aliases:
Accepted values: Pending, Creating, Existing, ToBeDropped, Dropped

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Status

Specifies the operational status of the database as reported by SMO.

Type: DatabaseStatus
Parameter Sets: (All)
Aliases:
Accepted values: Normal, Restoring, RecoveryPending, Recovering, Suspect, Offline, Inaccessible, Standby, Shutdown, EmergencyMode, AutoClosed

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetRecoveryTime

Specifies the target recovery time (seconds) for indirect checkpointing.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-TemporalHistoryRetentionEnabled

Specifies whether automatic cleanup of system-versioned temporal history is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TransformNoiseWords

Specifies how full-text noise word behavior is controlled during queries.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Trustworthy

Specifies whether implicit access to external resources by modules is allowed (use with caution).

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TwoDigitYearCutoff

Specifies the two-digit year cutoff used for date conversion.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-UserAccess

Specifies the database user access mode (MULTI_USER, RESTRICTED_USER, SINGLE_USER).

Type: DatabaseUserAccess
Parameter Sets: (All)
Aliases:
Accepted values: Multiple, Single, Restricted

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserName

Specifies the user name for the current connection context (as seen by SMO).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Version

Specifies the internal version number of the database.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-WarnOnRename

Specifies whether a warning is emitted when objects are renamed.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

[Microsoft.SqlServer.Management.Smo.Database]

The database object to test properties for (from Get-SqlDscDatabase).

OUTPUTS

[System.Boolean]

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️