SqlDatabaseResource Class

Definition

Namespace:: Azure.ResourceManager.Sql

Assembly:: Azure.ResourceManager.Sql.dll

Package:: Azure.ResourceManager.Sql v1.4.0

Package:: Azure.ResourceManager.Sql v1.5.0-beta.1

Source:: SqlDatabaseResource.cs

Source:: SqlDatabaseResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A class representing a SqlDatabase along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SqlDatabaseResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource SqlServerResource using the GetSqlDatabases method.

public class SqlDatabaseResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Sql.SqlDatabaseData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Sql.SqlDatabaseData>

type SqlDatabaseResource = class
    inherit ArmResource
    interface IJsonModel<SqlDatabaseData>
    interface IPersistableModel<SqlDatabaseData>

Public Class SqlDatabaseResource
Inherits ArmResource
Implements IJsonModel(Of SqlDatabaseData), IPersistableModel(Of SqlDatabaseData)

Inheritance: Object

ArmResource
SqlDatabaseResource

Implements: IJsonModel<SqlDatabaseData> IPersistableModel<SqlDatabaseData> IPersistableModel<T>

Constructors

Name	Description
SqlDatabaseResource()	Initializes a new instance of SqlDatabaseResource for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Data	Gets the data representing this Feature.
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
HasData	Gets whether or not the current instance has data.
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

Name	Description
AddTag(String, String, CancellationToken)	Add a tag to the current resource.
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource.
CancelDatabaseOperation(Guid, CancellationToken)	Cancels the asynchronous operation on the database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations/{operationId}/cancel. Operation Id. : Databases_Cancel. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
CancelDatabaseOperationAsync(Guid, CancellationToken)	Cancels the asynchronous operation on the database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations/{operationId}/cancel. Operation Id. : Databases_Cancel. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
CanUseTagResource(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CreateOrUpdateDatabaseExtension(WaitUntil, String, SqlDatabaseExtension, CancellationToken)	Perform a database extension operation, like database import, database export, or polybase import Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/{extensionName}. Operation Id. : ImportExportExtensionsOperationResults_CreateOrUpdate. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
CreateOrUpdateDatabaseExtensionAsync(WaitUntil, String, SqlDatabaseExtension, CancellationToken)	Perform a database extension operation, like database import, database export, or polybase import Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/{extensionName}. Operation Id. : ImportExportExtensionsOperationResults_CreateOrUpdate. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
CreateResourceIdentifier(String, String, String, String)	Generate the resource identifier for this resource.
CreateRestorePoint(WaitUntil, CreateDatabaseRestorePointDefinition, CancellationToken)	Creates a restore point for a data warehouse. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints. Operation Id. : Databases_Create. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
CreateRestorePointAsync(WaitUntil, CreateDatabaseRestorePointDefinition, CancellationToken)	Creates a restore point for a data warehouse. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints. Operation Id. : Databases_Create. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
Delete(WaitUntil, CancellationToken)	Deletes the database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}. Operation Id. : Databases_Delete. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
DeleteAsync(WaitUntil, CancellationToken)	Deletes the database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}. Operation Id. : Databases_Delete. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
Export(WaitUntil, DatabaseExportDefinition, CancellationToken)	Exports a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/export. Operation Id. : Databases_Export. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
ExportAsync(WaitUntil, DatabaseExportDefinition, CancellationToken)	Exports a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/export. Operation Id. : Databases_Export. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
Failover(WaitUntil, Nullable<ReplicaType>, CancellationToken)	Failovers a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover. Operation Id. : Databases_Failover. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
FailoverAsync(WaitUntil, Nullable<ReplicaType>, CancellationToken)	Failovers a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover. Operation Id. : Databases_Failover. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
Get(String, String, CancellationToken)	Gets a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}. Operation Id. : Databases_Get. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetAsync(String, String, CancellationToken)	Gets a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}. Operation Id. : Databases_Get. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetBackupShortTermRetentionPolicies()	Gets a collection of BackupShortTermRetentionPolicies in the SqlDatabaseResource.
GetBackupShortTermRetentionPolicy(ShortTermRetentionPolicyName, CancellationToken)	Gets a database's short term retention policy.
GetBackupShortTermRetentionPolicyAsync(ShortTermRetentionPolicyName, CancellationToken)	Gets a database's short term retention policy.
GetCurrentSensitivityLabels(String, Nullable<Boolean>, String, CancellationToken)	Gets the sensitivity labels of a given database Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels. Operation Id. : Databases_ListCurrentByDatabase. Resource. : SqlDatabaseResource.
GetCurrentSensitivityLabelsAsync(String, Nullable<Boolean>, String, CancellationToken)	Gets the sensitivity labels of a given database Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels. Operation Id. : Databases_ListCurrentByDatabase. Resource. : SqlDatabaseResource.
GetDatabaseAdvancedThreatProtection(AdvancedThreatProtectionName, CancellationToken)	Gets a database's Advanced Threat Protection state.
GetDatabaseAdvancedThreatProtectionAsync(AdvancedThreatProtectionName, CancellationToken)	Gets a database's Advanced Threat Protection state.
GetDatabaseAdvancedThreatProtections()	Gets a collection of DatabaseAdvancedThreatProtections in the SqlDatabaseResource.
GetDatabaseColumns(IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, String, CancellationToken)	List database columns Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/columns. Operation Id. : Databases_ListByDatabase. Resource. : SqlDatabaseResource.
GetDatabaseColumnsAsync(IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, String, CancellationToken)	List database columns Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/columns. Operation Id. : Databases_ListByDatabase. Resource. : SqlDatabaseResource.
GetDatabaseExtensions(CancellationToken)	List database extension. This will return an empty list as it is not supported. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions. Operation Id. : ImportExportExtensionsOperationResults_ListByDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetDatabaseExtensionsAsync(CancellationToken)	List database extension. This will return an empty list as it is not supported. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions. Operation Id. : ImportExportExtensionsOperationResults_ListByDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetDatabaseOperations(CancellationToken)	Gets a list of operations performed on the database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations. Operation Id. : Databases_DatabaseOperationsListByDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetDatabaseOperationsAsync(CancellationToken)	Gets a list of operations performed on the database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations. Operation Id. : Databases_DatabaseOperationsListByDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetDatabaseUsages(CancellationToken)	Gets database usages. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/usages. Operation Id. : Databases_DatabaseUsagesListByDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetDatabaseUsagesAsync(CancellationToken)	Gets database usages. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/usages. Operation Id. : Databases_DatabaseUsagesListByDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetDataMaskingPolicies()	Gets a collection of DataMaskingPolicies in the SqlDatabaseResource.
GetDataMaskingPolicy(DataMaskingPolicyName, CancellationToken)	Gets the database data masking policy.
GetDataMaskingPolicyAsync(DataMaskingPolicyName, CancellationToken)	Gets the database data masking policy.
GetDataWarehouseUserActivities()	Gets a collection of DataWarehouseUserActivities in the SqlDatabaseResource.
GetDataWarehouseUserActivity(DataWarehouseUserActivityName, CancellationToken)	Gets the user activities of a data warehouse which includes running and suspended queries.
GetDataWarehouseUserActivityAsync(DataWarehouseUserActivityName, CancellationToken)	Gets the user activities of a data warehouse which includes running and suspended queries.
GetExtendedDatabaseBlobAuditingPolicies()	Gets a collection of ExtendedDatabaseBlobAuditingPolicies in the SqlDatabaseResource.
GetExtendedDatabaseBlobAuditingPolicy(BlobAuditingPolicyName, CancellationToken)	Gets an extended database's blob auditing policy.
GetExtendedDatabaseBlobAuditingPolicyAsync(BlobAuditingPolicyName, CancellationToken)	Gets an extended database's blob auditing policy.
GetGeoBackupPolicies()	Gets a collection of GeoBackupPolicies in the SqlDatabaseResource.
GetGeoBackupPolicy(GeoBackupPolicyName, CancellationToken)	Gets a Geo backup policy for the given database resource.
GetGeoBackupPolicyAsync(GeoBackupPolicyName, CancellationToken)	Gets a Geo backup policy for the given database resource.
GetLedgerDigestUpload(LedgerDigestUploadsName, CancellationToken)	Gets the current ledger digest upload configuration for a database.
GetLedgerDigestUploadAsync(LedgerDigestUploadsName, CancellationToken)	Gets the current ledger digest upload configuration for a database.
GetLedgerDigestUploads()	Gets a collection of LedgerDigestUploads in the SqlDatabaseResource.
GetLogicalDatabaseTransparentDataEncryption(TransparentDataEncryptionName, CancellationToken)	Gets a logical database's transparent data encryption.
GetLogicalDatabaseTransparentDataEncryptionAsync(TransparentDataEncryptionName, CancellationToken)	Gets a logical database's transparent data encryption.
GetLogicalDatabaseTransparentDataEncryptions()	Gets a collection of LogicalDatabaseTransparentDataEncryptions in the SqlDatabaseResource.
GetLongTermRetentionPolicies()	Gets a collection of LongTermRetentionPolicies in the SqlDatabaseResource.
GetLongTermRetentionPolicy(LongTermRetentionPolicyName, CancellationToken)	Gets a database's long term retention policy.
GetLongTermRetentionPolicyAsync(LongTermRetentionPolicyName, CancellationToken)	Gets a database's long term retention policy.
GetMaintenanceWindowOption()	Gets an object representing a MaintenanceWindowOptionResource along with the instance operations that can be performed on it in the SqlDatabaseResource.
GetMaintenanceWindows()	Gets an object representing a MaintenanceWindowsResource along with the instance operations that can be performed on it in the SqlDatabaseResource.
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetRecommendedSensitivityLabels(String, Nullable<Boolean>, String, CancellationToken)	Gets the sensitivity labels of a given database Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels. Operation Id. : Databases_ListRecommendedByDatabase. Resource. : SqlDatabaseResource.
GetRecommendedSensitivityLabelsAsync(String, Nullable<Boolean>, String, CancellationToken)	Gets the sensitivity labels of a given database Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels. Operation Id. : Databases_ListRecommendedByDatabase. Resource. : SqlDatabaseResource.
GetSensitivityLabels(String, CancellationToken)	Gets the sensitivity labels of a given database Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sensitivityLabels. Operation Id. : Databases_SensitivityLabelsListByDatabase. Resource. : SqlDatabaseResource.
GetSensitivityLabelsAsync(String, CancellationToken)	Gets the sensitivity labels of a given database Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sensitivityLabels. Operation Id. : Databases_SensitivityLabelsListByDatabase. Resource. : SqlDatabaseResource.
GetSqlDatabaseAdvisor(String, CancellationToken)	Gets a database advisor.
GetSqlDatabaseAdvisorAsync(String, CancellationToken)	Gets a database advisor.
GetSqlDatabaseAdvisors()	Gets a collection of SqlDatabaseAdvisors in the SqlDatabaseResource.
GetSqlDatabaseAutomaticTuning()	Gets an object representing a SqlDatabaseAutomaticTuningResource along with the instance operations that can be performed on it in the SqlDatabaseResource.
GetSqlDatabaseBlobAuditingPolicies()	Gets a collection of SqlDatabaseBlobAuditingPolicies in the SqlDatabaseResource.
GetSqlDatabaseBlobAuditingPolicy(BlobAuditingPolicyName, CancellationToken)	Gets a database's blob auditing policy.
GetSqlDatabaseBlobAuditingPolicyAsync(BlobAuditingPolicyName, CancellationToken)	Gets a database's blob auditing policy.
GetSqlDatabaseSchema(String, CancellationToken)	Get database schema.
GetSqlDatabaseSchemaAsync(String, CancellationToken)	Get database schema.
GetSqlDatabaseSchemas()	Gets a collection of SqlDatabaseSchemas in the SqlDatabaseResource.
GetSqlDatabaseSecurityAlertPolicies()	Gets a collection of SqlDatabaseSecurityAlertPolicies in the SqlDatabaseResource.
GetSqlDatabaseSecurityAlertPolicy(SqlSecurityAlertPolicyName, CancellationToken)	Gets a database's security alert policy.
GetSqlDatabaseSecurityAlertPolicyAsync(SqlSecurityAlertPolicyName, CancellationToken)	Gets a database's security alert policy.
GetSqlDatabaseSqlVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken)	Gets SQL Vulnerability Assessment policy for database.
GetSqlDatabaseSqlVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken)	Gets SQL Vulnerability Assessment policy for database.
GetSqlDatabaseSqlVulnerabilityAssessments()	Gets a collection of SqlDatabaseSqlVulnerabilityAssessments in the SqlDatabaseResource.
GetSqlDatabaseVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken)	Gets the database's vulnerability assessment.
GetSqlDatabaseVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken)	Gets the database's vulnerability assessment.
GetSqlDatabaseVulnerabilityAssessments()	Gets a collection of SqlDatabaseVulnerabilityAssessments in the SqlDatabaseResource.
GetSqlServerDatabaseReplicationLink(String, CancellationToken)	Gets a replication link.
GetSqlServerDatabaseReplicationLinkAsync(String, CancellationToken)	Gets a replication link.
GetSqlServerDatabaseReplicationLinks()	Gets a collection of SqlServerDatabaseReplicationLinks in the SqlDatabaseResource.
GetSqlServerDatabaseRestorePoint(String, CancellationToken)	Gets a restore point.
GetSqlServerDatabaseRestorePointAsync(String, CancellationToken)	Gets a restore point.
GetSqlServerDatabaseRestorePoints()	Gets a collection of SqlServerDatabaseRestorePoints in the SqlDatabaseResource.
GetSynapseLinkWorkspaces(CancellationToken)	Gets all synapselink workspaces for a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/linkWorkspaces. Operation Id. : Databases_SynapseLinkWorkspacesListByDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetSynapseLinkWorkspacesAsync(CancellationToken)	Gets all synapselink workspaces for a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/linkWorkspaces. Operation Id. : Databases_SynapseLinkWorkspacesListByDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
GetSyncGroup(String, CancellationToken)	Gets a sync group.
GetSyncGroupAsync(String, CancellationToken)	Gets a sync group.
GetSyncGroups()	Gets a collection of SyncGroups in the SqlDatabaseResource.
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
GetWorkloadGroup(String, CancellationToken)	Gets a workload group.
GetWorkloadGroupAsync(String, CancellationToken)	Gets a workload group.
GetWorkloadGroups()	Gets a collection of WorkloadGroups in the SqlDatabaseResource.
Import(WaitUntil, ImportExistingDatabaseDefinition, CancellationToken)	Imports a bacpac into a new database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/import. Operation Id. : Databases_ImportDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
ImportAsync(WaitUntil, ImportExistingDatabaseDefinition, CancellationToken)	Imports a bacpac into a new database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/import. Operation Id. : Databases_ImportDatabase. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
Pause(WaitUntil, CancellationToken)	Pauses a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/pause. Operation Id. : Databases_Pause. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
PauseAsync(WaitUntil, CancellationToken)	Pauses a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/pause. Operation Id. : Databases_Pause. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource.
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource.
Rename(SqlResourceMoveDefinition, CancellationToken)	Renames a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/move. Operation Id. : Databases_Rename. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
RenameAsync(SqlResourceMoveDefinition, CancellationToken)	Renames a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/move. Operation Id. : Databases_Rename. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
Resume(WaitUntil, CancellationToken)	Resumes a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/resume. Operation Id. : Databases_Resume. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
ResumeAsync(WaitUntil, CancellationToken)	Resumes a database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/resume. Operation Id. : Databases_Resume. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
RevalidateDatabaseEncryptionProtector(WaitUntil, EncryptionProtectorName, CancellationToken)	Revalidates an existing encryption protector for a particular database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/encryptionProtector/{encryptionProtectorName}/revalidate. Operation Id. : Databases_Revalidate. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
RevalidateDatabaseEncryptionProtectorAsync(WaitUntil, EncryptionProtectorName, CancellationToken)	Revalidates an existing encryption protector for a particular database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/encryptionProtector/{encryptionProtectorName}/revalidate. Operation Id. : Databases_Revalidate. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
RevertDatabaseEncryptionProtector(WaitUntil, EncryptionProtectorName, CancellationToken)	Reverts an existing encryption protector for a particular database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/encryptionProtector/{encryptionProtectorName}/revert. Operation Id. : Databases_Revert. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
RevertDatabaseEncryptionProtectorAsync(WaitUntil, EncryptionProtectorName, CancellationToken)	Reverts an existing encryption protector for a particular database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/encryptionProtector/{encryptionProtectorName}/revert. Operation Id. : Databases_Revert. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set.
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set.
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, SqlDatabasePatch, CancellationToken)	Updates an existing database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}. Operation Id. : Databases_Update. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
UpdateAsync(WaitUntil, SqlDatabasePatch, CancellationToken)	Updates an existing database. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}. Operation Id. : Databases_Update. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
UpdateRecommendedSensitivityLabel(RecommendedSensitivityLabelUpdateList, CancellationToken)	Update recommended sensitivity labels states of a given database using an operations batch. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels. Operation Id. : Databases_RecommendedSensitivityLabelsUpdate. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
UpdateRecommendedSensitivityLabelAsync(RecommendedSensitivityLabelUpdateList, CancellationToken)	Update recommended sensitivity labels states of a given database using an operations batch. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels. Operation Id. : Databases_RecommendedSensitivityLabelsUpdate. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
UpdateSensitivityLabel(SensitivityLabelUpdateList, CancellationToken)	Update sensitivity labels of a given database using an operations batch. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels. Operation Id. : Databases_SensitivityLabelsUpdate. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
UpdateSensitivityLabelAsync(SensitivityLabelUpdateList, CancellationToken)	Update sensitivity labels of a given database using an operations batch. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels. Operation Id. : Databases_SensitivityLabelsUpdate. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
UpgradeDataWarehouse(WaitUntil, CancellationToken)	Upgrades a data warehouse. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/upgradeDataWarehouse. Operation Id. : Databases_UpgradeDataWarehouse. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.
UpgradeDataWarehouseAsync(WaitUntil, CancellationToken)	Upgrades a data warehouse. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/upgradeDataWarehouse. Operation Id. : Databases_UpgradeDataWarehouse. Default Api Version. : 2025-08-01-preview. Resource. : SqlDatabaseResource.

Explicit Interface Implementations

Name	Description
IJsonModel<SqlDatabaseData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<SqlDatabaseData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<SqlDatabaseData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<SqlDatabaseData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<SqlDatabaseData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentCollection objects within the specified scope.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to

Feedback

Was this page helpful?