Az.Sql

This topic displays help topics for the Azure SQL Database Cmdlets.

SQL

Add-AzSqlDatabaseToFailoverGroup

Adds one or more databases to an Azure SQL Database Failover Group.

Add-AzSqlElasticJobStep

Adds a job step to a job

Add-AzSqlElasticJobTarget

Adds a target to a target group

Add-AzSqlInstanceKeyVaultKey

Adds a key vault key to the provided Managed Instance.

Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate

Adds a Transparent Data Encryption Certificate for the given managed instance

Add-AzSqlServerKeyVaultKey

Adds a Key Vault key to a SQL server.

Add-AzSqlServerTransparentDataEncryptionCertificate

Adds a Transparent Data Encryption Certificate for the given SQL Server instance

Clear-AzSqlDatabaseAdvancedThreatProtectionSetting

Removes the advanced threat protection settings from a database.

Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline

Clears the vulnerability assessment rule baseline.

Clear-AzSqlDatabaseVulnerabilityAssessmentSetting

Clears the vulnerability assessment settings of a database.

Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline

Clears the vulnerability assessment rule baseline.

Clear-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting

Clears the vulnerability assessment settings of a managed database.

Clear-AzSqlInstanceVulnerabilityAssessmentSetting

Clears the vulnerability assessment settings of a managed instance.

Clear-AzSqlServerAdvancedThreatProtectionSetting

Removes the advanced threat protection settings from a server.

Clear-AzSqlServerVulnerabilityAssessmentSetting

Clears the vulnerability assessment settings of a server.

Convert-AzSqlDatabaseVulnerabilityAssessmentScan

Converts a vulnerability assessment scan results to Excel format.

Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan

Converts a vulnerability assessment scan results to Excel format.

Disable-AzSqlDatabaseSensitivityRecommendation

Disables (dismisses) sensitivity recommendations on columns in the database.

Disable-AzSqlInstanceAdvancedDataSecurity

Disables Advanced Data Security on a managed instance.

Disable-AzSqlInstanceDatabaseSensitivityRecommendation

Disables (dismisses) sensitivity recommendations on columns in the Azure SQL managed instance database.

Disable-AzSqlServerActiveDirectoryOnlyAuthentication

Disables Azure AD only authentication for a specific SQL Server.

Disable-AzSqlServerAdvancedDataSecurity

Disables Advanced Data Security on a server.

Enable-AzSqlDatabaseSensitivityRecommendation

Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the database.

Enable-AzSqlInstanceAdvancedDataSecurity

Enables Advanced Data Security on a managed instance.

Enable-AzSqlInstanceDatabaseSensitivityRecommendation

Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the Azure SQL managed instance database.

Enable-AzSqlServerAdvancedDataSecurity

Enables Advanced Data Security on a server.

Get-AzSqlCapability

Gets SQL Database capabilities for the current subscription.

Get-AzSqlDatabase

Gets one or more databases.

Get-AzSqlDatabaseActivity

Gets the status of database operations.

Get-AzSqlDatabaseAdvancedThreatProtectionSetting

Gets the advanced threat protection settings for a database.

Get-AzSqlDatabaseAdvisor

Gets one or more Advisors for an Azure SQL Database.

Get-AzSqlDatabaseAudit

Gets the auditing settings of an Azure SQL database.

Get-AzSqlDatabaseBackupLongTermRetentionPolicy

Gets a database long term retention policy.

Get-AzSqlDatabaseBackupShortTermRetentionPolicy

Gets a backup short term retention policy.

Get-AzSqlDatabaseDataMaskingPolicy

Gets the data masking policy for a database.

Get-AzSqlDatabaseDataMaskingRule

Gets the data masking rules from a database.

Get-AzSqlDatabaseExpanded

Gets a database and its expanded property values.

Get-AzSqlDatabaseFailoverGroup

Gets or lists Azure SQL Database Failover Groups.

Get-AzSqlDatabaseGeoBackup

Gets a geo-redundant backup of a database.

Get-AzSqlDatabaseGeoBackupPolicy

Gets a database geo backup policy.

Get-AzSqlDatabaseImportExportStatus

Gets the details of an import or export of an Azure SQL Database.

Get-AzSqlDatabaseIndexRecommendation

Gets the recommended index operations for a server or database.

Get-AzSqlDatabaseInstanceFailoverGroup

Gets or lists Instance Failover Groups.

Get-AzSqlDatabaseLongTermRetentionBackup

Gets one or more long term retention backups.

Get-AzSqlDatabaseRecommendedAction

Gets one or more recommended actions for an Azure SQL Database Advisor.

Get-AzSqlDatabaseReplicationLink

Gets the geo-replication links between an Azure SQL Database and a resource group or SQL Server.

Get-AzSqlDatabaseRestorePoint

Retrieves the distinct restore points from which a SQL Data Warehouse can be restored.

Get-AzSqlDatabaseSensitivityClassification

Gets the current information types and sensitivity labels of columns in the database.

Get-AzSqlDatabaseSensitivityRecommendation

Gets the recommended information types and sensitivity labels of columns in the database.

Get-AzSqlDatabaseTransparentDataEncryption

Gets the TDE state for a database.

Get-AzSqlDatabaseTransparentDataEncryptionActivity

Gets the progress of a TDE scan of a database.

Get-AzSqlDatabaseUpgradeHint

Gets pricing tier hints for a database.

Get-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline

Gets the vulnerability assessment rule baseline.

Get-AzSqlDatabaseVulnerabilityAssessmentScanRecord

Gets all vulnerability assessment scan record(s) associated with a given database.

Get-AzSqlDatabaseVulnerabilityAssessmentSetting

Gets the vulnerability assessment settings of a database.

Get-AzSqlDeletedDatabaseBackup

Gets a deleted database that you can restore.

Get-AzSqlDeletedInstanceDatabaseBackup

Gets a deleted database that you can restore.

Get-AzSqlElasticJob

Gets one or more jobs

Get-AzSqlElasticJobAgent

Gets a Azure SQL Elastic Job agent

Get-AzSqlElasticJobCredential

Gets one or more credentials

Get-AzSqlElasticJobExecution

Gets one or more job executions

Get-AzSqlElasticJobStep

Gets one or more job steps

Get-AzSqlElasticJobStepExecution

Gets one or more job step executions

Get-AzSqlElasticJobTargetExecution

Gets one or more job target executions

Get-AzSqlElasticJobTargetGroup

Gets one or more job target groups

Get-AzSqlElasticPool

Gets elastic pools and their property values in an Azure SQL Database.

Get-AzSqlElasticPoolActivity

Gets the status of operations on an elastic pool.

Get-AzSqlElasticPoolAdvisor

Gets one or more Advisors for an Azure SQL Elastic Pool.

Get-AzSqlElasticPoolDatabase

Gets elastic databases in an elastic pool and their property values.

Get-AzSqlElasticPoolRecommendation

Gets elastic pool recommendations.

Get-AzSqlElasticPoolRecommendedAction

Gets one or more recommended actions for an Azure SQL Elastic Pool Advisor.

Get-AzSqlInstance

Returns information about Azure SQL Managed Database Instance.

Get-AzSqlInstanceActiveDirectoryAdministrator

Gets information about an Azure AD administrator for SQL Managed Instance.

Get-AzSqlInstanceAdvancedDataSecurityPolicy

Gets Advanced Data Security policy of a managed instance.

Get-AzSqlInstanceDatabase

Returns information about Azure SQL Managed Instance database.

Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy

Gets a managed database's long term retention policy

Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy

Gets a backup short term retention policy.

Get-AzSqlInstanceDatabaseGeoBackup

Returns information about Azure SQL Managed Instance database redundant backup.

Get-AzSqlInstanceDatabaseLongTermRetentionBackup

Gets long term retention backup(s).

Get-AzSqlInstanceDatabaseSensitivityClassification

Gets the current information types and sensitivity labels of columns in the Azure SQL managed instance database.

Get-AzSqlInstanceDatabaseSensitivityRecommendation

Gets the recommended information types and sensitivity labels of columns in the Azure SQL managed instance database.

Get-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline

Gets the vulnerability assessment rule baseline.

Get-AzSqlInstanceDatabaseVulnerabilityAssessmentScanRecord

Gets all vulnerability assessment scan record(s) associated with a given managed database.

Get-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting

Gets the vulnerability assessment settings of a managed database.

Get-AzSqlInstanceKeyVaultKey

Gets a SQL managed instance's Key Vault keys.

Get-AzSqlInstanceOperation

Gets a SQL managed instance's operations.

Get-AzSqlInstancePool

Returns information about the Azure SQL Instance pool.

Get-AzSqlInstancePoolUsage

Returns information about an Azure SQL Instance pool's usage.

Get-AzSqlInstanceTransparentDataEncryptionProtector

Gets the Transparent Data Encryption (TDE) protector for a SQL managed instance.

Get-AzSqlInstanceVulnerabilityAssessmentSetting

Gets the vulnerability assessment settings of a managed instance.

Get-AzSqlServer

Returns information about SQL Database servers.

Get-AzSqlServerActiveDirectoryAdministrator

Gets information about an Azure AD administrator for SQL Server.

Get-AzSqlServerAdvancedDataSecurityPolicy

Gets Advanced Data Security policy of a server.

Get-AzSqlServerAdvancedThreatProtectionSetting

Gets the advanced threat protection settings for a server.

Get-AzSqlServerAdvisor

Gets one or more Advisors for an Azure SQL Server.

Get-AzSqlServerAudit

Gets the auditing settings of an Azure SQL server.

Get-AzSqlServerCommunicationLink

Gets communication links for elastic database transactions between database servers.

Get-AzSqlServerDisasterRecoveryConfiguration

Gets a database server system recovery configuration.

Get-AzSqlServerDisasterRecoveryConfigurationActivity

Gets activity for a database server system recovery configuration.

Get-AzSqlServerDnsAlias

Gets or lists Azure SQL Server DNS Alias.

Get-AzSqlServerFirewallRule

Gets firewall rules for a SQL Database server.

Get-AzSqlServerKeyVaultKey

Gets a SQL server's Key Vault keys.

Get-AzSqlServerRecommendedAction

Gets one or more recommended actions for an Azure SQL Server Advisor.

Get-AzSqlServerServiceObjective

Gets service objectives for an Azure SQL Database server.

Get-AzSqlServerTransparentDataEncryptionProtector

Gets the Transparent Data Encryption (TDE) protector

Get-AzSqlServerUpgradeHint

Gets pricing tier hints for upgrading an Azure SQL Database server.

Get-AzSqlServerVirtualNetworkRule

Gets or lists Azure SQL Server Virtual Network Rule.

Get-AzSqlServerVulnerabilityAssessmentSetting

Gets the vulnerability assessment settings of a server.

Get-AzSqlSyncAgent

Returns information about Azure SQL Sync Agents.

Get-AzSqlSyncAgentLinkedDatabase

Returns information about SQL Server databases linked by a sync agent.

Get-AzSqlSyncGroup

Returns information about Azure SQL Database Sync Groups.

Get-AzSqlSyncGroupLog

Returns the logs of an Azure SQL Database Sync Group.

Get-AzSqlSyncMember

Returns information about Azure SQL Database Sync Members.

Get-AzSqlSyncSchema

Returns information about the sync schema of a member database or a hub database.

Get-AzSqlVirtualCluster

Returns information about Azure SQL Virtual Cluster.

Invoke-AzSqlDatabaseFailover

Failovers a database.

Invoke-AzSqlElasticPoolFailover

Failovers an elastic pool.

Invoke-AzSqlInstanceFailover

Failovers an Azure SQL Managed Instance.

New-AzSqlDatabase

Creates a database or an elastic database.

New-AzSqlDatabaseCopy

Creates a copy of a SQL Database that uses the snapshot at the current time.

New-AzSqlDatabaseDataMaskingRule

Creates a data masking rule for a database.

New-AzSqlDatabaseExport

Exports an Azure SQL Database as a .bacpac file to a storage account.

New-AzSqlDatabaseFailoverGroup

This command creates a new Azure SQL Database Failover Group.

New-AzSqlDatabaseImport

Imports a .bacpac file and create a new database on the server.

New-AzSqlDatabaseInstanceFailoverGroup

This command creates a new Azure SQL Database Instance Failover Group.

New-AzSqlDatabaseRestorePoint

Creates a new restore point from which a SQL Database can be restored.

New-AzSqlDatabaseSecondary

Creates a secondary database for an existing database and starts data replication.

New-AzSqlElasticJob

Creates a new job

New-AzSqlElasticJobAgent

Creates a new elastic job agent

New-AzSqlElasticJobCredential

Creates a new job credential

New-AzSqlElasticJobTargetGroup

Creates a new target group

New-AzSqlElasticPool

Creates an elastic database pool for a SQL Database.

New-AzSqlInstance

Creates an Azure SQL Database Managed Instance.

New-AzSqlInstanceDatabase

Creates an Azure SQL Managed Instance database.

New-AzSqlInstancePool

Creates an Azure SQL Instance pool.

New-AzSqlServer

Creates a SQL Database server.

New-AzSqlServerCommunicationLink

Creates a communication link for elastic database transactions between two SQL Database servers.

New-AzSqlServerDisasterRecoveryConfiguration

Creates a database server system recovery configuration.

New-AzSqlServerDnsAlias

This command creates a new Azure SQL Server DNS Alias.

New-AzSqlServerFirewallRule

Creates a firewall rule for a SQL Database server.

New-AzSqlServerVirtualNetworkRule

Creates an Azure SQL Server Virtual Network Rule.

New-AzSqlSyncAgent

Creates an Azure SQL Sync Agent.

New-AzSqlSyncAgentKey

Creates an Azure SQL Sync Agent Key.

New-AzSqlSyncGroup

Creates an Azure SQL Database Sync Group.

New-AzSqlSyncMember

Creates an Azure SQL Database Sync Member.

Remove-AzSqlDatabase

Removes an Azure SQL database.

Remove-AzSqlDatabaseAudit

Removes the auditing settings of an Azure SQL database.

Remove-AzSqlDatabaseDataMaskingRule

Removes a data masking rule from a database.

Remove-AzSqlDatabaseFailoverGroup

Removes an Azure SQL Database Failover Group.

Remove-AzSqlDatabaseFromFailoverGroup

Removes one or more databases from an Azure SQL Database Failover Group.

Remove-AzSqlDatabaseInstanceFailoverGroup

Removes an Instance Failover Group.

Remove-AzSqlDatabaseLongTermRetentionBackup

Deletes a long term retention backup.

Remove-AzSqlDatabaseRestorePoint

Removes given restore point from a SQL Database.

Remove-AzSqlDatabaseSecondary

Terminates data replication between a SQL Database and the specified secondary database.

Remove-AzSqlDatabaseSensitivityClassification

Removes the information types and sensitivity labels of columns in the database.

Remove-AzSqlElasticJob

Removes a job

Remove-AzSqlElasticJobAgent

Removes the elastic job agent

Remove-AzSqlElasticJobCredential

Removes the elastic job credential

Remove-AzSqlElasticJobStep

Removes the job step

Remove-AzSqlElasticJobTarget

Removes the target from the target group

Remove-AzSqlElasticJobTargetGroup

Removes the target group

Remove-AzSqlElasticPool

Deletes an elastic database pool.

Remove-AzSqlInstance

Removes an Azure SQL Managed Database Instance.

Remove-AzSqlInstanceActiveDirectoryAdministrator

Removes an Azure AD administrator for SQL Managed Instance.

Remove-AzSqlInstanceDatabase

Removes an Azure SQL Managed Instance database.

Remove-AzSqlInstanceDatabaseLongTermRetentionBackup

Deletes a long term retention backup.

Remove-AzSqlInstanceDatabaseSensitivityClassification

Removes the information types and sensitivity labels of columns in the Azure SQL managed instance database.

Remove-AzSqlInstanceKeyVaultKey

Removes a Key Vault key from a SQL managed instance

Remove-AzSqlInstancePool

Removes an Azure SQL Instance pool.

Remove-AzSqlServer

Removes an Azure SQL Database server.

Remove-AzSqlServerActiveDirectoryAdministrator

Removes an Azure AD administrator for SQL Server.

Remove-AzSqlServerAudit

Removes the auditing settings of an Azure SQL server.

Remove-AzSqlServerCommunicationLink

Deletes a communication link for elastic database transactions between two servers.

Remove-AzSqlServerDisasterRecoveryConfiguration

Removes a SQL database server system recovery configuration.

Remove-AzSqlServerDnsAlias

Removes Azure SQL Server DNS Alias.

Remove-AzSqlServerFirewallRule

Deletes a firewall rule from a SQL Database server.

Remove-AzSqlServerKeyVaultKey

Removes a Key Vault key from a SQL server.

Remove-AzSqlServerVirtualNetworkRule

Deletes an Azure SQL Server Virtual Network Rule.

Remove-AzSqlSyncAgent

Removes an Azure SQL Sync Agent.

Remove-AzSqlSyncGroup

Removes an Azure SQL Database Sync Group.

Remove-AzSqlSyncMember

Removes an Azure SQL Database Sync Member.

Remove-AzSqlVirtualCluster

Removes an Azure SQL Virtual Cluster.

Restore-AzSqlDatabase

Restores a SQL database.

Restore-AzSqlInstanceDatabase

Restores an Azure SQL Managed Instance database.

Resume-AzSqlDatabase

Resumes a SQL Data Warehouse database.

Set-AzSqlDatabase

Sets properties for a database, or moves an existing database into an elastic pool.

Set-AzSqlDatabaseAdvisorAutoExecuteStatus

Modifies auto execute status of an Azure SQL Database Advisor.

Set-AzSqlDatabaseAudit

Changes the auditing settings for an Azure SQL database.

Set-AzSqlDatabaseBackupLongTermRetentionPolicy

Sets a server long term retention policy.

Set-AzSqlDatabaseBackupShortTermRetentionPolicy

Sets a backup short term retention policy.

Set-AzSqlDatabaseDataMaskingPolicy

Sets data masking for a database.

Set-AzSqlDatabaseDataMaskingRule

Sets the properties of a data masking rule for a database.

Set-AzSqlDatabaseFailoverGroup

Modifies the configuration of an Azure SQL Database Failover Group.

Set-AzSqlDatabaseGeoBackupPolicy

Sets a database geo backup policy.

Set-AzSqlDatabaseInstanceFailoverGroup

Modifies the configuration of an Instance Failover Group.

Set-AzSqlDatabaseRecommendedActionState

Updates the state of an Azure SQL Database recommended action.

Set-AzSqlDatabaseSecondary

Switches a secondary database to be primary in order to initiate failover.

Set-AzSqlDatabaseSensitivityClassification

Sets the information types and sensitivity labels of columns in the database.

Set-AzSqlDatabaseTransparentDataEncryption

Modifies TDE property for a database.

Set-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline

Sets the vulnerability assessment rule baseline.

Set-AzSqlElasticJob

Updates a job

Set-AzSqlElasticJobAgent

Updates an elastic job agent

Set-AzSqlElasticJobCredential

Updates a job credential

Set-AzSqlElasticJobStep

Updates a job step

Set-AzSqlElasticPool

Modifies properties of an elastic database pool in Azure SQL Database.

Set-AzSqlElasticPoolAdvisorAutoExecuteStatus

Updates auto execute status of an Azure SQL Elastic Pool Advisor.

Set-AzSqlElasticPoolRecommendedActionState

Updates the state of an Azure SQL Elastic Pool recommended action.

Set-AzSqlInstance

Sets properties for an Azure SQL Database Managed Instance.

Set-AzSqlInstanceActiveDirectoryAdministrator

Provisions an Azure AD administrator for SQL Managed Instance.

Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy

The Set-AzSqlInstanceDatabaseLongTermRetentionBackup cmdlet sets a managed database's long term retention policy.

Set-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy

Sets a backup short term retention policy.

Set-AzSqlInstanceDatabaseSensitivityClassification

Sets the information types and sensitivity labels of columns in the Azure SQL managed instance database.

Set-AzSqlInstanceDatabaseVulnerabilityAssessmentRuleBaseline

Sets the vulnerability assessment rule baseline.

Set-AzSqlInstancePool

Sets properties for an Azure SQL Instance pool.

Set-AzSqlInstanceTransparentDataEncryptionProtector

Sets the Transparent Data Encryption (TDE) protector for a SQL managed instance.

Set-AzSqlServer

Modifies properties of a SQL Database server.

Set-AzSqlServerActiveDirectoryAdministrator

Provisions an Azure AD administrator for SQL Server.

Set-AzSqlServerAdvisorAutoExecuteStatus

Updates the auto execute status of an Azure SQL Server Advisor.

Set-AzSqlServerAudit

Changes the auditing settings of an Azure SQL server.

Set-AzSqlServerDisasterRecoveryConfiguration

Modifies a database server recovery configuration.

Set-AzSqlServerDnsAlias

Modifies the server to which Azure SQL Server DNS Alias is pointing

Set-AzSqlServerFirewallRule

Modifies a firewall rule in Azure SQL Database server.

Set-AzSqlServerRecommendedActionState

Updates the state of an Azure SQL Server recommended action.

Set-AzSqlServerTransparentDataEncryptionProtector

Sets the Transparent Data Encryption (TDE) protector for a SQL server.

Set-AzSqlServerVirtualNetworkRule

Modifies the configuration of an Azure SQL Server Virtual Network Rule.

Start-AzSqlDatabaseExecuteIndexRecommendation

Starts the workflow that runs a recommended index operation.

Start-AzSqlDatabaseVulnerabilityAssessmentScan

Starts a vulnerability assessment scan.

Start-AzSqlElasticJob

Starts a job, returning a job execution id that can be polled to view it's status

Start-AzSqlInstanceDatabaseVulnerabilityAssessmentScan

Starts a vulnerability assessment scan.

Start-AzSqlSyncGroupSync

Starts a sync group synchronization.

Stop-AzSqlDatabaseActivity

Cancels the asynchronous updates operation on the database.

Stop-AzSqlDatabaseExecuteIndexRecommendation

Stops the workflow that runs a recommended index operation.

Stop-AzSqlElasticJob

Stops a job given it's job execution id

Stop-AzSqlElasticPoolActivity

Cancels the asynchronous update operation on an elastic pool.

Stop-AzSqlInstanceOperation

Stops a SQL managed instance's operations.

Stop-AzSqlSyncGroupSync

Stops a sync group synchronization.

Suspend-AzSqlDatabase

Suspends a SQL Data Warehouse database.

Switch-AzSqlDatabaseFailoverGroup

Executes a failover of an Azure SQL Database Failover Group.

Switch-AzSqlDatabaseInstanceFailoverGroup

Executes a failover of an Instance Failover Group.

Update-AzSqlDatabaseAdvancedThreatProtectionSetting

Sets a advanced threat protection settings on a database.

Update-AzSqlDatabaseVulnerabilityAssessmentSetting

Updates the vulnerability assessment settings of a database.

Update-AzSqlInstanceDatabaseVulnerabilityAssessmentSetting

Updates the vulnerability assessment settings of a managed database.

Update-AzSqlInstanceVulnerabilityAssessmentSetting

Updates the vulnerability assessment settings of a managed instance.

Update-AzSqlServerAdvancedThreatProtectionSetting

Sets a advanced threat protection settings on a server.

Update-AzSqlServerVulnerabilityAssessmentSetting

Updates the vulnerability assessment settings of a server.

Update-AzSqlSyncGroup

Updates an Azure SQL Database Sync Group.

Update-AzSqlSyncMember

Updates an Azure SQL Database Sync Member.

Update-AzSqlSyncSchema

Update the sync schema for a sync member database or a sync hub database. It will get the latest database schema from the real database and then use it refresh the schema cached by Sync metadata database. If "SyncMemberName" is specified, it will refresh the member database schema; if not, it will refresh the hub database schema.