Az.Sql Module
This topic displays help topics for the Azure SQL Database Cmdlets.
SQL
| Cmdlet | Description |
|---|---|
| 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-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-AzSqlServerVulnerabilityAssessmentSetting |
Clears the vulnerability assessment settings of a server. |
| Complete-AzSqlInstanceDatabaseCopy |
Complete online copy operation of a managed database. |
| Complete-AzSqlInstanceDatabaseLogReplay |
Completes Log Replay service for the given database. |
| Complete-AzSqlInstanceDatabaseMove |
Complete online move operation of a managed database. |
| Convert-AzSqlDatabaseVulnerabilityAssessmentScan |
Converts a vulnerability assessment scan results to Excel format. |
| Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan |
Converts a vulnerability assessment scan results to Excel format. |
| Copy-AzSqlDatabaseLongTermRetentionBackup |
Copies a long term retention backup to a target database. |
| Copy-AzSqlInstanceDatabase |
Copy managed database to another managed instance. |
| Disable-AzSqlDatabaseLedgerDigestUpload |
Disables uploading ledger digests to Azure Blob storage or to Azure Confidential Ledger. |
| Disable-AzSqlDatabaseSensitivityRecommendation |
Disables (dismisses) sensitivity recommendations on columns in the database. |
| Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication |
Disables Microsoft Entra-only authentication for a specific SQL Managed Instance. |
| Disable-AzSqlInstanceAdvancedDataSecurity |
Disables Advanced Data Security on a managed instance. |
| Disable-AzSqlInstanceDatabaseLedgerDigestUpload |
Disables uploading ledger digests to Azure Blob storage or Azure Confidential Ledger in Azure SQL Managed Instance. |
| Disable-AzSqlInstanceDatabaseSensitivityRecommendation |
Disables (dismisses) sensitivity recommendations on columns in the Azure SQL Managed Instance database. |
| Disable-AzSqlServerActiveDirectoryOnlyAuthentication |
Disables Microsoft Entra-only authentication for a specific SQL Server. |
| Disable-AzSqlServerAdvancedDataSecurity |
Disables Advanced Data Security on a server. |
| Enable-AzSqlDatabaseLedgerDigestUpload |
Enables uploading ledger digests to an Azure Storage account or to Azure Confidential Ledger. |
| Enable-AzSqlDatabaseSensitivityRecommendation |
Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the database. |
| Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication |
Enables Microsoft Entra-only authentication for a specific SQL Managed Instance. |
| Enable-AzSqlInstanceAdvancedDataSecurity |
Enables Advanced Data Security on a managed instance. |
| Enable-AzSqlInstanceDatabaseLedgerDigestUpload |
Enables uploading ledger digests to an Azure Storage account or Azure Confidential Ledger for a database in an Azure SQL 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-AzSqlServerActiveDirectoryOnlyAuthentication |
Enables Microsoft Entra-only authentication for a specific SQL Server. |
| 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-AzSqlDatabaseLedgerDigestUpload |
Gets the ledger digest upload settings of an Azure SQL database. |
| 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-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-AzSqlDeletedServer |
Gets information about deleted Azure SQL servers. (Server soft-delete feature is currently in Public Preview) |
| 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-AzSqlElasticJobPrivateEndpoint |
Gets one or more job private endpoints |
| 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 a Microsoft Entra administrator for SQL Managed Instance. |
| Get-AzSqlInstanceActiveDirectoryOnlyAuthentication |
Gets Microsoft Entra-only authentication for a specific SQL Managed Instance. |
| Get-AzSqlInstanceAdvancedDataSecurityPolicy |
Gets Advanced Data Security policy of a managed instance. |
| Get-AzSqlInstanceAdvancedThreatProtectionSetting |
Gets the Advanced Threat Protection settings for a managed instance. |
| Get-AzSqlInstanceDatabase |
Returns information about Azure SQL Managed Instance database. |
| Get-AzSqlInstanceDatabaseAdvancedThreatProtectionSetting |
Gets the Advanced Threat Protection settings for a managed database. |
| Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy |
Gets a managed database's long term retention policy |
| Get-AzSqlInstanceDatabaseBackupShortTermRetentionPolicy |
Gets a backup short term retention policy. |
| Get-AzSqlInstanceDatabaseCopyOperation |
Get managed database copy operation details |
| Get-AzSqlInstanceDatabaseGeoBackup |
Returns information about Azure SQL Managed Instance database redundant backup. |
| Get-AzSqlInstanceDatabaseLedgerDigestUpload |
Gets the ledger digest upload settings of a database in Azure SQL Managed Instance. |
| Get-AzSqlInstanceDatabaseLogReplay |
Gets the Log Replay service status. |
| Get-AzSqlInstanceDatabaseLongTermRetentionBackup |
Gets long term retention backup(s). |
| Get-AzSqlInstanceDatabaseMoveOperation |
Get managed database move operation details |
| 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-AzSqlInstanceDtc |
Gets an Azure SQL Managed Instance DTC. |
| Get-AzSqlInstanceEndpointCertificate |
Returns information about endpoint certificates. |
| Get-AzSqlInstanceKeyVaultKey |
Gets a SQL managed instance's Key Vault keys. |
| Get-AzSqlInstanceLink |
Returns information about link feature for Azure SQL Managed Instance. |
| 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-AzSqlInstanceServerTrustCertificate |
Returns information about server trust certificate. |
| Get-AzSqlInstanceStartStopSchedule |
Get start/stop schedule for Azure SQL Managed Instance |
| 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 a Microsoft Entra administrator for SQL Server. |
| Get-AzSqlServerActiveDirectoryOnlyAuthentication |
Gets Microsoft Entra-only authentication for a specific 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-AzSqlServerConfigurationOption |
Returns information about server configuration options for Azure SQL Managed Instance. |
| 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-AzSqlServerIpv6FirewallRule |
Gets IPv6 firewall rules for a SQL Database server. |
| Get-AzSqlServerKeyVaultKey |
Gets a SQL server's Key Vault keys. |
| Get-AzSqlServerMSSupportAudit |
Gets the Microsoft support operations auditing settings of an Azure SQL server. |
| Get-AzSqlServerOutboundFirewallRule |
Gets outbound firewall rules (Allowed FQDNs) for a SQL Database server. |
| 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-AzSqlServerTrustGroup |
Gets information about Server Trust Group. |
| 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-AzSqlDatabaseTransparentDataEncryptionProtectorRevalidation |
Revalidates Database Encryption Protector AKV key |
| Invoke-AzSqlDatabaseTransparentDataEncryptionProtectorRevert |
Reverts Database Encryption Protector AKV key to Server level key |
| Invoke-AzSqlElasticPoolFailover |
Failovers an elastic pool. |
| Invoke-AzSqlInstanceExternalGovernanceStatusRefresh |
Refreshes the value of external governance on the managed instance. |
| Invoke-AzSqlInstanceFailover |
Failovers an Azure SQL Managed Instance. |
| Invoke-AzSqlInstanceTransparentDataEncryptionProtectorRevalidation |
Revalidates the Managed Instance Encryption Protector AKV key |
| Invoke-AzSqlServerExternalGovernanceStatusRefresh |
Refreshes the value of external governance on the server. |
| Invoke-AzSqlServerTransparentDataEncryptionProtectorRevalidation |
Revalidates the Server Encryption Protector AKV key |
| Lock-AzSqlDatabaseLongTermRetentionBackupImmutability |
Locks the time-based immutability policy for an LTR backup. |
| Move-AzSqlInstanceDatabase |
Move managed database to another 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-AzSqlElasticJobPrivateEndpoint |
Creates a new job private endpoint |
| New-AzSqlElasticJobTargetGroup |
Creates a new target group |
| New-AzSqlElasticPool |
Creates an elastic database pool for a SQL Database. |
| New-AzSqlInstance |
Creates an Azure SQL Managed Instance. |
| New-AzSqlInstanceDatabase |
Creates an Azure SQL Managed Instance database. |
| New-AzSqlInstanceLink |
Creates a new instance link. |
| New-AzSqlInstancePool |
Creates an Azure SQL Instance pool. |
| New-AzSqlInstanceScheduleItem |
Helper command for creating ScheduleItem object that is uses for New-AzSqlInstanceStartStopSchedule cmdlet |
| New-AzSqlInstanceServerTrustCertificate |
Creates a new server trust certificate. |
| New-AzSqlInstanceStartStopSchedule |
Creates start/stop schedule for Azure SQL Managed Instance |
| 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-AzSqlServerIpv6FirewallRule |
Creates an IPv6 firewall rule for a SQL Database server. |
| New-AzSqlServerOutboundFirewallRule |
Adds the allowed FQDN to the list of outbound firewall rules and creates a new outbound firewall rule for Azure SQL Database server. |
| New-AzSqlServerTrustGroup |
Creates or updates a Server Trust Group. |
| 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-AzSqlDatabaseLongTermRetentionBackupImmutability |
Removes an unlocked time-based immutability policy for an LTR backup. |
| Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold |
Removes legal hold immutability on an LTR backup. (Public Preview) |
| 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-AzSqlElasticJobPrivateEndpoint |
Removes the elastic job private endpoint |
| 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 a Microsoft Entra 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-AzSqlInstanceLink |
Removes an instance link. |
| Remove-AzSqlInstancePool |
Removes an Azure SQL Instance pool. |
| Remove-AzSqlInstanceServerTrustCertificate |
Removes a server trust certificate. |