SqlDatabaseResource Class

Definition

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
SqlDatabaseResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
  • Operation Id: Databases_Get
  • Default Api Version: 2023-02-01-preview
  • Resource: SqlDatabaseResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
  • Operation Id: Databases_Get
  • Default Api Version: 2023-02-01-preview
  • Resource: SqlDatabaseResource
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: DatabaseOperations_Cancel
  • Default Api Version: 2022-11-01-preview
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: DatabaseOperations_Cancel
  • Default Api Version: 2022-11-01-preview
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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/{extensionName}
  • Operation Id: DatabaseExtensions_CreateOrUpdate
  • Default Api Version: 2021-02-01-preview
CreateOrUpdateDatabaseExtensionAsync(WaitUntil, String, SqlDatabaseExtension, CancellationToken)

Perform a database extension operation, like polybase import

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/{extensionName}
  • Operation Id: DatabaseExtensions_CreateOrUpdate
  • Default Api Version: 2021-02-01-preview
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints
  • Operation Id: RestorePoints_Create
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlServerDatabaseRestorePointResource
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: RestorePoints_Create
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlServerDatabaseRestorePointResource
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: 2023-02-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: 2023-02-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: 2023-02-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: 2023-02-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: 2023-02-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: 2023-02-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: 2023-02-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: 2023-02-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 BackupShortTermRetentionPolicyResources in the SqlDatabase.

GetBackupShortTermRetentionPolicy(ShortTermRetentionPolicyName, CancellationToken)

Gets a database's short term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}
  • Operation Id: BackupShortTermRetentionPolicies_Get
  • Default Api Version: 2021-02-01-preview
  • Resource: BackupShortTermRetentionPolicyResource
GetBackupShortTermRetentionPolicyAsync(ShortTermRetentionPolicyName, CancellationToken)

Gets a database's short term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}
  • Operation Id: BackupShortTermRetentionPolicies_Get
  • Default Api Version: 2021-02-01-preview
  • Resource: BackupShortTermRetentionPolicyResource
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: SensitivityLabels_ListCurrentByDatabase
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSensitivityLabelResource
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: SensitivityLabels_ListCurrentByDatabase
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSensitivityLabelResource
GetDatabaseAdvancedThreatProtection(AdvancedThreatProtectionName, CancellationToken)

Gets a database's Advanced Threat Protection state.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
  • Operation Id: DatabaseAdvancedThreatProtectionSettings_Get
  • Default Api Version: 2021-11-01-preview
  • Resource: DatabaseAdvancedThreatProtectionResource
GetDatabaseAdvancedThreatProtectionAsync(AdvancedThreatProtectionName, CancellationToken)

Gets a database's Advanced Threat Protection state.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
  • Operation Id: DatabaseAdvancedThreatProtectionSettings_Get
  • Default Api Version: 2021-11-01-preview
  • Resource: DatabaseAdvancedThreatProtectionResource
GetDatabaseAdvancedThreatProtections()

Gets a collection of DatabaseAdvancedThreatProtectionResources in the SqlDatabase.

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: DatabaseColumns_ListByDatabase
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseColumnResource
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: DatabaseColumns_ListByDatabase
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseColumnResource
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: DatabaseExtensions_ListByDatabase
  • Default Api Version: 2021-02-01-preview
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: DatabaseExtensions_ListByDatabase
  • Default Api Version: 2021-02-01-preview
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: DatabaseOperations_ListByDatabase
  • Default Api Version: 2022-11-01-preview
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: DatabaseOperations_ListByDatabase
  • Default Api Version: 2022-11-01-preview
GetDatabaseUsages(CancellationToken)

Gets database usages.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/usages
  • Operation Id: DatabaseUsages_ListByDatabase
  • Default Api Version: 2021-02-01-preview
GetDatabaseUsagesAsync(CancellationToken)

Gets database usages.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/usages
  • Operation Id: DatabaseUsages_ListByDatabase
  • Default Api Version: 2021-02-01-preview
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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataWarehouseUserActivities/{dataWarehouseUserActivityName}
  • Operation Id: DataWarehouseUserActivities_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: DataWarehouseUserActivityResource
GetDataWarehouseUserActivityAsync(DataWarehouseUserActivityName, CancellationToken)

Gets the user activities of a data warehouse which includes running and suspended queries

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataWarehouseUserActivities/{dataWarehouseUserActivityName}
  • Operation Id: DataWarehouseUserActivities_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: DataWarehouseUserActivityResource
GetExtendedDatabaseBlobAuditingPolicies()

Gets a collection of ExtendedDatabaseBlobAuditingPolicyResources in the SqlDatabase.

GetExtendedDatabaseBlobAuditingPolicy(BlobAuditingPolicyName, CancellationToken)

Gets an extended database's blob auditing policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extendedAuditingSettings/{blobAuditingPolicyName}
  • Operation Id: ExtendedDatabaseBlobAuditingPolicies_Get
  • Default Api Version: 2021-11-01-preview
  • Resource: ExtendedDatabaseBlobAuditingPolicyResource
GetExtendedDatabaseBlobAuditingPolicyAsync(BlobAuditingPolicyName, CancellationToken)

Gets an extended database's blob auditing policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extendedAuditingSettings/{blobAuditingPolicyName}
  • Operation Id: ExtendedDatabaseBlobAuditingPolicies_Get
  • Default Api Version: 2021-11-01-preview
  • Resource: ExtendedDatabaseBlobAuditingPolicyResource
GetGeoBackupPolicies()

Gets a collection of GeoBackupPolicyResources in the SqlDatabase.

GetGeoBackupPolicy(GeoBackupPolicyName, CancellationToken)

Gets a geo backup policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/geoBackupPolicies/{geoBackupPolicyName}
  • Operation Id: GeoBackupPolicies_Get
  • Default Api Version: 2014-04-01
  • Resource: GeoBackupPolicyResource
GetGeoBackupPolicyAsync(GeoBackupPolicyName, CancellationToken)

Gets a geo backup policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/geoBackupPolicies/{geoBackupPolicyName}
  • Operation Id: GeoBackupPolicies_Get
  • Default Api Version: 2014-04-01
  • Resource: GeoBackupPolicyResource
GetLedgerDigestUpload(LedgerDigestUploadsName, CancellationToken)

Gets the current ledger digest upload configuration for a database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}
  • Operation Id: LedgerDigestUploads_Get
  • Default Api Version: 2021-02-01-preview
  • Resource: LedgerDigestUploadResource
GetLedgerDigestUploadAsync(LedgerDigestUploadsName, CancellationToken)

Gets the current ledger digest upload configuration for a database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}
  • Operation Id: LedgerDigestUploads_Get
  • Default Api Version: 2021-02-01-preview
  • Resource: LedgerDigestUploadResource
GetLedgerDigestUploads()

Gets a collection of LedgerDigestUploadResources in the SqlDatabase.

GetLogicalDatabaseTransparentDataEncryption(TransparentDataEncryptionName, CancellationToken)

Gets a logical database's transparent data encryption.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/{tdeName}
  • Operation Id: TransparentDataEncryptions_Get
  • Default Api Version: 2022-08-01-preview
  • Resource: LogicalDatabaseTransparentDataEncryptionResource
GetLogicalDatabaseTransparentDataEncryptionAsync(TransparentDataEncryptionName, CancellationToken)

Gets a logical database's transparent data encryption.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/{tdeName}
  • Operation Id: TransparentDataEncryptions_Get
  • Default Api Version: 2022-08-01-preview
  • Resource: LogicalDatabaseTransparentDataEncryptionResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
GetLongTermRetentionPolicyAsync(LongTermRetentionPolicyName, CancellationToken)

Gets a database's long term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
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.

  • 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)
GetMetricDefinitions(CancellationToken)

Returns database metric definitions.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/metricDefinitions
  • Operation Id: MetricDefinitions_ListDatabase
  • Default Api Version: 2014-04-01
GetMetricDefinitionsAsync(CancellationToken)

Returns database metric definitions.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/metricDefinitions
  • Operation Id: MetricDefinitions_ListDatabase
  • Default Api Version: 2014-04-01
GetMetrics(String, CancellationToken)

Returns database metrics.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/metrics
  • Operation Id: Metrics_ListDatabase
  • Default Api Version: 2014-04-01
GetMetricsAsync(String, CancellationToken)

Returns database metrics.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/metrics
  • Operation Id: Metrics_ListDatabase
  • Default Api Version: 2014-04-01
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: SensitivityLabels_ListRecommendedByDatabase
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSensitivityLabelResource
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: SensitivityLabels_ListRecommendedByDatabase
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSensitivityLabelResource
GetSqlDatabaseAdvisor(String, CancellationToken)

Gets a database advisor.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}
  • Operation Id: DatabaseAdvisors_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseAdvisorResource
GetSqlDatabaseAdvisorAsync(String, CancellationToken)

Gets a database advisor.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}
  • Operation Id: DatabaseAdvisors_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseAdvisorResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings/{blobAuditingPolicyName}
  • Operation Id: DatabaseBlobAuditingPolicies_Get
  • Default Api Version: 2021-11-01-preview
  • Resource: SqlDatabaseBlobAuditingPolicyResource
GetSqlDatabaseBlobAuditingPolicyAsync(BlobAuditingPolicyName, CancellationToken)

Gets a database's blob auditing policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings/{blobAuditingPolicyName}
  • Operation Id: DatabaseBlobAuditingPolicies_Get
  • Default Api Version: 2021-11-01-preview
  • Resource: SqlDatabaseBlobAuditingPolicyResource
GetSqlDatabaseSchema(String, CancellationToken)

Get database schema

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}
  • Operation Id: DatabaseSchemas_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSchemaResource
GetSqlDatabaseSchemaAsync(String, CancellationToken)

Get database schema

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}
  • Operation Id: DatabaseSchemas_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSchemaResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}
  • Operation Id: DatabaseSecurityAlertPolicies_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSecurityAlertPolicyResource
GetSqlDatabaseSecurityAlertPolicyAsync(SqlSecurityAlertPolicyName, CancellationToken)

Gets a database's security alert policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}
  • Operation Id: DatabaseSecurityAlertPolicies_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSecurityAlertPolicyResource
GetSqlDatabaseSqlVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken)

Gets SQL Vulnerability Assessment policy for database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}
  • Operation Id: DatabaseSqlVulnerabilityAssessmentsSettings_Get
  • Default Api Version: 2022-11-01-preview
  • Resource: SqlDatabaseSqlVulnerabilityAssessmentResource
GetSqlDatabaseSqlVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken)

Gets SQL Vulnerability Assessment policy for database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}
  • Operation Id: DatabaseSqlVulnerabilityAssessmentsSettings_Get
  • Default Api Version: 2022-11-01-preview
  • Resource: SqlDatabaseSqlVulnerabilityAssessmentResource
GetSqlDatabaseSqlVulnerabilityAssessments()

Gets a collection of SqlDatabaseSqlVulnerabilityAssessmentResources in the SqlDatabase.

GetSqlDatabaseVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken)

Gets the database's vulnerability assessment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
  • Operation Id: DatabaseVulnerabilityAssessments_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseVulnerabilityAssessmentResource
GetSqlDatabaseVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken)

Gets the database's vulnerability assessment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
  • Operation Id: DatabaseVulnerabilityAssessments_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseVulnerabilityAssessmentResource
GetSqlDatabaseVulnerabilityAssessments()

Gets a collection of SqlDatabaseVulnerabilityAssessmentResources in the SqlDatabase.

GetSqlServerDatabaseReplicationLink(String, CancellationToken)

Gets a replication link.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}
  • Operation Id: ReplicationLinks_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: SqlServerDatabaseReplicationLinkResource
GetSqlServerDatabaseReplicationLinkAsync(String, CancellationToken)

Gets a replication link.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}
  • Operation Id: ReplicationLinks_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: SqlServerDatabaseReplicationLinkResource
GetSqlServerDatabaseReplicationLinks()

Gets a collection of SqlServerDatabaseReplicationLinkResources in the SqlDatabase.

GetSqlServerDatabaseRestorePoint(String, CancellationToken)

Gets a restore point.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints/{restorePointName}
  • Operation Id: RestorePoints_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlServerDatabaseRestorePointResource
GetSqlServerDatabaseRestorePointAsync(String, CancellationToken)

Gets a restore point.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints/{restorePointName}
  • Operation Id: RestorePoints_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlServerDatabaseRestorePointResource
GetSqlServerDatabaseRestorePoints()

Gets a collection of SqlServerDatabaseRestorePointResources in the SqlDatabase.

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: SynapseLinkWorkspaces_ListByDatabase
  • Default Api Version: 2022-05-01-preview
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: SynapseLinkWorkspaces_ListByDatabase
  • Default Api Version: 2022-05-01-preview
GetSyncGroup(String, CancellationToken)

Gets a sync group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
  • Operation Id: SyncGroups_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SyncGroupResource
GetSyncGroupAsync(String, CancellationToken)

Gets a sync group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
  • Operation Id: SyncGroups_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SyncGroupResource
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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}
  • Operation Id: WorkloadGroups_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: WorkloadGroupResource
GetWorkloadGroupAsync(String, CancellationToken)

Gets a workload group

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}
  • Operation Id: WorkloadGroups_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: WorkloadGroupResource
GetWorkloadGroups()

Gets a collection of WorkloadGroupResources in the SqlDatabase.

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_Import
  • Default Api Version: 2023-02-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_Import
  • Default Api Version: 2023-02-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: 2023-02-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: 2023-02-01-preview
  • Resource: SqlDatabaseResource
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
  • Operation Id: Databases_Get
  • Default Api Version: 2023-02-01-preview
  • Resource: SqlDatabaseResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
  • Operation Id: Databases_Get
  • Default Api Version: 2023-02-01-preview
  • Resource: SqlDatabaseResource
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: 2023-02-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: 2023-02-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: 2023-02-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: 2023-02-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: DatabaseEncryptionProtectors_Revalidate
  • Default Api Version: 2022-08-01-preview
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: DatabaseEncryptionProtectors_Revalidate
  • Default Api Version: 2022-08-01-preview
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: DatabaseEncryptionProtectors_Revert
  • Default Api Version: 2022-08-01-preview
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: DatabaseEncryptionProtectors_Revert
  • Default Api Version: 2022-08-01-preview
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
  • Operation Id: Databases_Get
  • Default Api Version: 2023-02-01-preview
  • Resource: SqlDatabaseResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
  • Operation Id: Databases_Get
  • Default Api Version: 2023-02-01-preview
  • Resource: SqlDatabaseResource
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: 2023-02-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: 2023-02-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: SensitivityLabels_UpdateRecommended
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSensitivityLabelResource
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: SensitivityLabels_UpdateRecommended
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSensitivityLabelResource
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: SensitivityLabels_Update
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSensitivityLabelResource
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: SensitivityLabels_Update
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlDatabaseSensitivityLabelResource
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: 2023-02-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: 2023-02-01-preview
  • Resource: SqlDatabaseResource

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).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
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.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to