Share via

SynapseManagementClient class

  • Reference
Package:
@azure/arm-synapse
Extends
ServiceClient

Constructors

SynapseManagementClient(TokenCredential, string, SynapseManagementClientOptionalParams)

Initializes a new instance of the SynapseManagementClient class.

Properties

$host
azureADOnlyAuthentications
bigDataPools
dataMaskingPolicies
dataMaskingRules
extendedSqlPoolBlobAuditingPolicies
integrationRuntimeAuthKeysOperations
integrationRuntimeConnectionInfos
integrationRuntimeCredentials
integrationRuntimeMonitoringDataOperations
integrationRuntimeNodeIpAddressOperations
integrationRuntimeNodes
integrationRuntimeObjectMetadata
integrationRuntimes
integrationRuntimeStatusOperations
ipFirewallRules
keys
kustoOperations
kustoPoolAttachedDatabaseConfigurations
kustoPoolChildResource
kustoPoolDatabasePrincipalAssignments
kustoPoolDatabases
kustoPoolDataConnections
kustoPoolPrincipalAssignments
kustoPools
libraries
library
operations
privateEndpointConnections
privateEndpointConnectionsPrivateLinkHub
privateLinkHubPrivateLinkResources
privateLinkHubs
privateLinkResources
restorableDroppedSqlPools
sparkConfiguration
sparkConfigurations
sqlPoolBlobAuditingPolicies
sqlPoolColumns
sqlPoolConnectionPolicies
sqlPoolDataWarehouseUserActivities
sqlPoolGeoBackupPolicies
sqlPoolMaintenanceWindowOptions
sqlPoolMaintenanceWindows
sqlPoolMetadataSyncConfigs
sqlPoolOperationResults
sqlPoolOperations
sqlPoolRecommendedSensitivityLabels
sqlPoolReplicationLinks
sqlPoolRestorePoints
sqlPools
sqlPoolSchemas
sqlPoolSecurityAlertPolicies
sqlPoolSensitivityLabels
sqlPoolTableColumns
sqlPoolTables
sqlPoolTransparentDataEncryptions
sqlPoolUsages
sqlPoolVulnerabilityAssessmentRuleBaselines
sqlPoolVulnerabilityAssessments
sqlPoolVulnerabilityAssessmentScans
sqlPoolWorkloadClassifier
sqlPoolWorkloadGroup
subscriptionId
workspaceAadAdmins
workspaceManagedIdentitySqlControlSettings
workspaceManagedSqlServerBlobAuditingPolicies
workspaceManagedSqlServerEncryptionProtector
workspaceManagedSqlServerExtendedBlobAuditingPolicies
workspaceManagedSqlServerRecoverableSqlPools
workspaceManagedSqlServerSecurityAlertPolicy
workspaceManagedSqlServerUsages
workspaceManagedSqlServerVulnerabilityAssessments
workspaces
workspaceSqlAadAdmins

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

SynapseManagementClient(TokenCredential, string, SynapseManagementClientOptionalParams)

Initializes a new instance of the SynapseManagementClient class.

new SynapseManagementClient(credentials: TokenCredential, subscriptionId: string, options?: SynapseManagementClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The ID of the target subscription.

options
SynapseManagementClientOptionalParams

The parameter options

Property Details

$host 

$host: string

Property Value

string

azureADOnlyAuthentications 

azureADOnlyAuthentications: AzureADOnlyAuthentications

Property Value

AzureADOnlyAuthentications

bigDataPools 

bigDataPools: BigDataPools

Property Value

BigDataPools

dataMaskingPolicies 

dataMaskingPolicies: DataMaskingPolicies

Property Value

DataMaskingPolicies

dataMaskingRules 

dataMaskingRules: DataMaskingRules

Property Value

DataMaskingRules

extendedSqlPoolBlobAuditingPolicies 

extendedSqlPoolBlobAuditingPolicies: ExtendedSqlPoolBlobAuditingPolicies

Property Value

ExtendedSqlPoolBlobAuditingPolicies

integrationRuntimeAuthKeysOperations 

integrationRuntimeAuthKeysOperations: IntegrationRuntimeAuthKeysOperations

Property Value

IntegrationRuntimeAuthKeysOperations

integrationRuntimeConnectionInfos 

integrationRuntimeConnectionInfos: IntegrationRuntimeConnectionInfos

Property Value

IntegrationRuntimeConnectionInfos

integrationRuntimeCredentials 

integrationRuntimeCredentials: IntegrationRuntimeCredentials

Property Value

IntegrationRuntimeCredentials

integrationRuntimeMonitoringDataOperations 

integrationRuntimeMonitoringDataOperations: IntegrationRuntimeMonitoringDataOperations

Property Value

IntegrationRuntimeMonitoringDataOperations

integrationRuntimeNodeIpAddressOperations 

integrationRuntimeNodeIpAddressOperations: IntegrationRuntimeNodeIpAddressOperations

Property Value

IntegrationRuntimeNodeIpAddressOperations

integrationRuntimeNodes 

integrationRuntimeNodes: IntegrationRuntimeNodes

Property Value

IntegrationRuntimeNodes

integrationRuntimeObjectMetadata 

integrationRuntimeObjectMetadata: IntegrationRuntimeObjectMetadata

Property Value

IntegrationRuntimeObjectMetadata

integrationRuntimes 

integrationRuntimes: IntegrationRuntimes

Property Value

IntegrationRuntimes

integrationRuntimeStatusOperations 

integrationRuntimeStatusOperations: IntegrationRuntimeStatusOperations

Property Value

IntegrationRuntimeStatusOperations

ipFirewallRules 

ipFirewallRules: IpFirewallRules

Property Value

IpFirewallRules

keys 

keys: Keys

Property Value

Keys

kustoOperations 

kustoOperations: KustoOperations

Property Value

KustoOperations

kustoPoolAttachedDatabaseConfigurations 

kustoPoolAttachedDatabaseConfigurations: KustoPoolAttachedDatabaseConfigurations

Property Value

KustoPoolAttachedDatabaseConfigurations

kustoPoolChildResource 

kustoPoolChildResource: KustoPoolChildResource

Property Value

KustoPoolChildResource

kustoPoolDatabasePrincipalAssignments 

kustoPoolDatabasePrincipalAssignments: KustoPoolDatabasePrincipalAssignments

Property Value

KustoPoolDatabasePrincipalAssignments

kustoPoolDatabases 

kustoPoolDatabases: KustoPoolDatabases

Property Value

KustoPoolDatabases

kustoPoolDataConnections 

kustoPoolDataConnections: KustoPoolDataConnections

Property Value

KustoPoolDataConnections

kustoPoolPrincipalAssignments 

kustoPoolPrincipalAssignments: KustoPoolPrincipalAssignments

Property Value

KustoPoolPrincipalAssignments

kustoPools 

kustoPools: KustoPools

Property Value

KustoPools

libraries 

libraries: Libraries

Property Value

Libraries

library 

library: Library

Property Value

Library

operations 

operations: Operations

Property Value

Operations

privateEndpointConnections 

privateEndpointConnections: PrivateEndpointConnections

Property Value

PrivateEndpointConnections

privateEndpointConnectionsPrivateLinkHub 

privateEndpointConnectionsPrivateLinkHub: PrivateEndpointConnectionsPrivateLinkHub

Property Value

PrivateEndpointConnectionsPrivateLinkHub

privateLinkHubPrivateLinkResources 

privateLinkHubPrivateLinkResources: PrivateLinkHubPrivateLinkResources

Property Value

PrivateLinkHubPrivateLinkResources

privateLinkHubs 

privateLinkHubs: PrivateLinkHubs

Property Value

PrivateLinkHubs

privateLinkResources 

privateLinkResources: PrivateLinkResources

Property Value

PrivateLinkResources

restorableDroppedSqlPools 

restorableDroppedSqlPools: RestorableDroppedSqlPools

Property Value

RestorableDroppedSqlPools

sparkConfiguration 

sparkConfiguration: SparkConfiguration

Property Value

SparkConfiguration

sparkConfigurations 

sparkConfigurations: SparkConfigurations

Property Value

SparkConfigurations

sqlPoolBlobAuditingPolicies 

sqlPoolBlobAuditingPolicies: SqlPoolBlobAuditingPolicies

Property Value

SqlPoolBlobAuditingPolicies

sqlPoolColumns 

sqlPoolColumns: SqlPoolColumns

Property Value

SqlPoolColumns

sqlPoolConnectionPolicies 

sqlPoolConnectionPolicies: SqlPoolConnectionPolicies

Property Value

SqlPoolConnectionPolicies

sqlPoolDataWarehouseUserActivities 

sqlPoolDataWarehouseUserActivities: SqlPoolDataWarehouseUserActivities

Property Value

SqlPoolDataWarehouseUserActivities

sqlPoolGeoBackupPolicies 

sqlPoolGeoBackupPolicies: SqlPoolGeoBackupPolicies

Property Value

SqlPoolGeoBackupPolicies

sqlPoolMaintenanceWindowOptions 

sqlPoolMaintenanceWindowOptions: SqlPoolMaintenanceWindowOptions

Property Value

SqlPoolMaintenanceWindowOptions

sqlPoolMaintenanceWindows 

sqlPoolMaintenanceWindows: SqlPoolMaintenanceWindows

Property Value

SqlPoolMaintenanceWindows

sqlPoolMetadataSyncConfigs 

sqlPoolMetadataSyncConfigs: SqlPoolMetadataSyncConfigs

Property Value

SqlPoolMetadataSyncConfigs

sqlPoolOperationResults 

sqlPoolOperationResults: SqlPoolOperationResults

Property Value

SqlPoolOperationResults

sqlPoolOperations 

sqlPoolOperations: SqlPoolOperations

Property Value

SqlPoolOperations

sqlPoolRecommendedSensitivityLabels 

sqlPoolRecommendedSensitivityLabels: SqlPoolRecommendedSensitivityLabels

Property Value

SqlPoolRecommendedSensitivityLabels 
sqlPoolReplicationLinks: SqlPoolReplicationLinks

Property Value

SqlPoolReplicationLinks

sqlPoolRestorePoints 

sqlPoolRestorePoints: SqlPoolRestorePoints

Property Value

SqlPoolRestorePoints

sqlPools 

sqlPools: SqlPools

Property Value

SqlPools

sqlPoolSchemas 

sqlPoolSchemas: SqlPoolSchemas

Property Value

SqlPoolSchemas

sqlPoolSecurityAlertPolicies 

sqlPoolSecurityAlertPolicies: SqlPoolSecurityAlertPolicies

Property Value

SqlPoolSecurityAlertPolicies

sqlPoolSensitivityLabels 

sqlPoolSensitivityLabels: SqlPoolSensitivityLabels

Property Value

SqlPoolSensitivityLabels

sqlPoolTableColumns 

sqlPoolTableColumns: SqlPoolTableColumns

Property Value

SqlPoolTableColumns

sqlPoolTables 

sqlPoolTables: SqlPoolTables

Property Value

SqlPoolTables

sqlPoolTransparentDataEncryptions 

sqlPoolTransparentDataEncryptions: SqlPoolTransparentDataEncryptions

Property Value

SqlPoolTransparentDataEncryptions

sqlPoolUsages 

sqlPoolUsages: SqlPoolUsages

Property Value

SqlPoolUsages

sqlPoolVulnerabilityAssessmentRuleBaselines 

sqlPoolVulnerabilityAssessmentRuleBaselines: SqlPoolVulnerabilityAssessmentRuleBaselines

Property Value

SqlPoolVulnerabilityAssessmentRuleBaselines

sqlPoolVulnerabilityAssessments 

sqlPoolVulnerabilityAssessments: SqlPoolVulnerabilityAssessments

Property Value

SqlPoolVulnerabilityAssessments

sqlPoolVulnerabilityAssessmentScans 

sqlPoolVulnerabilityAssessmentScans: SqlPoolVulnerabilityAssessmentScans

Property Value

SqlPoolVulnerabilityAssessmentScans

sqlPoolWorkloadClassifier 

sqlPoolWorkloadClassifier: SqlPoolWorkloadClassifier

Property Value

SqlPoolWorkloadClassifier

sqlPoolWorkloadGroup 

sqlPoolWorkloadGroup: SqlPoolWorkloadGroup

Property Value

SqlPoolWorkloadGroup

subscriptionId 

subscriptionId: string

Property Value

string

workspaceAadAdmins 

workspaceAadAdmins: WorkspaceAadAdmins

Property Value

WorkspaceAadAdmins

workspaceManagedIdentitySqlControlSettings 

workspaceManagedIdentitySqlControlSettings: WorkspaceManagedIdentitySqlControlSettings

Property Value

WorkspaceManagedIdentitySqlControlSettings

workspaceManagedSqlServerBlobAuditingPolicies 

workspaceManagedSqlServerBlobAuditingPolicies: WorkspaceManagedSqlServerBlobAuditingPolicies

Property Value

WorkspaceManagedSqlServerBlobAuditingPolicies

workspaceManagedSqlServerEncryptionProtector 

workspaceManagedSqlServerEncryptionProtector: WorkspaceManagedSqlServerEncryptionProtector

Property Value

WorkspaceManagedSqlServerEncryptionProtector

workspaceManagedSqlServerExtendedBlobAuditingPolicies 

workspaceManagedSqlServerExtendedBlobAuditingPolicies: WorkspaceManagedSqlServerExtendedBlobAuditingPolicies

Property Value

WorkspaceManagedSqlServerExtendedBlobAuditingPolicies

workspaceManagedSqlServerRecoverableSqlPools 

workspaceManagedSqlServerRecoverableSqlPools: WorkspaceManagedSqlServerRecoverableSqlPools

Property Value

WorkspaceManagedSqlServerRecoverableSqlPools

workspaceManagedSqlServerSecurityAlertPolicy 

workspaceManagedSqlServerSecurityAlertPolicy: WorkspaceManagedSqlServerSecurityAlertPolicy

Property Value

WorkspaceManagedSqlServerSecurityAlertPolicy

workspaceManagedSqlServerUsages 

workspaceManagedSqlServerUsages: WorkspaceManagedSqlServerUsages

Property Value

WorkspaceManagedSqlServerUsages

workspaceManagedSqlServerVulnerabilityAssessments 

workspaceManagedSqlServerVulnerabilityAssessments: WorkspaceManagedSqlServerVulnerabilityAssessments

Property Value

WorkspaceManagedSqlServerVulnerabilityAssessments

workspaces 

workspaces: Workspaces

Property Value

Workspaces

workspaceSqlAadAdmins 

workspaceSqlAadAdmins: WorkspaceSqlAadAdmins

Property Value

WorkspaceSqlAadAdmins

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

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