SqlManagementClient class

Extends

Constructors

SqlManagementClient(TokenCredential, string, SqlManagementClientOptionalParams)

Initializes a new instance of the SqlManagementClient class.

Properties

$host
backupShortTermRetentionPolicies
capabilities
databaseAdvancedThreatProtectionSettings
databaseAdvisors
databaseAutomaticTuningOperations
databaseBlobAuditingPolicies
databaseColumns
databaseEncryptionProtectors
databaseExtensionsOperations
databaseOperations
databaseRecommendedActions
databases
databaseSchemas
databaseSecurityAlertPolicies
databaseSqlVulnerabilityAssessmentBaselines
databaseSqlVulnerabilityAssessmentExecuteScan
databaseSqlVulnerabilityAssessmentRuleBaselines
databaseSqlVulnerabilityAssessmentScanResult
databaseSqlVulnerabilityAssessmentScans
databaseSqlVulnerabilityAssessmentsSettings
databaseTables
databaseUsages
databaseVulnerabilityAssessmentRuleBaselines
databaseVulnerabilityAssessments
databaseVulnerabilityAssessmentScans
dataMaskingPolicies
dataMaskingRules
dataWarehouseUserActivitiesOperations
deletedServers
distributedAvailabilityGroups
elasticPoolActivities
elasticPoolDatabaseActivities
elasticPoolOperations
elasticPools
encryptionProtectors
endpointCertificates
extendedDatabaseBlobAuditingPolicies
extendedServerBlobAuditingPolicies
failoverGroups
firewallRules
geoBackupPolicies
instanceFailoverGroups
instancePools
iPv6FirewallRules
jobAgents
jobCredentials
jobExecutions
jobs
jobStepExecutions
jobSteps
jobTargetExecutions
jobTargetGroups
jobVersions
ledgerDigestUploadsOperations
longTermRetentionBackups
longTermRetentionManagedInstanceBackups
longTermRetentionPolicies
maintenanceWindowOptionsOperations
maintenanceWindowsOperations
managedBackupShortTermRetentionPolicies
managedDatabaseAdvancedThreatProtectionSettings
managedDatabaseColumns
managedDatabaseMoveOperations
managedDatabaseQueries
managedDatabaseRecommendedSensitivityLabels
managedDatabaseRestoreDetails
managedDatabases
managedDatabaseSchemas
managedDatabaseSecurityAlertPolicies
managedDatabaseSecurityEvents
managedDatabaseSensitivityLabels
managedDatabaseTables
managedDatabaseTransparentDataEncryption
managedDatabaseVulnerabilityAssessmentRuleBaselines
managedDatabaseVulnerabilityAssessments
managedDatabaseVulnerabilityAssessmentScans
managedInstanceAdministrators
managedInstanceAdvancedThreatProtectionSettings
managedInstanceAzureADOnlyAuthentications
managedInstanceDtcs
managedInstanceEncryptionProtectors
managedInstanceKeys
managedInstanceLongTermRetentionPolicies
managedInstanceOperations
managedInstancePrivateEndpointConnections
managedInstancePrivateLinkResources
managedInstances
managedInstanceTdeCertificates
managedInstanceVulnerabilityAssessments
managedLedgerDigestUploadsOperations
managedRestorableDroppedDatabaseBackupShortTermRetentionPolicies
managedServerDnsAliases
managedServerSecurityAlertPolicies
operations
outboundFirewallRules
privateEndpointConnections
privateLinkResources
recommendedSensitivityLabels
recoverableDatabases
recoverableManagedDatabases
replicationLinks
restorableDroppedDatabases
restorableDroppedManagedDatabases
restorePoints
sensitivityLabels
serverAdvancedThreatProtectionSettings
serverAdvisors
serverAutomaticTuningOperations
serverAzureADAdministrators
serverAzureADOnlyAuthentications
serverBlobAuditingPolicies
serverCommunicationLinks
serverConfigurationOptions
serverConnectionPolicies
serverDevOpsAuditSettings
serverDnsAliases
serverKeys
serverOperations
servers
serverSecurityAlertPolicies
serverTrustCertificates
serverTrustGroups
serverUsages
serverVulnerabilityAssessments
serviceObjectives
sqlAgent
sqlVulnerabilityAssessmentBaseline
sqlVulnerabilityAssessmentBaselines
sqlVulnerabilityAssessmentExecuteScan
sqlVulnerabilityAssessmentRuleBaseline
sqlVulnerabilityAssessmentRuleBaselines
sqlVulnerabilityAssessments
sqlVulnerabilityAssessmentScanResult
sqlVulnerabilityAssessmentScans
sqlVulnerabilityAssessmentsSettings
startStopManagedInstanceSchedules
subscriptionId
subscriptionUsages
synapseLinkWorkspaces
syncAgents
syncGroups
syncMembers
tdeCertificates
timeZones
transparentDataEncryptions
usages
virtualClusters
virtualNetworkRules
workloadClassifiers
workloadGroups

Inherited Properties

pipeline

The pipeline used by this client to make requests

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

SqlManagementClient(TokenCredential, string, SqlManagementClientOptionalParams)

Initializes a new instance of the SqlManagementClient class.

new SqlManagementClient(credentials: TokenCredential, subscriptionId: string, options?: SqlManagementClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The subscription ID that identifies an Azure subscription.

options
SqlManagementClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

backupShortTermRetentionPolicies

backupShortTermRetentionPolicies: BackupShortTermRetentionPolicies

Property Value

capabilities

capabilities: Capabilities

Property Value

databaseAdvancedThreatProtectionSettings

databaseAdvancedThreatProtectionSettings: DatabaseAdvancedThreatProtectionSettings

Property Value

databaseAdvisors

databaseAdvisors: DatabaseAdvisors

Property Value

databaseAutomaticTuningOperations

databaseAutomaticTuningOperations: DatabaseAutomaticTuningOperations

Property Value

databaseBlobAuditingPolicies

databaseBlobAuditingPolicies: DatabaseBlobAuditingPolicies

Property Value

databaseColumns

databaseColumns: DatabaseColumns

Property Value

databaseEncryptionProtectors

databaseEncryptionProtectors: DatabaseEncryptionProtectors

Property Value

databaseExtensionsOperations

databaseExtensionsOperations: DatabaseExtensionsOperations

Property Value

databaseOperations

databaseOperations: DatabaseOperations

Property Value

databaseRecommendedActions

databaseRecommendedActions: DatabaseRecommendedActions

Property Value

databases

databases: Databases

Property Value

databaseSchemas

databaseSchemas: DatabaseSchemas

Property Value

databaseSecurityAlertPolicies

databaseSecurityAlertPolicies: DatabaseSecurityAlertPolicies

Property Value

databaseSqlVulnerabilityAssessmentBaselines

databaseSqlVulnerabilityAssessmentBaselines: DatabaseSqlVulnerabilityAssessmentBaselines

Property Value

databaseSqlVulnerabilityAssessmentExecuteScan

databaseSqlVulnerabilityAssessmentExecuteScan: DatabaseSqlVulnerabilityAssessmentExecuteScan

Property Value

databaseSqlVulnerabilityAssessmentRuleBaselines

databaseSqlVulnerabilityAssessmentRuleBaselines: DatabaseSqlVulnerabilityAssessmentRuleBaselines

Property Value

databaseSqlVulnerabilityAssessmentScanResult

databaseSqlVulnerabilityAssessmentScanResult: DatabaseSqlVulnerabilityAssessmentScanResult

Property Value

databaseSqlVulnerabilityAssessmentScans

databaseSqlVulnerabilityAssessmentScans: DatabaseSqlVulnerabilityAssessmentScans

Property Value

databaseSqlVulnerabilityAssessmentsSettings

databaseSqlVulnerabilityAssessmentsSettings: DatabaseSqlVulnerabilityAssessmentsSettings

Property Value

databaseTables

databaseTables: DatabaseTables

Property Value

databaseUsages

databaseUsages: DatabaseUsages

Property Value

databaseVulnerabilityAssessmentRuleBaselines

databaseVulnerabilityAssessmentRuleBaselines: DatabaseVulnerabilityAssessmentRuleBaselines

Property Value

databaseVulnerabilityAssessments

databaseVulnerabilityAssessments: DatabaseVulnerabilityAssessments

Property Value

databaseVulnerabilityAssessmentScans

databaseVulnerabilityAssessmentScans: DatabaseVulnerabilityAssessmentScans

Property Value

dataMaskingPolicies

dataMaskingPolicies: DataMaskingPolicies

Property Value

dataMaskingRules

dataMaskingRules: DataMaskingRules

Property Value

dataWarehouseUserActivitiesOperations

dataWarehouseUserActivitiesOperations: DataWarehouseUserActivitiesOperations

Property Value

deletedServers

deletedServers: DeletedServers

Property Value

distributedAvailabilityGroups

distributedAvailabilityGroups: DistributedAvailabilityGroups

Property Value

elasticPoolActivities

elasticPoolActivities: ElasticPoolActivities

Property Value

elasticPoolDatabaseActivities

elasticPoolDatabaseActivities: ElasticPoolDatabaseActivities

Property Value

elasticPoolOperations

elasticPoolOperations: ElasticPoolOperations

Property Value

elasticPools

elasticPools: ElasticPools

Property Value

encryptionProtectors

encryptionProtectors: EncryptionProtectors

Property Value

endpointCertificates

endpointCertificates: EndpointCertificates

Property Value

extendedDatabaseBlobAuditingPolicies

extendedDatabaseBlobAuditingPolicies: ExtendedDatabaseBlobAuditingPolicies

Property Value

extendedServerBlobAuditingPolicies

extendedServerBlobAuditingPolicies: ExtendedServerBlobAuditingPolicies

Property Value

failoverGroups

failoverGroups: FailoverGroups

Property Value

firewallRules

firewallRules: FirewallRules

Property Value

geoBackupPolicies

geoBackupPolicies: GeoBackupPolicies

Property Value

instanceFailoverGroups

instanceFailoverGroups: InstanceFailoverGroups

Property Value

instancePools

instancePools: InstancePools

Property Value

iPv6FirewallRules

iPv6FirewallRules: IPv6FirewallRules

Property Value

jobAgents

jobAgents: JobAgents

Property Value

jobCredentials

jobCredentials: JobCredentials

Property Value

jobExecutions

jobExecutions: JobExecutions

Property Value

jobs

jobs: Jobs

Property Value

jobStepExecutions

jobStepExecutions: JobStepExecutions

Property Value

jobSteps

jobSteps: JobSteps

Property Value

jobTargetExecutions

jobTargetExecutions: JobTargetExecutions

Property Value

jobTargetGroups

jobTargetGroups: JobTargetGroups

Property Value

jobVersions

jobVersions: JobVersions

Property Value

ledgerDigestUploadsOperations

ledgerDigestUploadsOperations: LedgerDigestUploadsOperations

Property Value

longTermRetentionBackups

longTermRetentionBackups: LongTermRetentionBackups

Property Value

longTermRetentionManagedInstanceBackups

longTermRetentionManagedInstanceBackups: LongTermRetentionManagedInstanceBackups

Property Value

longTermRetentionPolicies

longTermRetentionPolicies: LongTermRetentionPolicies

Property Value

maintenanceWindowOptionsOperations

maintenanceWindowOptionsOperations: MaintenanceWindowOptionsOperations

Property Value

maintenanceWindowsOperations

maintenanceWindowsOperations: MaintenanceWindowsOperations

Property Value

managedBackupShortTermRetentionPolicies

managedBackupShortTermRetentionPolicies: ManagedBackupShortTermRetentionPolicies

Property Value

managedDatabaseAdvancedThreatProtectionSettings

managedDatabaseAdvancedThreatProtectionSettings: ManagedDatabaseAdvancedThreatProtectionSettings

Property Value

managedDatabaseColumns

managedDatabaseColumns: ManagedDatabaseColumns

Property Value

managedDatabaseMoveOperations

managedDatabaseMoveOperations: ManagedDatabaseMoveOperations

Property Value

managedDatabaseQueries

managedDatabaseQueries: ManagedDatabaseQueries

Property Value

managedDatabaseRecommendedSensitivityLabels

managedDatabaseRecommendedSensitivityLabels: ManagedDatabaseRecommendedSensitivityLabels

Property Value

managedDatabaseRestoreDetails

managedDatabaseRestoreDetails: ManagedDatabaseRestoreDetails

Property Value

managedDatabases

managedDatabases: ManagedDatabases

Property Value

managedDatabaseSchemas

managedDatabaseSchemas: ManagedDatabaseSchemas

Property Value

managedDatabaseSecurityAlertPolicies

managedDatabaseSecurityAlertPolicies: ManagedDatabaseSecurityAlertPolicies

Property Value

managedDatabaseSecurityEvents

managedDatabaseSecurityEvents: ManagedDatabaseSecurityEvents

Property Value

managedDatabaseSensitivityLabels

managedDatabaseSensitivityLabels: ManagedDatabaseSensitivityLabels

Property Value

managedDatabaseTables

managedDatabaseTables: ManagedDatabaseTables

Property Value

managedDatabaseTransparentDataEncryption

managedDatabaseTransparentDataEncryption: ManagedDatabaseTransparentDataEncryption

Property Value

managedDatabaseVulnerabilityAssessmentRuleBaselines

managedDatabaseVulnerabilityAssessmentRuleBaselines: ManagedDatabaseVulnerabilityAssessmentRuleBaselines

Property Value

managedDatabaseVulnerabilityAssessments

managedDatabaseVulnerabilityAssessments: ManagedDatabaseVulnerabilityAssessments

Property Value

managedDatabaseVulnerabilityAssessmentScans

managedDatabaseVulnerabilityAssessmentScans: ManagedDatabaseVulnerabilityAssessmentScans

Property Value

managedInstanceAdministrators

managedInstanceAdministrators: ManagedInstanceAdministrators

Property Value

managedInstanceAdvancedThreatProtectionSettings

managedInstanceAdvancedThreatProtectionSettings: ManagedInstanceAdvancedThreatProtectionSettings

Property Value

managedInstanceAzureADOnlyAuthentications

managedInstanceAzureADOnlyAuthentications: ManagedInstanceAzureADOnlyAuthentications

Property Value

managedInstanceDtcs

managedInstanceDtcs: ManagedInstanceDtcs

Property Value

managedInstanceEncryptionProtectors

managedInstanceEncryptionProtectors: ManagedInstanceEncryptionProtectors

Property Value

managedInstanceKeys

managedInstanceKeys: ManagedInstanceKeys

Property Value

managedInstanceLongTermRetentionPolicies

managedInstanceLongTermRetentionPolicies: ManagedInstanceLongTermRetentionPolicies

Property Value

managedInstanceOperations

managedInstanceOperations: ManagedInstanceOperations

Property Value

managedInstancePrivateEndpointConnections

managedInstancePrivateEndpointConnections: ManagedInstancePrivateEndpointConnections

Property Value

managedInstancePrivateLinkResources

managedInstancePrivateLinkResources: ManagedInstancePrivateLinkResources

Property Value

managedInstances

managedInstances: ManagedInstances

Property Value

managedInstanceTdeCertificates

managedInstanceTdeCertificates: ManagedInstanceTdeCertificates

Property Value

managedInstanceVulnerabilityAssessments

managedInstanceVulnerabilityAssessments: ManagedInstanceVulnerabilityAssessments

Property Value

managedLedgerDigestUploadsOperations

managedLedgerDigestUploadsOperations: ManagedLedgerDigestUploadsOperations

Property Value

managedRestorableDroppedDatabaseBackupShortTermRetentionPolicies

managedRestorableDroppedDatabaseBackupShortTermRetentionPolicies: ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies

Property Value

managedServerDnsAliases

managedServerDnsAliases: ManagedServerDnsAliases

Property Value

managedServerSecurityAlertPolicies

managedServerSecurityAlertPolicies: ManagedServerSecurityAlertPolicies

Property Value

operations

operations: Operations

Property Value

outboundFirewallRules

outboundFirewallRules: OutboundFirewallRules

Property Value

privateEndpointConnections

privateEndpointConnections: PrivateEndpointConnections

Property Value

privateLinkResources

privateLinkResources: PrivateLinkResources

Property Value

recommendedSensitivityLabels

recommendedSensitivityLabels: RecommendedSensitivityLabels

Property Value

recoverableDatabases

recoverableDatabases: RecoverableDatabases

Property Value

recoverableManagedDatabases

recoverableManagedDatabases: RecoverableManagedDatabases

Property Value

replicationLinks: ReplicationLinks

Property Value

restorableDroppedDatabases

restorableDroppedDatabases: RestorableDroppedDatabases

Property Value

restorableDroppedManagedDatabases

restorableDroppedManagedDatabases: RestorableDroppedManagedDatabases

Property Value

restorePoints

restorePoints: RestorePoints

Property Value

sensitivityLabels

sensitivityLabels: SensitivityLabels

Property Value

serverAdvancedThreatProtectionSettings

serverAdvancedThreatProtectionSettings: ServerAdvancedThreatProtectionSettings

Property Value

serverAdvisors

serverAdvisors: ServerAdvisors

Property Value

serverAutomaticTuningOperations

serverAutomaticTuningOperations: ServerAutomaticTuningOperations

Property Value

serverAzureADAdministrators

serverAzureADAdministrators: ServerAzureADAdministrators

Property Value

serverAzureADOnlyAuthentications

serverAzureADOnlyAuthentications: ServerAzureADOnlyAuthentications

Property Value

serverBlobAuditingPolicies

serverBlobAuditingPolicies: ServerBlobAuditingPolicies

Property Value

serverCommunicationLinks: ServerCommunicationLinks

Property Value

serverConfigurationOptions

serverConfigurationOptions: ServerConfigurationOptions

Property Value

serverConnectionPolicies

serverConnectionPolicies: ServerConnectionPolicies

Property Value

serverDevOpsAuditSettings

serverDevOpsAuditSettings: ServerDevOpsAuditSettings

Property Value

serverDnsAliases

serverDnsAliases: ServerDnsAliases

Property Value

serverKeys

serverKeys: ServerKeys

Property Value

serverOperations

serverOperations: ServerOperations

Property Value

servers

servers: Servers

Property Value

serverSecurityAlertPolicies

serverSecurityAlertPolicies: ServerSecurityAlertPolicies

Property Value

serverTrustCertificates

serverTrustCertificates: ServerTrustCertificates

Property Value

serverTrustGroups

serverTrustGroups: ServerTrustGroups

Property Value

serverUsages

serverUsages: ServerUsages

Property Value

serverVulnerabilityAssessments

serverVulnerabilityAssessments: ServerVulnerabilityAssessments

Property Value

serviceObjectives

serviceObjectives: ServiceObjectives

Property Value

sqlAgent

sqlAgent: SqlAgent

Property Value

sqlVulnerabilityAssessmentBaseline

sqlVulnerabilityAssessmentBaseline: SqlVulnerabilityAssessmentBaseline

Property Value

sqlVulnerabilityAssessmentBaselines

sqlVulnerabilityAssessmentBaselines: SqlVulnerabilityAssessmentBaselines

Property Value

sqlVulnerabilityAssessmentExecuteScan

sqlVulnerabilityAssessmentExecuteScan: SqlVulnerabilityAssessmentExecuteScan

Property Value

sqlVulnerabilityAssessmentRuleBaseline

sqlVulnerabilityAssessmentRuleBaseline: SqlVulnerabilityAssessmentRuleBaseline

Property Value

sqlVulnerabilityAssessmentRuleBaselines

sqlVulnerabilityAssessmentRuleBaselines: SqlVulnerabilityAssessmentRuleBaselines

Property Value

sqlVulnerabilityAssessments

sqlVulnerabilityAssessments: SqlVulnerabilityAssessments

Property Value

sqlVulnerabilityAssessmentScanResult

sqlVulnerabilityAssessmentScanResult: SqlVulnerabilityAssessmentScanResult

Property Value

sqlVulnerabilityAssessmentScans

sqlVulnerabilityAssessmentScans: SqlVulnerabilityAssessmentScans

Property Value

sqlVulnerabilityAssessmentsSettings

sqlVulnerabilityAssessmentsSettings: SqlVulnerabilityAssessmentsSettings

Property Value

startStopManagedInstanceSchedules

startStopManagedInstanceSchedules: StartStopManagedInstanceSchedules

Property Value

subscriptionId

subscriptionId: string

Property Value

string

subscriptionUsages

subscriptionUsages: SubscriptionUsages

Property Value

synapseLinkWorkspaces

synapseLinkWorkspaces: SynapseLinkWorkspaces

Property Value

syncAgents

syncAgents: SyncAgents

Property Value

syncGroups

syncGroups: SyncGroups

Property Value

syncMembers

syncMembers: SyncMembers

Property Value

tdeCertificates

tdeCertificates: TdeCertificates

Property Value

timeZones

timeZones: TimeZones

Property Value

transparentDataEncryptions

transparentDataEncryptions: TransparentDataEncryptions

Property Value

usages

usages: Usages

Property Value

virtualClusters

virtualClusters: VirtualClusters

Property Value

virtualNetworkRules

virtualNetworkRules: VirtualNetworkRules

Property Value

workloadClassifiers

workloadClassifiers: WorkloadClassifiers

Property Value

workloadGroups

workloadGroups: WorkloadGroups

Property Value

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Inherited From coreClient.ServiceClient.pipeline

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest