SqlDatabaseResource Class
Definition
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 GetSqlDatabaseResource method. Otherwise you can get one from its parent resource SqlServerResource using the GetSqlDatabase method.
public class SqlDatabaseResource : Azure.ResourceManager.ArmResource
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
type SqlDatabaseResource = class
inherit ArmResource
interface IJsonModel<SqlDatabaseData>
interface IPersistableModel<SqlDatabaseData>
Public Class SqlDatabaseResource
Inherits ArmResource
Public Class SqlDatabaseResource
Inherits ArmResource
Implements IJsonModel(Of SqlDatabaseData), IPersistableModel(Of SqlDatabaseData)
- Inheritance
- Implements
Constructors
SqlDatabaseResource() |
Initializes a new instance of the SqlDatabaseResource class for mocking. |
Fields
ResourceType |
Gets the resource type for the operations. |
Properties
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
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.
|
CancelDatabaseOperationAsync(Guid, CancellationToken) |
Cancels the asynchronous operation on the database.
|
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 polybase import
|
CreateOrUpdateDatabaseExtensionAsync(WaitUntil, String, SqlDatabaseExtension, CancellationToken) |
Perform a database extension operation, like polybase import
|
CreateResourceIdentifier(String, String, String, String) |
Generate the resource identifier of a SqlDatabaseResource instance. |
CreateRestorePoint(WaitUntil, CreateDatabaseRestorePointDefinition, CancellationToken) |
Creates a restore point for a data warehouse.
|
CreateRestorePointAsync(WaitUntil, CreateDatabaseRestorePointDefinition, CancellationToken) |
Creates a restore point for a data warehouse.
|
Delete(WaitUntil, CancellationToken) |
Deletes the database.
|
DeleteAsync(WaitUntil, CancellationToken) |
Deletes the database.
|
Export(WaitUntil, DatabaseExportDefinition, CancellationToken) |
Exports a database.
|
ExportAsync(WaitUntil, DatabaseExportDefinition, CancellationToken) |
Exports a database.
|
Failover(WaitUntil, Nullable<ReplicaType>, CancellationToken) |
Failovers a database.
|
FailoverAsync(WaitUntil, Nullable<ReplicaType>, CancellationToken) |
Failovers a database.
|
Get(String, String, CancellationToken) |
Gets a database.
|
GetAsync(String, String, CancellationToken) |
Gets a database.
|
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 BackupShortTermRetentionPolicyResources in the SqlDatabase. |
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
|
GetCurrentSensitivityLabelsAsync(String, Nullable<Boolean>, String, CancellationToken) |
Gets the sensitivity labels of a given database
|
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 DatabaseAdvancedThreatProtectionResources in the SqlDatabase. |
GetDatabaseColumns(IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, String, CancellationToken) |
List database columns
|
GetDatabaseColumnsAsync(IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, String, CancellationToken) |
List database columns
|
GetDatabaseExtensions(CancellationToken) |
List database extension. This will return an empty list as it is not supported.
|
GetDatabaseExtensionsAsync(CancellationToken) |
List database extension. This will return an empty list as it is not supported.
|
GetDatabaseOperations(CancellationToken) |
Gets a list of operations performed on the database.
|
GetDatabaseOperationsAsync(CancellationToken) |
Gets a list of operations performed on the database.
|
GetDatabaseUsages(CancellationToken) |
Gets database usages.
|
GetDatabaseUsagesAsync(CancellationToken) |
Gets database usages.
|
GetDataMaskingPolicy() |
Gets an object representing a DataMaskingPolicyResource along with the instance operations that can be performed on it in the SqlDatabase. |
GetDataWarehouseUserActivities() |
Gets a collection of DataWarehouseUserActivityResources in the SqlDatabase. |
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 ExtendedDatabaseBlobAuditingPolicyResources in the SqlDatabase. |
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 GeoBackupPolicyResources in the SqlDatabase. |
GetGeoBackupPolicy(GeoBackupPolicyName, CancellationToken) |
Gets a geo backup policy.
|
GetGeoBackupPolicyAsync(GeoBackupPolicyName, CancellationToken) |
Gets a geo backup policy.
|
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 LedgerDigestUploadResources in the SqlDatabase. |
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 LogicalDatabaseTransparentDataEncryptionResources in the SqlDatabase. |
GetLongTermRetentionPolicies() |
Gets a collection of LongTermRetentionPolicyResources in the SqlDatabase. |
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 SqlDatabase. |
GetMaintenanceWindows() |
Gets an object representing a MaintenanceWindowsResource along with the instance operations that can be performed on it in the SqlDatabase. |
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
GetMetricDefinitions(CancellationToken) |
Returns database metric definitions.
|
GetMetricDefinitionsAsync(CancellationToken) |
Returns database metric definitions.
|
GetMetrics(String, CancellationToken) |
Returns database metrics.
|
GetMetricsAsync(String, CancellationToken) |
Returns database metrics.
|
GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
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
|
GetRecommendedSensitivityLabelsAsync(String, Nullable<Boolean>, String, CancellationToken) |
Gets the sensitivity labels of a given database
|
GetSqlDatabaseAdvisor(String, CancellationToken) |
Gets a database advisor.
|
GetSqlDatabaseAdvisorAsync(String, CancellationToken) |
Gets a database advisor.
|
GetSqlDatabaseAdvisors() |
Gets a collection of SqlDatabaseAdvisorResources in the SqlDatabase. |
GetSqlDatabaseAutomaticTuning() |
Gets an object representing a SqlDatabaseAutomaticTuningResource along with the instance operations that can be performed on it in the SqlDatabase. |
GetSqlDatabaseBlobAuditingPolicies() |
Gets a collection of SqlDatabaseBlobAuditingPolicyResources in the SqlDatabase. |
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 SqlDatabaseSchemaResources in the SqlDatabase. |
GetSqlDatabaseSecurityAlertPolicies() |
Gets a collection of SqlDatabaseSecurityAlertPolicyResources in the SqlDatabase. |
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 SqlDatabaseSqlVulnerabilityAssessmentResources in the SqlDatabase. |
GetSqlDatabaseVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken) |
Gets the database's vulnerability assessment.
|
GetSqlDatabaseVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken) |
Gets the database's vulnerability assessment.
|
GetSqlDatabaseVulnerabilityAssessments() |
Gets a collection of SqlDatabaseVulnerabilityAssessmentResources in the SqlDatabase. |
GetSqlServerDatabaseReplicationLink(String, CancellationToken) |
Gets a replication link.
|
GetSqlServerDatabaseReplicationLinkAsync(String, CancellationToken) |
Gets a replication link.
|
GetSqlServerDatabaseReplicationLinks() |
Gets a collection of SqlServerDatabaseReplicationLinkResources in the SqlDatabase. |
GetSqlServerDatabaseRestorePoint(String, CancellationToken) |
Gets a restore point.
|
GetSqlServerDatabaseRestorePointAsync(String, CancellationToken) |
Gets a restore point.
|
GetSqlServerDatabaseRestorePoints() |
Gets a collection of SqlServerDatabaseRestorePointResources in the SqlDatabase. |
GetSynapseLinkWorkspaces(CancellationToken) |
Gets all synapselink workspaces for a database.
|
GetSynapseLinkWorkspacesAsync(CancellationToken) |
Gets all synapselink workspaces for a database.
|
GetSyncGroup(String, CancellationToken) |
Gets a sync group.
|
GetSyncGroupAsync(String, CancellationToken) |
Gets a sync group.
|
GetSyncGroups() |
Gets a collection of SyncGroupResources in the SqlDatabase. |
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 WorkloadGroupResources in the SqlDatabase. |
Import(WaitUntil, ImportExistingDatabaseDefinition, CancellationToken) |
Imports a bacpac into a new database.
|
ImportAsync(WaitUntil, ImportExistingDatabaseDefinition, CancellationToken) |
Imports a bacpac into a new database.
|
Pause(WaitUntil, CancellationToken) |
Pauses a database.
|
PauseAsync(WaitUntil, CancellationToken) |
Pauses a database.
|
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.
|
RenameAsync(SqlResourceMoveDefinition, CancellationToken) |
Renames a database.
|
Resume(WaitUntil, CancellationToken) |
Resumes a database.
|
ResumeAsync(WaitUntil, CancellationToken) |
Resumes a database.
|
RevalidateDatabaseEncryptionProtector(WaitUntil, EncryptionProtectorName, CancellationToken) |
Revalidates an existing encryption protector for a particular database.
|
RevalidateDatabaseEncryptionProtectorAsync(WaitUntil, EncryptionProtectorName, CancellationToken) |
Revalidates an existing encryption protector for a particular database.
|
RevertDatabaseEncryptionProtector(WaitUntil, EncryptionProtectorName, CancellationToken) |
Reverts an existing encryption protector for a particular database.
|
RevertDatabaseEncryptionProtectorAsync(WaitUntil, EncryptionProtectorName, CancellationToken) |
Reverts an existing encryption protector for a particular database.
|
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.
|
UpdateAsync(WaitUntil, SqlDatabasePatch, CancellationToken) |
Updates an existing database.
|
UpdateRecommendedSensitivityLabel(RecommendedSensitivityLabelUpdateList, CancellationToken) |
Update recommended sensitivity labels states of a given database using an operations batch.
|
UpdateRecommendedSensitivityLabelAsync(RecommendedSensitivityLabelUpdateList, CancellationToken) |
Update recommended sensitivity labels states of a given database using an operations batch.
|
UpdateSensitivityLabel(SensitivityLabelUpdateList, CancellationToken) |
Update sensitivity labels of a given database using an operations batch.
|
UpdateSensitivityLabelAsync(SensitivityLabelUpdateList, CancellationToken) |
Update sensitivity labels of a given database using an operations batch.
|
UpgradeDataWarehouse(WaitUntil, CancellationToken) |
Upgrades a data warehouse.
|
UpgradeDataWarehouseAsync(WaitUntil, CancellationToken) |
Upgrades a data warehouse.
|
Explicit Interface Implementations
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
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
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 RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
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 RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
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 RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
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 RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
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 RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
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 RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
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. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |